Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2024-08-16
eraseData

eraseData

Prise en charge dans API v24 et supérieure.
Catégorie
Soumission de données
Description
Efface les données de plan ou de montants réels dans les périodes spécifiées pour un compte avec des filtres facultatifs pour les périmètres et les comptes.
Autorisations requises pour appeler
Effacer les données
Paramètres obligatoires à la demande
Identifiants, Options d'effacement
Efface les valeurs numériques d'une version de plan ou de montants réels pour l'ensemble de comptes spécifié pour une période donnée. Elle n'efface aucune formule (telle que les formules partagées, les formules de cellule, les formules de compte). Elle supprime les subdivisions de compte qui deviennent vides à la suite du processus d'effacement. Une subdivision vide est une subdivision qui ne contient ni donnée, ni formule, ni note de cellule. Si l'effacement entraîne la suppression des dernières données d'une subdivision, cette subdivision sera supprimée. Cette API laisse les subdivisions inchangées si elles étaient vides avant l'appel de l'API.
La méthode eraseData offre les mêmes fonctionnalités que la méthode eraseActuals, mais elle inclut également la possibilité d'effacer les données du plan avec un contrôle supplémentaire sur les combinaisons compte/plan spécifiques constituant des cibles. Les notes de cellule correspondant aux critères sont également supprimées.
L'autorisation Fonctionnalités d'import
Effacer les données
 est une autorisation de super utilisateur qui permet d'effacer les données de montants réels ou de plan pour l'ensemble d'Adaptive Planning, y compris dans les périmètres verrouillés. Effacer les données remplace les règles d'accès et les restrictions de responsabilité de périmètre. Vous pouvez uniquement supprimer les données des comptes calculés avec remplacement par saisie de données.
Cette API valide la strate de temps sur les comptes sélectionnés.

Suppression des comptes d'agrégat

L'API Effacer les données n'efface pas les données des comptes d'agrégat. Incluez chaque compte individuellement dans votre demande.

Périmètres d'effacement

Si vous transmettez un périmètre parent dans votre demande, l'API eraseData efface uniquement les données du périmètre parent, et non des périmètres enfants. Vous devez inclure chaque périmètre individuellement dans la demande API.

Format de demande

Les demandes refusent les marqueurs non reconnus. Les marqueurs permettent une mise en correspondance non sensible avec la casse. Exemple : <accounts>, <Comptes> et <ACCOUNTS> sont acceptables pour l'élément Comptes.

Effacer les montants réels pour tous les périmètres de la version de montants réels par défaut

Pour effacer les valeurs numériques et les nouvelle subdivisions vides des périodes comprises entre le début et la fin de tous les comptes du Grand livre pour tous les périmètres de la version des montants réels par défaut :

<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseActuals" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US"/>
<eraseOptions actualsVersionName="Actuals" accountType="GL" start="01/2013" end="03/2013" includeCellNotes="false" />

</call>
Pour effacer les valeurs numériques et les notes de cellule d'une seule feuille cube pour tous les périmètres d'une version de montants réels spécifique entre le début et la fin indiqués : 

<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseActuals" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password"/>
<eraseOptions actualsVersionName="Actuals" accountType="CUBE" cubeSheetName="Sales Cube" start="01/2013" end="03/2013" includeCellNotes="true" />
</call>

Effacer les données de montants réels avec des filtres pour les comptes d'un périmètre spécifique

Dans cet exemple, les données de montants réels dans la version de montants réels
ActualsSubVersion2013
 pour les comptes personnalisés
WAT_Input_Custom
 et
WAT_Test_Custom
 au niveau
QA
 sera supprimée.

<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US" />
<eraseOptions actualsVersionName="ActualsSubVersion2013" accountType="CUSTOM" start="01/2010" end="11/2010" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="WAT_Input_Custom"/>
    <Account code="WAT_Test_Custom"/>
  </Accounts>
  <Levels>
    <Level name="QA"/>
  </Levels>
</filters>
</eraseOptions>
</call>

Effacer les données du plan avec un filtre à supprimer de comptes personnalisés spécifiques

