ES
Español
English
Português
    Editar valores en campos adicionales tipo lista, árbol y selección múltiple

    Detalles de la Petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/additionalsfields/values/{fieldValueId}
    • Tipo: PUT
    • 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.
    • {fieldValueId}: ID del valor del campo adicional (lista, árbol o selección múltiple) que se desea editar.
    • Uri: Endpoint específico para la petición.


    ⚐ EJEMPLO URL:

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


    Paso Previo: Obtener el Id del Valor a Editar

    Antes de editar un valor, consulta el listado de valores del campo para identificar el id del valor que se desea modificar:

    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 (lista, árbol o selección múltiple)
    type Número Tipo de campo (7 para lista, árbol y selección múltiple)
    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 {fieldValueId} en la URL de edición.



    Parámetros de la Petición

    Nombre Tipo de dato Obligatorio Descripción
    Value Texto Sí Nuevo texto/nombre que reemplazará al valor actual

    Cuerpo de la petición

    {
      "Value": "Bogotá"
    }
    

    ⚐ Nota: >

    • La edición solo actualiza el texto/nombre del valor (Value). El ParentId, el RestrictLevel y el Status del valor no se modifican mediante este endpoint.
    • No se permite actualizar un valor con un nombre que ya existe en ese mismo campo.



    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 FailureUpdateFieldValue
    400 Bad Request InvalidAdditionalFieldValue (el fieldValueId no existe)