BMAPI GET api/v1/domains/(k1Chave)/categories

De MSTECH wiki
Ir para: navegação, pesquisa

BlueMonitorAPI > Domains Categories

Request

Parâmetros

Nome Descrição Tipo
k1Chave Chave k1 da Máquina String
categorieSuperiorId Id da categoria superior (opcional) Int

Corpo

Não há informação no corpo

Exemplo

http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/domains/2BD9FBE573/categories

Response

Http Status Code

Código Nome Descrição
200 OK
412 PreConditionFailed Chave k1 não informada
404 NotFound Chave k1 não encontrada ou Categoria não encontrada ou nenhuma categoria cadastrada
500 InternalServerError Erro inesperado

Corpo

Nome Descrição Tipo
Name Nome da Categoria String
CategorieId Id da Categoria Int
AdministrativeUniId Id da Unidade Administrativa Guid
AdministrativeUnitTypeId Id do Tipo de Unidade Administrativa Guid

Exemplo

[
   {
       "Name": "FDE - SAI",
       "CategorieId": 5,
       "AdministrativeUnitId": null,
       "AdministrativeUnitTypeId": null
   }
]