Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Valeurs d'attribut

Valeurs d'attribut

Version : v1

VERB(S) HTTP pris en charge

Verbe HTTP
Description
POST
Supprimer toutes les valeurs d'attribut existantes.

POST :

Demande :
/removeAttributeValues
Le nom d'attribut donné et la liste des codes de valeur d'attribut suppriment ses valeurs d'attribut.
Exemple d'URI de demande :
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
Exemple d'en-tête de demande :
Autorisation : base
Type de contenu : application/json
Exemple de corps de demande
Exemple de demande 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"
      ]
   }
]
Paramètres des données utiles
Nom
Description
Obligatoire
attributeName
Nom de l'attribut.
O
attributeValueCodes
Liste de tous les codes de valeur d'attribut à supprimer.
O
Paramètre de chemin
Nom
Description
Obligatoire
tenant
Environnement client sur lequel opérer les opérations. par exemple globalales
O
Paramètres de requête
Nom
Description
Obligatoire
Par défaut
doValidateOnly
Traiter la demande en mode Valider, ce qui signifie que les modifications ne sont pas conservées.
N
false
showWarnings
Liste des avertissements derrière une valeur de dimension ignorée/omise de la suppression.
N
false
Exemple de réponse :
200 OK
Réponse réussie.
{
"total": 5
}
Réponse réussie avec avertissements.
{
   "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 Demande incorrecte
La demande n'a pas pu être comprise par le serveur.
401 Non autorisé
L'utilisateur n'est pas autorisé.
403 interdit
L'utilisateur ne dispose pas des autorisations requises.
500 Erreur interne du serveur
Erreur interne du serveur.