PT
Español
English
Português
Obtendo valores de um campo de combinação adicional
Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: api/v9/additionalfields/{id}/type/{fieldType}/values?dataType={dataType}&parentId={par entId}&catalogId=
{catalogId}&userId={userId} - 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/additionalfields/{id}/type/{fieldType}/values?dataType={dataType}&parentId={par entId}&catalogId=
{catalogId}&userId={userId}
Parâmetros
| Nome | Tipo de dado | Obrigatório | Descrição |
|---|---|---|---|
| Id | Número | Sim | Identificador do objeto do tipo lista. |
| tipo de campo | Texto | Sim | Tipo de dado- Lista = 3 - Recursivo = 7 - Lista de Catálogos = 11 - Árvore de Catálogo = 12 |
| 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. |
| catalogId | Número | Não | Tipo de catálogo - Lista de Catálogos = 11 - Árvore de Catálogo = 12 |
| ID do usuário | Número | Não | Identifique o cliente do caso |
Corpo da petição
N/A
Exemplos de uri
- api/v9/additionalsfields/5970/type/7/Valores
- api/v9/additionalsfields/5970/type/7/Values?datatype=parent
- additionalsfields/5970/type/7/Values?dataType=child&parentId=2323
- api/v9/additionalsfields/5970/type/7/Values?datatype=all
Responder
Lista apenas de pais:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2323,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre2" },
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2324,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre3" }
],
"totalItems": 2
}
Lista apenas de crianças:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": false, "id": 2328,
"key": null,
"order": 0,
"parentId": 2327, "status": 0,
"value": "hijo311" }
],
"totalItems": 1
}
Lista de todos:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2323,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre2" },
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2324,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre3" },
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2327,
"key": null,
"order": 0,
"parentId": 2324,
"status": 0,
"value": "hijo31"
},
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": false,
"id": 2333,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre1" }
],
"totalItems": 9
}
Parâmetros de resposta:
| Nome | Tipo de dado | Descrição |
|---|---|---|
| Id | Int | ID da tarefa |
| IdByProject | Corda | Identificador de Projeto de Tarefa |
| totalItems | Número | Total de objetos na pesquisa |
| Página total | Número | Total de objetos por página |
| conteúdo | Listas | Lista de Casos de Objetos |
Mensagens de erro
| Código | Status HTTP | Mensagem de erro |
|---|---|---|
| 400 | Solicitação BadRequest | \r\nNome do parâmetro: id |
| 400 | Solicitação BadRequest | \r\nNome do parâmetro: fieldType |
| 400 | Solicitação BadRequest | \r\nNome do parâmetro: catalogId |
| 400 | Solicitação BadRequest | \r\nNome do parâmetro: parentId |
| 400 | Solicitação BadRequest | TipoDeCampoInválido |
| 403 | Proibido | DoNotHavePermissionForThisAction |
| 500 | Erro de servidor interno | FailureGetLookupValues |