PT
Español
English
Português
    Removendo valores em campos adicionais como Lista, Árvore e Seleção Múltipla

    Detalhes da petição

    • URL Base: {host}/ASMSAPI/
    • URI: /api/v9/additionalsfields/values/{fieldValueId}
    • Cara: DELETE
    • Cabeçalhos necessários:

    • content-type: application/json
    • X-Authorization: Bearer {token}

    Descrição do URL

    • {host}: Ele representa o domínio do ambiente no qual a API está localizada.
    • ASMSAPI/: Prefixo de API fixo.
    • {fieldValueId}: ID do valor do campo adicional (Lista, Árvore ou Seleção Múltipla) que você deseja excluir.
    • URI: Ponto de extremidade específico para a solicitação.


    ⚐ URL DE EXEMPLO:

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


    Passo Anterior: Faça o ID do valor a ser excluído

    Antes de excluir um valor, consulte a lista de valores no campo para identificar o id do valor que você deseja deletar:

    Endpoint da consulta:

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

    Parâmetros de consulta:

    Nome Tipo de dado Descrição
    ID do campo Número ID de campo adicional (Lista, Árvore ou Múltiplas Seleções)
    tipo Número Tipo de campo (7 para lista, árvore e multi-seleção)
    Datatype Número Tipo de Dado (0 padrão)

    Resposta de exemplo:

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

    ⚐ Nota: >

    • O campo id na resposta está aquele que deve ser usado como {fieldValueId} na URL de remoção.


    Parâmetros da Petição

    Esta solicitação não recebe parâmetros nem corpo; todas as informações necessárias viajam no {fieldValueId} da URL.

    ⚐ Nota: >

    • Excluir um valor do tipo árvore que tenha valores filhos associados não é permitido; os filhos devem ser deletados primeiro.
    • Quando você exclui um valor filho que era o único em seu tier, o valor pai automaticamente reverte para o restrictLevel: true, sendo novamente marcado como o último nível disponível.


    Responder

    Sucesso (Status 200)

    {
        "result": true
    }
    

    Parâmetros de resposta

    Nome Tipo de dado Descrição
    resultado Booleano Indica se a operação foi bem-sucedida


    Mensagens de erro

    Código Status HTTP Mensagem de erro
    401 Desautorizado Você não tem permissão para visualizar este diretório ou página
    400 Solicitação incorreta FailureDeleteFieldValue
    400 Solicitação incorreta InvalidAdditionalFieldValue (o fieldValueId não existe)
    400 Solicitação incorreta FieldValueHasChildren (valor possui valores filhos e não pode ser excluído)