Detalhes da petição
- URL Base: {host}/ASMSAPI/
- URI:
/api/v9/additionalsfields/{fieldId}/values - Cara:POSTAR
-
Cabeçalhos necessários:
content-type: application/jsonX-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.
- {fieldId}: ID do campo adicional de tipo árvore onde o valor será adicionado.
- URI: Ponto de extremidade específico para a solicitação.
⚐ URL DE EXEMPLO:
https://{host}/ASMSAPI/api/v9/additionalsfields/1787/values
Etapa anterior: Obter valores parentais disponíveis
Antes de adicionar um valor filho, verifique os valores pais disponíveis para associar o novo valor a ele:
Endpoint da consulta:
GET /ASMSAPI/api/v9/additionalsfields/{fieldId}/type/7/values?dataType=0
Parâmetros de consulta:
| Nome | Tipo de dado | Descrição |
|---|---|---|
| ID do campo | Número | ID adicional de campo do tipo de árvore |
| tipo | Número | Tipo de campo (7 para árvore) |
| Datatype | Número | Tipo de Dado (0 padrão) |
Resposta de exemplo:
[
{
"catalogId": 0,
"description": null,
"fieldId": 1787,
"hasChild": false,
"id": 2950,
"key": null,
"name": "API",
"order": 0,
"parentId": null,
"restrictLevel": false,
"status": 0
}
]
⚐ Nota: >
- O campo
idna resposta está aquele que deve ser usado comoParentIdAo adicionar um novo valor.
Parâmetros da Petição
| Nome | Tipo de dado | Obrigatório | Descrição |
|---|---|---|---|
| Valor | Texto | Sim | Nome do valor a ser adicionado |
| Identificação dos pais | Número | Não | ID do valor pai (obtido a partir do endpoint da consulta anterior) |
Corpo da petição
{
"Value": "Colombia",
"ParentId": 2950
}
⚐ Nota: >
- Se você não incluir
ParentId, o valor será somado como um valor raiz sem um pai.
Responder
Sucesso (Status 200)
{
"result": true
}
Parâmetros de resposta
| Nome | Tipo de dado | Descrição |
|---|---|---|
| resultado | Booleano | Indica se a operação foi bem-sucedida |
Mensagens de erro
| Código | Status HTTP | Mensagem de erro |
|---|---|---|
| 401 | Desautorizado | Você não tem permissão para visualizar este diretório ou página |
| 400 | Solicitação incorreta | FailureAddValueToField |