ES
Español
English
Português
    Eliminar 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: DELETE
    • 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 eliminar.
    • 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 Eliminar

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

    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": 2940,
            "restrictLevel": true,
            "status": 0
        }
    ]
    

    ⚐ Nota: >

    • El campo id en la respuesta es el que se debe usar como {fieldValueId} en la URL de eliminación.



    Parámetros de la Petición

    Esta petición no recibe parámetros ni cuerpo (body); toda la información necesaria viaja en el {fieldValueId} de la URL.

    ⚐ Nota: >

    • No se permite eliminar un valor tipo árbol que tenga valores hijos asociados; primero deben eliminarse los hijos.
    • Al eliminar un valor hijo que era el único de su nivel, el valor padre recupera automáticamente el estado restrictLevel: true, quedando nuevamente marcado como el último nivel disponible.



    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 FailureDeleteFieldValue
    400 Bad Request InvalidAdditionalFieldValue (el fieldValueId no existe)
    400 Bad Request FieldValueHasChildren (el valor tiene valores hijos y no puede eliminarse)