Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Valores do atributo

Valores do atributo

Versão: v1

VERBOS HTTP com suporte

Verbo HTTP
Descrição
POST
Exclua todos os valores de atributo existentes.

PUBLICAR:

Solicitação:
/removeAttributeValues
Um determinado nome de atributo e uma lista de códigos de valor de atributo exclui os valores de atributo.
Exemplo de URI de solicitação:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAttributeValues
ou
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAttributeValues?doValidateOnly=true&&showWarnings=true
Cabeçalho de solicitação de amostra:
Autorização: básica
Content-Type: application/json
Corpo da solicitação de amostra
Exemplo de solicitação POST
 
[
   {
      "attributeName":"tax code",
      "attributeValueCodes":[
         "TT-TRE",
         "test-67"
      ]
   },
   {
      "attributeName":"AP Eligible",
      "attributeValueCodes":[
         "Yes",
         "No"
      ]
   },
   {
      "attributeName":"test-2",
      "attributeValueCodes":[
         "test-22",
         "test-21",
         "test-5"
      ]
   },
   {
      "attributeName":"test-3",
      "attributeValueCodes":[
         "test-22",
         "test-21",
         "test-5"
      ]
   }
]
Parâmetros de carga
Nome
Descrição
Obrigatório
attributeName
Nome do atributo.
S
attributeValueCodes
Lista de todos os códigos de valor de atributo a serem excluídos.
S
Parâmetro de caminho
Nome
Descrição
Obrigatório
tenant
Locatário no qual operar. por exemplo, globosales
S
Parâmetros de consulta
Nome
Descrição
Obrigatório
Valor por padrão
doValidateOnly
Processe a solicitação no modo de validação, o que significa que não há persistência das alterações no banco de dados.
N
false
showWarnings
Lista de Avisos por trás de qualquer valor de dimensão ignorados/pulados para exclusão.
N
false
Exemplo de resposta:
200 OK
Resposta bem-sucedida.
{
"total": 5
}
Resposta bem-sucedida com avisos.
{
   "total":5,
   "warning":{
      "info":"Some attribute values were not deleted.",
      "warnings":[
         {
            "field":"TEST-67",
            "warning":"Attribute value isn't available for deletion."
         },
         {
            "field":"TEST-21",
            "warning":"Attribute value isn't available for deletion."
         },
         {
            "field":"TEST-22",
            "warning":"Attribute value isn't available for deletion."
         },
         {
            "field":"TEST-5",
            "warning":"Attribute value isn't available for deletion."
         }
      ]
   }
}
400 Solicitação inválida
A solicitação não foi compreendida pelo servidor.
401 Não autorizado
O usuário não está autorizado.
403 Forbidden
O usuário não tem permissões suficientes.
500 Erro interno do servidor
Erro interno do servidor.