PT
Español
English
Português
Gerenciamento de categorias
Lista de categorias
Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: /api/v9/item/{itemType}/services/{serviceId}/categories?dataType={dataType}&parentId= {parentId}
- Tipo: GET
-
Títulos obrigatórios:
- tipo de conteúdo: application/json
- Autorização X: Portador {token}
Descrição do URL
- {host}: Ele representa o domínio do ambiente no qual a API está localizada.
- ASMSAPI/: Prefixo de API fixo.
- URI: Ponto de extremidade específico para a solicitação.
⚐ URL DE EXEMPLO:
https://{host}/ASMSAPI/api/v9/item/{itemType}/services/{serviceId}/categories?dataType={dataType}&parentId= {parentId}
Parâmetros
| Nome | Tipo de dado | Obrigatório | Descrição |
|---|---|---|---|
| tipo de item | Texto | Sim | Identificador de tipo de item |
| ID do serviço | Texto | Sim | Identificador de serviço |
| Datatype | Texto | Não | Tipo de dados a serem listados - Todos = 0, - Criança = 1,- Pai = 2 Se não for enviado, os pais serão listados por padrão. |
| identificação dos pais | Número | Não | ID pai. |
Corpo da petição
N/A
Exemplos de URI:
- api/v9/item/incidents/services/2418/categories
- api/v9/item/incidents/services/2418/categories?dataType=all
- api/v9/item/incidents/services/2418/categories?dataType=parent
- api/v9/item/incidents/services/2418/categories?dataType=child&parentId=2
Responder
**Listado de todos**
{
"content": [
{
"childrenCount": 3,
"hasChild": true,
"hierarchy": "Aranda Asset Management Server.Aranda Asset Management Server", "hint": null,
"id": 2,
"imageIndex": 0,
"name": "Aranda Asset Management Server",
"parentId": null
},
{
"childrenCount": 0,
"hasChild": false,
"hierarchy": "Aranda Asset Management Server.remote setup",
"hint": null,
"id": 24,
"imageIndex": 0,
"name": "remote setup",
"parentId": 2
}
],
"totalItems": 2
}
***Listado de hijos:***
{
"content": [
{
"childrenCount": 0,
"hasChild": false,
"hierarchy": "Aranda Asset Management Server.remote setup", "hint": null,
"id": 24,
"imageIndex": 0,
"name": "remote setup",
"parentId": 2
},
{
"childrenCount": 0,
"hasChild": false,
"hierarchy": "Aranda Asset Management ServerAranda Asset Management Server.dghfghfdh",
"hint": null,
"id": 5561,
"imageIndex": 0,
"name": "dghfghfdh",
"parentId": 2
},
{
"childrenCount": 0,
"hasChild": false,
"hierarchy": "Aranda Asset Management ServerAranda Asset Management Server.bbbbb", "hint": null,
"id": 6616,
"imageIndex": 0,
"name": "bbbbb",
"parentId": 2
}
],
"totalItems": 3
}
Lista de pais:
{
"content": [
{
"childrenCount": 3,
"hasChild": true,
"hierarchy": "Aranda Asset Management Server.Aranda Asset Management Server", "hint": null,
"id": 2,
"imageIndex": 0,
"name": "Aranda Asset Management Server",
"parentId": null
},
{
"childrenCount": 0,
"hasChild": false,
"hierarchy": "Aranda DBImport.Aranda DBImport",
"hint": null,
"id": 130,
"imageIndex": 0,
"name": "Aranda DBImport1",
"parentId": null
},
{
"childrenCount": 0,
"hasChild": false,
"hierarchy": "Aranda 360 - Incidente.Aranda 360 - Incidente", "hint": null,
"id": 2338,
"imageIndex": 0,
"name": "Aranda 360 - Incidente",
"parentId": null
}
],
"totalItems": 3
}
Parâmetros de resposta
| Nome | Tipo de dado | Descrição |
|---|---|---|
| conteúdo | Lista | Lista de objetos encontrados |
| totalItems | Número | Número total de registros encontrados |
Mensagens de erro
| Código | Status HTTP | Mensagem de erro |
|---|---|---|
| 400 | Solicitação BadRequest | É nulo\r\nNome do parâmetro: ItemType |
| 400 | Solicitação BadRequest | É nulo\r\nNome do parâmetro: parentId |
| 400 | Solicitação BadRequest | É nulo\r\nNome do parâmetro: serviceId |
| 500 | Erro de servidor interno | FailureGetCategoriesByService |