Detalhes da petição
- URL Base: {host}/ASMSAPI/
- URI:
/api/v9/company/additionalfields
- Cara: POSTAR
-
Títulos obrigatórios:
content-type: application/json
X-Authorization: Bearer {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/company/additionalfield
Parâmetros
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
Id | Número | Não | Identificador da empresa, enviado caso você precise de valores de campo adicionais de uma empresa. |
tipo de item | Texto | Sim | Tipo de caso. Valores possíveis: 1. Incidente 2. Problema 3. Substituição 4. Requisito de serviço 13. Libertação |
tipo de console | Texto | Sim | Tipo de console |
ID do modelo | Número | Sim | Identificador do modelo |
Identificação do estado | Número | Sim | ID do estado |
ID da categoria | Número | Não | Identificador de categoria, pelo qual filtrar |
asdkWeb | Booleano | Sim | Fonte da Web do ASDK |
identificação dos pais | Número | Não | Indica qual pasta o serviço contém |
ID do projeto | Número | Não | ID do projeto, pelo qual filtrar |
ID do serviço | Número | Não | Identificador de serviço, pelo qual filtrar |
Corpo da petição
- Quando se trata de criação de caso:
{
"asdkWeb": true,
"categoryId": 520,
"itemType": 4,
"modelId": 31,
"stateId": 25,
"consoleType": "specialist"
}
- Quando são necessários dados adicionais de um caso:
{
"asdkWeb": true,
"id": 3018,
"itemType": 4,
"modelId": 31,
"stateId": 25,
"categoryId": 521,
"consoleType": "specialist"
}
responder
{
"content": [
{
"boolValue": null,
"catalogId": null,
"dataSourceId": null,
"dateValue": null,
"description": "[ES] Campo que contiene el id compuesto del caso en V8",
"enable": false,
"fieldId": 802,
"fieldType": 1,
"fieldTypeName": "ShortText",
"floatValue": null,
"identifier": "casov8",
"inputStream": null,
"intValue": null,
"itemId": null,
"mandatory": false,
"name": "[ES] N° Caso en V8",
"order": 1,
"projectId": null,
"stringValue": null,
"type": null,
"url": null,
"visible": true
},
{
"boolValue": null,
"catalogId": null,
"dataSourceId": null,
"dateValue": null,
"description": "[ES] Tiempo de desarrollo del reporte",
"enable": true,
"fieldId": 834,
"fieldType": 14,
"fieldTypeName": "Time",
"floatValue": null,
"identifier": "Tiempo de desarrollo del reporte",
"inputStream": null,
"intValue": null,
"itemId": null,
"mandatory": false,
"name": "[ES] Tiempo de desarrollo del reporte",
"order": 2,
"projectId": null,
"stringValue": null,
"type": null,
"url": null,
"visible": true
}
],
"totalItems": 2
}
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
totalItems | Número | Total de objetos encontrados na pesquisa |
Página total | Número | Total de objetos por página |
conteúdo | Lista | Lista de itens |
Conteúdo
Nome | Tipo de dado | Descrição |
---|---|---|
boolValue | Booleano | Valor booleano do campo adicional |
catalogId | Número | Valor adicional do catálogo de campos |
dateValue | Data | Valor de data do campo adicional |
ID do campo | Número | Identificador de campo adicional |
tipo de campo | Número | Tipo de campo |
valor flutuante | Número | Valor decimal do campo adicional |
identificador | Texto | Identificador de campo adicional |
Fluxo de entrada | Riacho | Valor de byte do arquivo para o campo adicional |
intValue | Número | Valor numérico do campo adicional |
stringValue | Texto | Valor de texto do campo adicional |
obrigatório | Booleano | Se o campo adicional é obrigatório ou não |
Descrição | Texto | Descrição do Curso |
Nome | Texto | Nome do campo |
ordem | Número | Ordem de campo |
dataSourceId | Número | ID da seção |
habilitar | Booleano | Determine se está ou não habilitado |
nome_do_campo | Texto | Descrição do tipo de campo |
hasDependencies | Booleano | Determina se o campo adicional tem dependências |
Comprimento | Número | Máximo de caracteres permitidos para um texto curto |
Nível restrito | Booleano | Validar o último nível |
ID do item | Número | Identi |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
400 | Solicitação BadRequest | Nome do parâmetro: ItemType |
400 | Solicitação BadRequest | Nome do parâmetro: ConsoleType |
400 | Solicitação BadRequest | InvalidStateId |
400 | Solicitação BadRequest | InvalidItemType |
400 | Solicitação BadRequest | RequestNeedsSomeArguments |
500 | Erro de servidor interno | FailureGetAdditionalFields |