Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2024-06-14
eraseActuals

eraseActuals

Catégorie
Soumission de données
Description
Efface les données numériques dans les périodes et les comptes indiqués d'une version de montants réels.
Autorisations requises pour appeler
Effacer les données
Paramètres obligatoires à la demande
Identifiants, Options d'effacement
Cette méthode va effacer les valeurs numériques d'une version de montants réels pour tous les périmètres de 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). Les subdivisions de compte devenus vides à la suite du traitement d'effacement des montants réels seront supprimées. Une subdivision vide est une subdivision qui ne contient ni donnée, ni formule, ni note de cellule. Si l'effacement des montants réels entraîne la suppression des dernières données d'une subdivision, cette subdivision sera supprimée. Les subdivisions de cette API resteront inchangées si elles étaient vides avant l'appel de l'API.

Format de demande

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"/>
   <eraseOptions
     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>
é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 à utiliser lors de l'effacement des montants réels.
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
actualsVersionName
N
Obligatoire lorsqu'il existe plusieurs versions de montants réels. Si cette instance contient uniquement le produit Planning, alorsEffacer les montants réels va effacer les données de la seule version des montants réels.
Montants réels
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 des montants réels. 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.
Pour l'API v15+, la période spécifiée doit s'aligner sur 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 des montants réels. 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.
Pour l'API v15+, la période spécifiée doit s'aligner sur 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 "true ", alorsEffacer les montants réels va effacer toutes les notes de cellule de la version, du type de compte et de la plage de temps sélectionnés, que les données de la cellule soient également effacées ou non. Si ""faux", aucune note de cellule ne sera supprimée.
vrai
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.