ES
Español
English
Português
    Agregar Valores en Campos Adicionales tipo Árbol

    Detalles de la Petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/additionalsfields/{fieldId}/values
    • 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.
    • {fieldId}: ID del campo adicional tipo árbol donde se agregará el valor.
    • Uri: Endpoint específico para la petición.


    EJEMPLO URL:

    https://{host}/ASMSAPI/api/v9/additionalsfields/1787/values
    


    Paso Previo: Obtener Valores Padres Disponibles

    Antes de agregar un valor hijo, consulta los valores padres disponibles para asociarle el nuevo valor:

    Endpoint de consulta:

    GET /ASMSAPI/api/v9/additionalsfields/{fieldId}/type/7/values?dataType=0
    

    Parámetros de consulta:

    Nombre Tipo de dato Descripción
    fieldId Número ID del campo adicional tipo árbol
    type Número Tipo de campo (7 para árbol)
    dataType Número Tipo de dato (0 por defecto)

    Respuesta ejemplo:

    [
        {
            "catalogId": 0,
            "description": null,
            "fieldId": 1787,
            "hasChild": false,
            "id": 2950,
            "key": null,
            "name": "API",
            "order": 0,
            "parentId": null,
            "restrictLevel": false,
            "status": 0
        }
    ]
    

    Nota: >

    • El campo id en la respuesta es el que se debe usar como ParentId al agregar un nuevo valor.



    Parámetros de la Petición

    Nombre Tipo de dato Obligatorio Descripción
    Value Texto Nombre del valor a agregar
    ParentId Número No ID del valor padre (obtenido del endpoint de consulta anterior)

    Cuerpo de la petición

    {
      "Value": "Colombia",
      "ParentId": 2950
    }
    

    Nota: >

    • Si no incluyes ParentId, el valor se agregará como un valor raíz sin padre.



    Respuesta

    Éxito (Status 200)

    {
        "result": true
    }
    

    Parámetros Response

    Nombre Tipo de dato Descripción
    result Booleano Indica si la operación tuvo éxito


    Mensajes de Error

    Código Estado HTTP Mensaje de error
    401 Unauthorized You do not have permission to view this directory or page
    400 Bad Request FailureAddValueToField