Mudanças entre as edições de "BMAPI PUT api/v1/ImageProtection"
De MSTECH wiki
(Criou página com 'BlueMonitorAPI > Devices Image Protection == ImageStatus (Situações possíveis das imagens) == Strings que devem ser enviad...') |
(→Exemplo) |
||
| Linha 80: | Linha 80: | ||
=== Exemplo === | === Exemplo === | ||
| + | |||
| + | http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/ImageProtection | ||
{ | { | ||
Edição das 12h07min de 16 de novembro de 2017
BlueMonitorAPI > Devices Image Protection
Índice
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 |
Exemplo
http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/ImageProtection
{
"K4": "885246744077074624"
, "ImageStatus": "UnprotectRequest"
, "HasUpdrive" : "true"
, "Status":2
}
Response
Http Status Code
| Código | Nome | Descrição |
|---|---|---|
| 201 | Created | Registro incluído com sucesso. |
| 404 | NotFound | Chave K4 informada não foi encontrada no servidor. |
| 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 | 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": "885246744077074624",
"ImageStatus": "UnprotectRequest",
"HasUpdrive": true,
"Status": 2
}
