Mudanças entre as edições de "BMAPI GET api/v1/ImageProtection/(k4Chave)"
De MSTECH wiki
(Criou página com 'BlueMonitorAPI > Devices Image Protection == Request == === Parâmetros === {| class="wikitable" |- ! Nome ! Descrição ! Tip...') |
|||
| Linha 1: | Linha 1: | ||
[[BlueMonitorAPI]] > [[BlueMonitorAPI#Device Image Protection|Devices Image Protection]] | [[BlueMonitorAPI]] > [[BlueMonitorAPI#Device Image Protection|Devices Image Protection]] | ||
| + | |||
| + | == StatusImagem (Situações possíveis) == | ||
| + | |||
| + | 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 == | ||
Edição das 11h07min de 16 de novembro de 2017
BlueMonitorAPI > Devices Image Protection
Índice
StatusImagem (Situações possíveis)
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
Parâmetros
| Nome | Descrição | Tipo |
|---|---|---|
| k4Chave | Código k4 de um dispositivo | String |
Header
| Nome | Descrição | Tipo |
|---|---|---|
| Content-Type | application/json | String |
| Authorization | Basic Authentication | Auth |
| k1 | K1 Chave | String |
Corpo
Não há informação no corpo
Exemplo
http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/ImageProtection/885246744077074624
Response
Http Status Code
| Código | Nome | Descrição |
|---|---|---|
| 200 | OK | |
| 500 | InternalServerError | Erro inesperado |
Corpo
| Nome | Descrição | Tipo |
|---|---|---|
| K4Chave | Chave do dispositivo (máquina) | String |
| StatusImagem | Situação da imagem naquele dispositivo. | String |
| KpiPossuiUpdrive | Retorna se um dispositivo possui updrive instalado, para controle no blueMonitor | Bool |
| KpiSituacao | Mostra situação do registro (1 = ativo; 2 = inativo; 3 = excluído) | Byte |
Exemplo
{
"K4Chave": "885246744077074624",
"StatusImagem": "Protected",
"KpiPossuiUpdrive": true,
"KpiSituacao": 2
}