Dans cet exemple, les données du plan dans la version du plan
clone2013Budget
 pour les comptes personnalisés
SUM_TEXT
 et
LAST_NB
 sera supprimée.

<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/>
<eraseOptions planVersionName="clone2013budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="SUM_TEXT"/>
    <Account code="LAST_NB"/>
  </Accounts>
</filters>
</eraseOptions>
</call>

Effacer les données du plan avec des filtres à supprimer de comptes personnalisés dans des périmètres spécifiques

Dans cet exemple, les données du plan dans la version du plan
clone2013Budget
 pour les comptes personnalisés
WA_SUM
 et
SUM_SUM
 aux périmètres
Development
 et
Hosting
 sera supprimée.

<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/>
<eraseOptions planVersionName="clone2013Budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="WA_SUM"/>
    <Account code="SUM_SUM"/>
  </Accounts>
  <Levels>
    <Level name="Development"/>
    <Level name="Hosting"/>
  </Levels>
</filters>
</eraseOptions>
</call>

Effacer les données du plan avec des filtres à supprimer depuis un compte cube spécifique dans un périmètre spécifique

Dans cet exemple, les données du plan dans la version du plan
10YearBudget
 pour les comptes cubes
ExpenseCube.Units
 dans le périmètre
WorldWide Sales
 sera supprimée.

<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US" />
<eraseOptions planVersionName="10YearBudget" accountType="CUBE" cubeSheetName="Expense Cube" start="01/2010" end="12/2017" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="ExpenseCube.Units" />
  </Accounts>
  <Levels>
    <Level name="WorldWide Sales" />
  </Levels>
</filters>
</eraseOptions>
</call>

