eraseData
Pris en charge dans l’API v24 +.
Catégorie | Soumission de données |
Description | Efface les données du plan ou des chiffres réels dans les périodes temporelles précisées pour un compte avec des filtres facultatifs pour les niveaux et les comptes. |
Autorisations obligatoires pour pouvoir être appelées | Effacer les données |
Paramètres requis sur demande | Données d'identification, supprimerOptions |
Efface les valeurs numériques d’une version de plan ou de chiffres réels pour le groupe de comptes précisé pour une plage de temps donnée. Il ne va pas effacer les formules (telles que les formules partagées, les formules de cellule et les formules de compte). Il supprime les fractionnements de compte qui deviennent vides à la suite du processus d’effacement. Une subdivision vide est une subdivision qui ne contient aucune donnée, formule ou 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 capacités que EraseActuals, mais inclut également la possibilité d’effacer les données du plan, avec un contrôle supplémentaire sur des combinaisons de comptes et de plans précises qui sont des cibles. Les notes de cellules correspondant aux critères seront également supprimées.
est une autorisation de superutilisateur qui permet d’effacer les chiffres réels ou les données de plans dans Adaptive Planning, y compris dans les niveaux verrouillés. Effacer les données remplace les règles d’accès et les restrictions de propriété de niveau. Vous pouvez uniquement supprimer les données des comptes calculés avec un remplacement de saisie de données.
Cette API valide la strate de temps sur les comptes choisi.
Effacement des comptes de regroupement
L’API Erase Data n’efface pas les données des comptes de regroupement. Incluez chaque compte individuellement dans votre demande.
Suppression des niveaux
Si vous passez un niveau parent dans votre demande, l’API EraseData efface uniquement les données au niveau parent et non aux niveaux enfants. Vous devez inclure chaque niveau individuellement dans la demande d’API.
Format de demande
Les demandes rejettent les marqueurs non reconnus. Les marqueurs autorisent une correspondance insensible à la casse. Exemple : <accounts>, <Accounts> et <ACCOUNTS> sont acceptables pour l’élément Comptes.
Effacer les chiffres réels pour tous les niveaux de la version des chiffres réels par défaut
Pour effacer les valeurs numériques et les fractionnements nouvellement vides pour les périodes temporelles comprises entre le début et la fin de tous les comptes de grand livre pour tous les niveaux de la version des chiffres 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 niveaux d’une version des chiffres réels spécifiques entre les valeurs de début et de fin indiquées :
<?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 des chiffres réels avec des filtres pour les comptes dans un niveau donné
Pour cet exemple, les données des chiffres réels dans la version des chiffres réels
ActualsSubVersion2013
pour les comptes personnalisés WAT_Input_Custom
Et WAT_Test_Custom
au même niveau QA
sera supprimé.<?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>
Effacez les données d'un plan à l'aide d'un filtre à supprimer de comptes personnalisés précis
Pour 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é.<?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>
Effacez les données du plan avec des filtres à supprimer de comptes personnalisés précis à des niveaux donnés
Pour cet exemple, les données du plan dans la version du plan
clone2013Budget
pour les comptes personnalisés WA_SUM
Et SUM_SUM
à plusieurs niveaux Development
Et Hosting
sera supprimé.<?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 d'un plan avec des filtres à supprimer d'un compte cube précis à un niveau donné
Pour cet exemple, les données du plan dans la version du plan
10YearBudget
pour un compte cube ExpenseCube.Units
au niveau WorldWide Sales
sera supprimé.<?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 de données d'identification | |||
Nom du marqueur | données d'identification | ||
Description | Tous les appels d'API doivent contenir un seulun élément d’identification pour désigner l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
ouvrir une session | Y | Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode. | sampleuser@company.com |
mot de passe | Y | Le mot de passe de l’utilisateur qui invoque la méthode API. | my_password |
paramètres régionaux | N | Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants et pour mettre en forme les numéros et les dates sortants (à l’aide du séparateur des milliers, des noms de période et du format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée. | fr_FR |
instanceCode | N | Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning , cet attribut peut être utilisé pour préciser que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances 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 chiffres 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 des chiffres réels. Indique le nom de la version des chiffres réels à partir de laquelle supprimer les données. N’efface aucune formule (telle que les formules partagées, les formules de cellule et les formules de compte). | ActualsSubVersion2013 |
planVersionName | N | Obligatoire pour effacer les données du plan. Indique le nom de la version du plan à partir de laquelle supprimer les données. N’efface aucune formule (telle que les formules partagées, les formules de cellule et les formules de compte). | clone2013Budget |
accountType | Y | Indique si le type de compte est un grand livre (“GL"), personnalisé (“Custom") ou de feuille cube (“CUBE"). | GL |
cubeSheetName | N | Obligatoire siaccountType="CUBE". Indique le nom de la feuille cube. | Cube de ventes |
début | Y | Indique le code de la période de début de l'intervalle de temps. Le code doit faire référence à une période dans la strate de temps du compte. Si vous précisez une feuille cube, le code doit faire référence à une période de la strate de temps de la feuille cube. Si vous précisez un type de compte GL ou personnalisé, le code doit faire référence à la strate de temps par défaut.
La période temporelle indiquée doit correspondre à la strate de temps du compte. Par exemple, si le compte a une strate de temps de Trimestres commençant en janvier, vous ne pouvez pas sélectionner février comme début. | 01/2013 |
fin | Y | Indique le code de la période de fin de l'intervalle de temps. Le code doit faire référence à une période dans la strate de temps du compte. Si vous précisez une feuille cube, le code doit faire référence à une période de la strate de temps de la feuille cube. Si vous précisez un type de compte GL ou personnalisé, le code doit faire référence à la strate de temps par défaut.
La période temporelle indiquée doit correspondre à la strate de temps du compte. Par exemple, si le compte a une strate de temps de Trimestres commençant en janvier, vous ne pouvez pas sélectionner février comme fin. | 03/2013 |
includeCellNotes | Y | Si la valeur est « true », puis mappage de données efface toutes les notes de cellule de la version, du type de compte et de l’intervalle de temps sélectionnés (et les combinaisons de niveaux de compte correspondant aux filtres, s’ils sont précisés), que cette action efface également les données de l’onglet cellule. Si la valeur est fausse, aucune note de cellule ne sera supprimée | vrai |
displayNameEnabled
Disponible uniquement dans l’API v30+ 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.afficherNameEnabled=false indique que l’API EraseData doit continuer à suivre le contrat de l’API antérieure à la version 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 « false ». | Vrai |
Contenu de l'élément | |||
(aucun) | |||
élément de filtre | |||
Nom du marqueur | Filtres | ||
Description | Indique les filtres de compte et de niveau à 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 Niveaux ou à la fois un élément Comptes et un élément Niveaux. | |||
Élément des comptes | |||
Nom du marqueur | Comptes | ||
Description | Conteneur pour 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 Niveaux | |||
Nom du marqueur | Niveaux | ||
Description | Conteneur pour un ou plusieurs éléments Niveau 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 Niveau. | |||
Élément de compte | |||
Nom du marqueur | Compte | ||
Description | Le compte à partir duquel les données seront effacées, précisé par code de compte. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
code | Y | Indique le code de compte pour le compte des données effacées. | WA_SUM |
Contenu de l'élément | |||
(aucun) | |||
Élément de niveau | |||
Nom du marqueur | Niveau | ||
Description | Le niveau des données du compte à effacer, précisé par le nom Niveau. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
nom | Y | Indique le nom de niveau pour les données du compte à effacer. | Ventes Monde |
code
Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage. | N | Le code du niveau.
Obligatoire lorsque l'option d'activation du nom d'affichage est activée pour une instance. | Ventes - Monde |
Contenu de l'élément | |||
(aucun) | |||
Format de 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 | Y | L'un ou l'autrevrai oufaux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse. | vrai |
Contenu de l'élément | |||
Un seul facultatifélément de messages. | |||
élément de message | |||
Nom du marqueur | messages | ||
Description | Conteneur pour une ou plusieurs valeurséléments de message. | ||
Attributs de l'élément | |||
(aucun) | |||
Contenu de l'élément | |||
Une ou plusieurséléments de message. | |||
élément de message | |||
Nom du marqueur | message | ||
Description | Représente un message renvoyé par le système à l’appelant. Les messages sont utilisés pour envoyer des messages d’erreur lorsque les demandes échouent, pour envoyer des messages d’avertissement lorsque les demandes réussissent et pour les messages de confirmation lorsque les demandes réussissent. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
clé | N | Lorsqu’elle est fournie, une clé est un moyen de repérer un message ou un type de message particulier, ce qui est utile à des fins d’enregistrement automatique d’erreurs et de récupération 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 improbable que les clés changent à l’avenir en raison d’ajustements de formulation ou de changements de terminologie. | début de l’intervalle de temps avec avertissement |
Contenu de l'élément | |||
Le texte du message. Ce texte est dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des renseignements variables, tels que le nombre de rangées traitées, ou la colonne ou la valeur particulière qui a causé une erreur. | |||