Mudanças entre as edições de "BMAPI POST api/v1/ImageProtection"

De MSTECH wiki
Ir para: navegação, pesquisa
(Criou página com 'BlueMonitorAPI > Devices Image Protection == ImageStatus (Situações possíveis) == https://wiki.mstech.com.br/index.php/BMA...')
 
(→‎Exemplo)
 
(5 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
 
[[BlueMonitorAPI]] > [[BlueMonitorAPI#Device Image Protection|Devices Image Protection]]
 
[[BlueMonitorAPI]] > [[BlueMonitorAPI#Device Image Protection|Devices Image Protection]]
  
−
== ImageStatus (Situações possíveis) ==
+
== ImageStatus (Situações possíveis das imagens) ==
  
−
  https://wiki.mstech.com.br/index.php/BMAPI_GET_api/v1/ImageProtection/(k4Chave)#ImageStatus_.28Situa.C3.A7.C3.B5es_poss.C3.ADveis_das_imagens.29
+
  Strings que devem ser enviadas/recebidas como chave da situação (status) atual da imagem.
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Nome
 +
! Descrição
 +
! Tipo
 +
|-
 +
| ProtectRequest
 +
| Solicitação de proteção da imagem.
 +
| String
 +
|-
 +
| Protecting
 +
| Após receber a solicitação de proteção, o status da imagem passa a este status intermediário, mostrando que está em processo de proteção, mas ainda não concluída.
 +
| String
 +
|-
 +
| Protected
 +
| Após a conclusão do pedido de solicitação de proteção da imagem, o status da mesma deve ser alterado para este, mostrando que a imagem agora está protegida.
 +
| String
 +
|-
 +
| UnprotectRequest
 +
| Solicitação de abertura da imagem (desproteger).
 +
| String
 +
|-
 +
| Unprotecting
 +
| Processo intermediário, ainda não concluído, de abertura da imagem.
 +
| String
 +
|-
 +
| Unprotected
 +
| Mostra que a imagem está agora, aberta (desprotegida).
 +
| String
 +
|}
  
 
== Request ==
 
== Request ==
Linha 46: Linha 77:
 
| Retorna se um dispositivo possui updrive instalado, para controle no blueMonitor
 
| Retorna se um dispositivo possui updrive instalado, para controle no blueMonitor
 
| Bool
 
| Bool
 +
|-
 +
| Status
 +
| Mostra situação do registro (1 = ativo; 2 = inativo; 3 = excluído)
 +
| Byte
 
|}
 
|}
 +
 +
=== Exemplo ===
 +
 +
http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/ImageProtection
 +
 +
{
 +
  "K4": "2485382125193"
 +
  , "ImageStatus": "Unprotecting"
 +
  , "HasUpdrive" : "true"
 +
}
  
 
== Response ==
 
== Response ==
Linha 57: Linha 102:
 
! Descrição
 
! Descrição
 
|-
 
|-
−
| 201
+
| 200
−
| Created
+
| OK
−
| Registro incluído com sucesso.
+
| Registro alterado com sucesso.
 
|-
 
|-
 
| 404
 
| 404
 
| NotFound
 
| NotFound
−
| Chave K4 informada não foi encontrada no servidor.
+
| Chave K4 informada não foi encontrada no servidor, OU não foi encontrado um registro para ser atualizado (PUT). Deve ser criado primeiro (POST).
−
|-
+
−
| 409
+
−
| Conflict
+
−
| Chave K4 informada já possui registro de proteção de imagem criado. Usar o comando de atualização (PUT) ao invés de criação (POST).
+
 
|-
 
|-
 
| 412
 
| 412
Linha 102: Linha 143:
 
| Byte
 
| Byte
 
|}
 
|}
 +
 +
=== Exemplo ===
 +
{
 +
  "K4": "2485382125193",
 +
  "ImageStatus": "Unprotecting",
 +
  "HasUpdrive": true,
 +
  "Status": 1
 +
}

Edição atual tal como às 17h56min de 16 de novembro de 2017

BlueMonitorAPI > Devices Image Protection

ImageStatus (Situações possíveis das imagens)

Strings que devem ser enviadas/recebidas como chave da situação (status) atual da imagem.
Nome Descrição Tipo
ProtectRequest Solicitação de proteção da imagem. String
Protecting Após receber a solicitação de proteção, o status da imagem passa a este status intermediário, mostrando que está em processo de proteção, mas ainda não concluída. String
Protected Após a conclusão do pedido de solicitação de proteção da imagem, o status da mesma deve ser alterado para este, mostrando que a imagem agora está protegida. String
UnprotectRequest Solicitação de abertura da imagem (desproteger). String
Unprotecting Processo intermediário, ainda não concluído, de abertura da imagem. String
Unprotected Mostra que a imagem está agora, aberta (desprotegida). String

Request

Header

Nome Descrição Tipo
Content-Type application/json String
Authorization Basic Authentication Auth
k1 K1 Chave (código do domínio, ou da unidade Administrativa) String

Corpo

Nome Descrição Tipo
K4 Chave do dispositivo (máquina) String
ImageStatus Situação da imagem naquele dispositivo. String
HasUpdrive Retorna se um dispositivo possui updrive instalado, para controle no blueMonitor Bool
Status Mostra situação do registro (1 = ativo; 2 = inativo; 3 = excluído) Byte

Exemplo

http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/ImageProtection

{
 "K4": "2485382125193"
 , "ImageStatus": "Unprotecting"
 , "HasUpdrive" : "true"
}

Response

Http Status Code

Código Nome Descrição
200 OK Registro alterado com sucesso.
404 NotFound Chave K4 informada não foi encontrada no servidor, OU não foi encontrado um registro para ser atualizado (PUT). Deve ser criado primeiro (POST).
412 PreconditionFailed Chave K4 deve ser informada no corpo da requisição.
500 InternalServerError Erro inesperado

Corpo

Nome Descrição Tipo
K4 Chave do dispositivo (máquina) String
ImageStatus Situação da imagem naquele dispositivo. String
HasUpdrive Retorna se um dispositivo possui updrive instalado, para controle no blueMonitor Bool
Status Mostra situação do registro (1 = ativo; 2 = inativo; 3 = excluído) Byte

Exemplo

{
  "K4": "2485382125193",
  "ImageStatus": "Unprotecting",
  "HasUpdrive": true,
  "Status": 1
}
Disponível em "http://wiki.mstech.com.br/index.php?title=BMAPI_POST_api/v1/ImageProtection&oldid=7024"