élément identifiants
Nom du marqueur
identifiants
Description
Tous les appels d'API doivent contenir un seull'élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
se connecter
O
Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.
sampleuser@company.com
mot de passe
O
Mot de passe de l'utilisateur appelant la méthode API.
my_password
paramètres régionaux
N
Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de période et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.
fr_FR
instanceCode
N
Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de :
Adaptive Planning
, cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.
MYINSTANCE1
Contenu de l'élément
(aucun)
élément eraseOptions
Nom du marqueur
eraseOptions
Description
Indique les options utilisées lors de l'effacement des montants réels ou des données du plan.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
actualsVersionName
N
Obligatoire pour effacer les données de montants réels. Indique le nom de la version de montants réels dans laquelle effacer les données.
N'efface aucune formule (telle que les formules partagées, les formules de cellule, les formules de compte).
ActualsSubVersion2013
planVersionName
N
Obligatoire pour effacer les données du plan. Indique le nom de la version du plan dont vous souhaitez effacer les données.
N'efface aucune formule (telle que les formules partagées, les formules de cellule, les formules de compte).
clone2013Budget
accountType
O
Indique si le type de compte est Grand livre ("GL), personnalisé ("Custom") ou feuille cube ("CUBE").
GL
cubeSheetName
N
Obligatoire siaccountType="CUBE". Indique le nom de la feuille cube.
Cube des ventes
début
O
Indique le code de la période de début de la plage de temps. Le code doit faire référence à une période dans la strate de temps du compte.
Si vous indiquez une feuille cube, le code doit faire référence à une période dans la strate de temps de la feuille cube.
Si vous indiquez un type de compte GL ou personnalisé, le code doit se référer à la strate de temps par défaut.
La période indiquée doit correspondre à la strate de temps du compte. Par exemple, si le compte a une strate de temps de type Trimestres qui commence en janvier, vous ne pouvez pas sélectionner février comme début.
01/2013
fin
O
Indique le code de la période de fin de la plage de temps. Le code doit faire référence à une période dans la strate de temps du compte.
Si vous indiquez une feuille cube, le code doit faire référence à une période dans la strate de temps de la feuille cube.
Si vous indiquez un type de compte GL ou personnalisé, le code doit se référer à la strate de temps par défaut.
La période indiquée doit correspondre à la strate de temps du compte. Par exemple, si le compte a une strate de temps de type Trimestres qui commence en janvier, vous ne pouvez pas sélectionner février comme fin.
03/2013
includeCellNotes
O
Si la valeur est "vrai", eraseData efface toutes les notes de cellule dans la version, le type de compte et la plage de temps sélectionnés (ainsi que les combinaisons de périmètres de compte correspondant aux filtres, si elles ont été spécifiées), que les données de la cellule. Si "faux", aucune note de cellule ne sera supprimée
vrai
displayNameEnabled
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
displayNameEnabled=true indique que eraseData doit respecter les propriétés du nom d'affichage de
code
 lorsque l'option Activer le nom d'affichage est activée pour l'instance.
displayNameEnabled=false indique que l'API eraseData doit continuer à suivre le contrat API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API eraseData ignore les propriétés du nom d'affichage
code
.
La valeur par défaut pour displayNameEnabled est "faux".
Vrai
Contenu de l'élément
(aucun)
élément filtré
Nom du marqueur
Filtres
Description
Indique les filtres de compte et de périmètre à utiliser lors de l'effacement des données.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
Contenu de l'élément
Un élément Comptes, un élément Périmètres ou les deux, un élément Comptes et un élément Périmètres.
Élément Comptes
Nom du marqueur
Comptes
Description
Conteneur d'un ou plusieurs éléments de compte d'un filtre eraseData.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
Contenu de l'élément
Un ou plusieurs éléments de compte.
Élément périmètres
Nom du marqueur
Périmètres
Description
Conteneur d'un ou plusieurs éléments Périmètre d'un filtre eraseData.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
Contenu de l'élément
Un ou plusieurs éléments Périmètre.
Élément de compte
Nom du marqueur
Compte
Description
Compte dont les données seront effacées, tel que spécifié par le code du compte.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
code
O
Indique le code du compte pour lequel les données sont effacées.
WA_SUM
Contenu de l'élément
(aucun)
Élément de périmètre
Nom du marqueur
Périmètre
Description
Périmètre pour les données de compte en cours d'effacement, indiquées par Nom du périmètre.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
nom
O
Indique le nom du périmètre pour les données du compte en cours d'effacement.
Ventes Monde
code
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.
N
Le code du périmètre.
Obligatoire lorsque l'option Activer le nom d'affichage est activée pour une instance.
Ventes Monde
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<messages>
 <message key="erase-actuals-success">Successfully erased actuals data.</message>
 <message key="erase-actuals-facts-deleted">4 facts deleted.</message>
 <message key="erase-actuals-notes-deleted">2 notes deleted.</message>
 <message key="erase-actuals-splits-deleted">1 splits deleted.</message>
</messages>
</response>
élément de réponse
Nom du marqueur
réponse
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
réussite
O
Matriciel ou subordonnévrai oufalse (faux), indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.
vrai
Contenu de l'élément
Un seul facultatifL'élément Messages.
élément de messages
Nom du marqueur
messages
Description
Conteneur pour un ou plusieursÉléments de message.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieursÉléments de message.
élément de message
Nom du marqueur
message
Description
Représente un message que le système renvoie à l'appelant. Les messages sont utilisés pour les messages d'erreur lorsque les demandes n'ont pas abouti, pour les messages d'avertissement lorsque les demandes ont abouti et pour les messages de confirmation lorsque les demandes ont abouti.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
clé
N
Lorsqu'elle est fournie, une clé permet d'identifier un message ou un type de message particulier, utile pour l'enregistrement et la récupération automatisés des erreurs dans les programmes clients. Les clés ne changent pas selon les paramètres régionaux des demandes, même lorsque la langue du message change. Il est également peu probable que les clés changent à l'avenir en raison d'ajustements du libellé ou de la terminologie.
error-invalid-timepan-start
Contenu de l'élément
Texte du message. Ce texte est exprimé dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux soient pris en charge). Le texte peut également contenir des informations variables telles que le nombre de lignes qui ont été traitées ou la colonne ou la valeur particulière qui a généré une erreur.