exportShees
Catégorie | Metadata retrieval |
Description | Renvoie la liste complète de toutes les feuilles définies pour l’instance donnée. Cela inclut les feuilles "incomplètes" ainsi que les feuilles affectées à des utilisateurs. |
Autorisations obligatoires pour pouvoir être appelées | imp (importer des données) ou Mod (créer, modifier et supprimer des feuilles) |
Paramètres requis sur demande | Identifiants |
La demande de cette méthode contient uniquement un marqueur d’identification pour désigner et autoriser l’utilisateur qui est auteur de l’appel. Une fois vérifiée, la méthode renvoie un document XML décrivant l’ensemble de toutes les feuilles trouvées dans l’instance de l’utilisateur.
Format de demande
<?xml version='1.0' encoding='UTF-8'?> <call method="exportSheets" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
élément de données d'identification | |||
Nom du marqueur | données d'identification | ||
Description | Tous les appels d’API doivent contenir un élément d’identification unique pour identifier 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 dans l’ordre pour l’API. appel pour 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 (en utilisant le séparateur des milliers, les noms de mois et le 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) | |||
Format de réponse
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <sheets> <modeled-sheet id="1" name="Personnel" prefix="Personnel" description="Personnel Sheet" /> <modeled-sheet id="2" name="Crossover Personnel" prefix="Crossovers" description="Personnel Sheet" /> <modeled-sheet id="3" name="Sales" prefix="Sales" description="Sales Sheet" /> ... <standard-sheet id="6" name="Model Summary" prefix="" description="Configurable Model Summary Sheet" /> <standard-sheet id="8" name="Expenses" prefix="" description="" /> <standard-sheet id="9" name="Balance" prefix="" description="" /> <standard-sheet id="10" name="Assumptions" prefix="" description="" /> ... <cube-sheet id="17" name="Expense Cube" prefix="ExpenseCube" description="" /> <cube-sheet id="19" name="Sale Cube" prefix="SalesCube" description="" /> </sheets> </output> </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 | Vrai ou faux, 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 |
obsolète | N | S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée par Adaptive Planning . Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent. | faux |
Contenu de l'élément | |||
Un seul élément de message facultatif et un seul élément de sortie obligatoire. | |||
élément de sortie | |||
Nom du marqueur | sortie | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
(aucun) | |||
Contenu de l'élément | |||
Un seul élément de feuilles cubes obligatoire. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi. | |||
élément de feuilles | |||
Nom du marqueur | feuille | ||
Description | Conteneur pour un ou plusieurs éléments de feuille standard, de feuille modélisée et de feuille cube. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
(aucun) | |||
Contenu de l'élément | |||
Un ou plusieurs éléments de feuille standard, de feuille modélisée et de feuille cube. | |||
élément de feuille standard | |||
Nom du marqueur | standard-sheet | ||
Description | Représente une seule feuille standard retournée en réponse à un appel d’API exportShees. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
identifiant | Y | Le numéro d’identifiant de système interne pour la feuille. Cela peut être utilisé pour désigner des feuilles dans d’autres appels d’API, tels que exportSheetDefinition. | 123 |
préfixe | Y | Préfixe de la feuille. Pour les feuilles standard, cette valeur est toujours vide. D’autres types de feuilles ont des valeurs non vides pour cet attribut. | |
nom | Y | Le nom de la feuille. | Modes d'agrégat |
description | N | Description textuelle de la feuille, le cas échéant. | Voici les modes d'agrégat... |
Contenu de l'élément | |||
(aucun) | |||
élément de feuille modélisée | |||
Nom du marqueur | modeled-sheet | ||
Description | Représente une feuille modélisée unique retournée en réponse à un appel d’API exportShees. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
identifiant | Y | Le numéro d’identifiant de système interne pour la feuille. Cela peut être utilisé pour désigner des feuilles dans d’autres appels d’API, tels que exportSheetDef inition. | 234 |
préfixe (API v38 et ci-dessous)
code (API v39+) | Y | API v38 : préfixe de la feuille.
API v39 : le code de la feuille. | Amortissement |
nom | Y | Le nom de la feuille. | Modèle immobilisable |
description | N | Description textuelle de la feuille, le cas échéant. | Ceci est le modèle immobilisable... |
Contenu de l'élément | |||
(aucun) | |||
élément de feuille cube | |||
Nom du marqueur | feuille cube | ||
Description | Représente une seule feuille cube retournée en réponse à un appel d'API exportShees. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
identifiant | Le numéro d’identifiant de système interne pour la feuille. Cela peut être utilisé pour désigner des feuilles dans d’autres appels d’API, tels que exportSheetDefinition. | 34 | |
préfixe | Préfixe de la feuille. | ExpenseCube | |
nom | Le nom de la feuille. | Cube de frais | |
description | Description textuelle de la feuille, le cas échéant. | ||
Contenu de l'élément |
(aucun) |