Campos de visualização definidos como dependentes

Detalhes da petição

URL base: {host}/ASMSAPI/
Uri: /api/v9/additionalsfields/dependents/resolve
Tipo: POST
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/additionalsfields/dependents/resolve

Descrição

Esse endpoint permite que você veja quais campos filhos são ativados e quais valores filtrados estão disponíveis quando um usuário seleciona um valor em um campo pai.

Parâmetros do Corpo do Pedido

Nome	Tipo de dado	Obrigatório	Descrição
sourceFieldId	Número	Sim	O ID do campo pai cujas dependências você quer resolver.
selectedValueId	Número	Não	Identificador numérico do valor selecionado no campo pai. Ele tem a maior prioridade quando múltiplos parâmetros de seleção são enviados.
selectedValueKey	Texto	Não	Chave do valor selecionado no campo pai. Isso se aplica apenas a campos do tipo CatalogList. Ele tem segunda prioridade quando múltiplos parâmetros de seleção são enviados.
selectedValueDescription	Texto	Não	Nome ou descrição do valor selecionado no campo pai. Ele tem a menor prioridade quando múltiplos parâmetros de seleção são enviados.

⚐ NOTA: Pelo menos um dos parâmetros selectedValueId, selectedValueKey ou selectedValueDescription É obrigatório. Quando múltiplos parâmetros são enviados simultaneamente, o sistema aplica a seguinte ordem de prioridade: selectedValueId > selectedValueKey > selectedValueDescription.

Corpo da petição

Resolve por selectedValueId:

{
    "sourceFieldId": 543,
    "selectedValueId": 494
}

Resolver por selectedValueKey (campo do tipo CatalogList):

{
    "sourceFieldId": 545,
    "selectedValueKey": "Sede Norte(SN-001)"
}

Resolver por selectedValueDescription:

{
    "sourceFieldId": 543,
    "selectedValueDescription": "Colombia"
}

Responder

Lista de tipos de campo filhos:

{
    "content": [
        {
            "catalogKeyValue": null,
            "editable": true,
            "fieldId": 544,
            "fieldName": "Ciudad",
            "fieldType": "List",
            "inheritValueList": false,
            "isConfigured": true,
            "mandatory": true,
            "values": [
                {
                    "id": 497,
                    "key": null,
                    "name": "Bogota",
                    "order": 0
                },
                {
                    "id": 498,
                    "key": null,
                    "name": "Medellin",
                    "order": 0
                }
            ],
            "visible": true
        }
    ],
    "totalItems": 1
}

Campo filho ShortText com inheritValues:

{
    "content": [
        {
            "catalogKeyValue": "Sede Norte(SN-001)",
            "editable": true,
            "fieldId": 546,
            "fieldName": "Código Postal",
            "fieldType": "ShortText",
            "inheritValueList": true,
            "isConfigured": true,
            "mandatory": false,
            "values": [],
            "visible": true
        }
    ],
    "totalItems": 1
}

Nenhuma dependência configurada para o valor enviado:

{
    "content": [],
    "totalItems": 0
}

Parâmetros de resposta

Nome	Tipo de dado	Descrição
totalItems	Número	Número total de campos filhos que reagem ao valor selecionado no campo pai. Retorno `0` quando não há dependências configuradas para esse valor.
conteúdo	Lista	Lista de campos filhos com seus comportamentos e valores disponíveis.
ID do campo	Número	Identificador do campo filho.
nome_do_campo	Texto	Nome do campo filho.
tipo de campo	Texto	Tipo de dado do campo filho.
visível	Booleano	Indica se o campo filho deve ser exibido quando a dependência é acionada.
Editável	Booleano	Indica se o campo filho é editável quando a dependência é ativada.
obrigatório	Booleano	Indica se o campo filho é necessário quando a dependência é ativada.
isConfigured	Booleano	Indica se a dependência possui as propriedades visível, editável e obrigatória totalmente definidas. Seu valor é `false` quando a dependência foi configurada a partir do console de administrador para campos do tipo CheckBox.
hereValueList	Booleano	Indica se o campo filho tem herança chave ativa. Seu valor é `true` quando o campo filho é digitar ShortText com inheritValues configurados.
catálogoKeyValue	Texto	A chave herdada do valor selecionado no campo pai. Só vem com valor quando `inheritValueList` É `true`. Em outros casos, seu valor é `null`.
Valores	Lista	Lista de valores filtrados disponíveis para o campo filho. Ele fica vazio quando o campo filho é do tipo ShortText com herança, quando filteredValueIds não estão configurados, ou quando o campo pai é tipo CheckBox.
values.id	Número	Identificador do valor filtrado.
values.name	Texto	Nome do valor filtrado.
values.key	Texto	Chave do valor filtrado. Ele só vem com valor para campos do tipo CatalogList. Para campos de tipo Lista, seu valor é `null`.
valores.ordem	Número	Ordem de exibição do valor nos consoles.

Mensagens de erro

Código	Status HTTP	Mensagem de erro
400	Solicitação BadRequest	`sourceFieldId is required`
400	Solicitação BadRequest	`selectedValueId, selectedValueDescription or selectedValueKey is required`
400	Solicitação BadRequest	`Value with description {valor} does not exist in source field`
401	Desautorizado	Token não fornecido ou expirado.