Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Valeurs de dimension

Valeurs de dimension

Version : v1

VERB(S) HTTP pris en charge

Verbe HTTP
Description
POST
Supprimer toutes les valeurs de dimension inutilisées existantes (les valeurs de dimension en cours d'utilisation seront ignorées).

POST :

Demande :
/removeDimensionValues
Le nom de la dimension et la liste des codes de valeur de dimension suppriment ses valeurs de dimension.
Exemple d'URI de demande :
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues
ou
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues?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
 
[
    {
        "dimensionName": "Dim1",
        "dimensionValueCodes": [
            "dimensionValueCode100"
        ]
    },
    {
        "dimensionName": "Dim2",
        "dimensionValueCodes": [
            "dimensionValueCode102",
            "dimensionValueCode103"
        ]
    },
    {
        "dimensionName": "Dim3",
        "dimensionValueCodes": [
            "dimensionValueCode104",
            "dimensionValueCode105",
            "dimensionValueCode106",
            "dimensionValueCode107"
            "dimensionValueCode108",
            "dimensionValueCode109"
        ]
    }
]
Paramètres des données utiles
Nom
Description
Obligatoire
dimensionName
Nom de la dimension.
O
dimensionValueCodes
Liste de tous les codes de valeur de dimension à 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 dimension values were not deleted.",
"warnings": [
{
"field": "TEST-67",
"warning": "Dimension value isn't available for deletion."
},
{
"field": "TEST-5",
"warning": "In-use dimension values cannot be deleted."
}
]
}
}
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.