Périmètres

VERB(S) HTTP pris en charge

POST

Demande :

/removeLevels

Supprime les périmètres pour les codes de périmètre donnés.

Exemple d'URI de demande :

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/removeLevels

ou

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/removeLevels?forceRemove=false&&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

{ "levelCodesToDelete": ["testLevel", "HQ"] }

Paramètres des données utiles

Nom	Description	Obligatoire
levelCodesToDelete	Les codes de périmètre à supprimer sont indiqués.	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
forceRemove	Supprime les comptes en cours d'utilisation lorsque forceRemove=true et ignore les comptes en cours d'utilisation lorsque forceRemove=false La valeur par défaut est toujours forceRemove=false	N
instanceCode	instanceCode à partir de laquelle extraire les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, l'instance par défaut de l'utilisateur est utilisée.	N
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": 1
}

Réponse réussie avec avertissements

{
    "total": 0,
    "warning": {
        "info": "Some levels were not deleted.",
        "warnings": [
            {
                "field": "HQ",
                "warning": "Default Root Plans 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.