eraseActuals
Catégorie | Soumission de données |
Description | Efface les données numériques dans les périodes temporelles et les comptes indiqués d’une version des chiffres réels. |
Autorisations obligatoires pour pouvoir être appelées | Effacer les données |
Paramètres requis sur demande | Données d'identification, supprimerOptions |
Cette méthode va effacer les valeurs numériques d’une version des chiffres réels pour tous les niveaux du 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). Les fractionnements de compte qui deviennent vides à la suite du traitement d'effacement des chiffres réels seront supprimés. Une subdivision vide est une subdivision qui ne contient aucune donnée, formule ou note de cellule. Si l’effacement des chiffres réels entraîne la suppression des dernières données d’une subdivision, cette subdivision sera supprimée. Cette API laissera les subdivisions inchangées si elles étaient vides avant l'appel de l'API.
Format de demande
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"/> <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 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>
é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 à utiliser lors de l'effacement des chiffres réels. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
actualsVersionName | N | Obligatoire lorsqu'il existe plusieurs versions de chiffres réels. Si cette instance contient uniquement le produit Planning,EraseActuals va effacer les données de la seule version des chiffres réels. | Chiffres réels |
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 des chiffres réels. 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.
Pour l'API v15+, 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 des chiffres réels. 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.
Pour l'API v15+, 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 définie à "vrai", alorsEraseActuals va effacer toutes les notes de cellule dans la version, le type de compte et l'intervalle de temps sélectionnés, qu'il efface également ou non les données de la cellule. Si "faux, aucune note de cellule ne sera supprimée. | vrai |
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. | |||