Consultar campos configurados como dependientes

Detalles de la petición

URL Base: {host}/ASMSAPI/
Uri: /api/v9/additionalsfields/dependents/resolve
Tipo: POST
Encabezados requeridos:
- content-type: application/json
- X-Authorization: Bearer {token}

Descripción de la URL

{host}: Representa el dominio del ambiente en el que se encuentra la API.
ASMSAPI/: Prefijo fijo de la API.
Uri: Endpoint específico para la petición.

⚐ EJEMPLO URL:

https://{host}/ASMSAPI/api/v9/additionalsfields/dependents/resolve

Descripción

Este endpoint permite consultar qué campos hijo se activan y con qué valores filtrados disponibles cuando un usuario selecciona un valor en un campo padre.

Parámetros del cuerpo de la petición

Nombre	Tipo de dato	Obligatorio	Descripción
sourceFieldId	Número	Sí	Identificador del campo padre cuyas dependencias se desean resolver.
selectedValueId	Número	No	Identificador numérico del valor seleccionado en el campo padre. Tiene la mayor prioridad cuando se envían múltiples parámetros de selección.
selectedValueKey	Texto	No	Clave (key) del valor seleccionado en el campo padre. Solo aplica para campos tipo CatalogList. Tiene segunda prioridad cuando se envían múltiples parámetros de selección.
selectedValueDescription	Texto	No	Nombre o descripción del valor seleccionado en el campo padre. Tiene la menor prioridad cuando se envían múltiples parámetros de selección.

⚐ NOTA: Al menos uno de los parámetros selectedValueId, selectedValueKey o selectedValueDescription es obligatorio. Cuando se envían múltiples parámetros simultáneamente, el sistema aplica el siguiente orden de prioridad: selectedValueId > selectedValueKey > selectedValueDescription.

Cuerpo de la petición

Resolver por selectedValueId:

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

Resolver por selectedValueKey (campo tipo CatalogList):

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

Resolver por selectedValueDescription:

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

Respuesta

Campo hijo tipo List:

{
    "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 hijo tipo ShortText con 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
}

Sin dependencias configuradas para el valor enviado:

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

Parámetros Response

Nombre	Tipo de dato	Descripción
totalItems	Número	Total de campos hijo que reaccionan al valor seleccionado en el campo padre. Retorna `0` cuando no hay dependencias configuradas para ese valor.
content	Lista	Listado de campos hijo con su comportamiento y valores disponibles.
fieldId	Número	Identificador del campo hijo.
fieldName	Texto	Nombre del campo hijo.
fieldType	Texto	Tipo de dato del campo hijo.
visible	Booleano	Indica si el campo hijo debe mostrarse cuando se activa la dependencia.
editable	Booleano	Indica si el campo hijo es editable cuando se activa la dependencia.
mandatory	Booleano	Indica si el campo hijo es obligatorio cuando se activa la dependencia.
isConfigured	Booleano	Indica si la dependencia tiene las propiedades visible, editable y mandatory completamente definidas. Su valor es `false` cuando la dependencia fue configurada desde la consola Administrator para campos tipo CheckBox.
inheritValueList	Booleano	Indica si el campo hijo tiene herencia de clave (key) activa. Su valor es `true` cuando el campo hijo es tipo ShortText con inheritValues configurado.
catalogKeyValue	Texto	Clave heredada del valor seleccionado en el campo padre. Solo viene con valor cuando `inheritValueList` es `true`. En los demás casos su valor es `null`.
values	Lista	Listado de valores filtrados disponibles para el campo hijo. Viene vacío cuando el campo hijo es tipo ShortText con herencia, cuando no se configuraron filteredValueIds o cuando el campo padre es tipo CheckBox.
values.id	Número	Identificador del valor filtrado.
values.name	Texto	Nombre del valor filtrado.
values.key	Texto	Clave del valor filtrado. Solo viene con valor para campos tipo CatalogList. Para campos tipo List su valor es `null`.
values.order	Número	Orden de visualización del valor en las consolas.

Mensajes de error

Código	Estado HTTP	Mensaje de error
400	BadRequest	`sourceFieldId is required`
400	BadRequest	`selectedValueId, selectedValueDescription or selectedValueKey is required`
400	BadRequest	`Value with description {valor} does not exist in source field`
401	Unauthorized	Token no proporcionado o expirado.