exportSheets

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" et les feuilles affectées à des utilisateurs.
Autorisations requises pour appeler	impl (importer des données) ou MOD (créer, modifier et supprimer des feuilles)
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient uniquement un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois vérifiée, la méthode renvoie un document XML décrivant l'ensemble complet 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 identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul é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 dans l'ordre pour l'API appelez pour 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 mois 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)

Format de la 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	O	Vrai ou 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
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est actuellement dépréciée. Adaptive Planning . Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un é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 contient 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, modèle et 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, modèle et cube.

élément de feuille standard
Nom du marqueur		standard-sheet
Description		Représente une seule feuille standard renvoyée en réponse à un appel d'API exportSheets.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de la feuille. Cela peut être utilisé pour identifier des feuilles dans d'autres appels d'API, tels que exportSheetdéfinition.	123
préfixe	O	Préfixe de la feuille. Pour les feuilles standard, ce champ est toujours vide. Les autres types de feuille ont des valeurs non vides pour cet attribut.
nom	O	Nom de la feuille.	Modes d'agrégat
description	N	La 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èle
Nom du marqueur		modeled-sheet
Description		Représente une feuille modèle unique renvoyée en réponse à un appel d'API exportSheets.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de la feuille. Cela peut être utilisé pour identifier des feuilles dans d'autres appels d'API, tels que exportSheetDef-inition.	234
préfixe (API v38 et inférieure) code (API v39 et supérieure)	O	API v38 : préfixe de la feuille. API v39 : code de la feuille.	Capital
nom	O	Nom de la feuille.	Modèle d'investissement
description	N	La description textuelle de la feuille, le cas échéant.	Il s'agit du modèle d'investissement...
Contenu de l'élément
(aucun)

élément de feuille cube
Nom du marqueur		feuille cube
Description		Représente une seule feuille cube renvoyée en réponse à un appel d'API exportSheets.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id		Numéro d'identifiant système interne de la feuille. Cela peut être utilisé pour identifier des feuilles dans d'autres appels d'API, tels que exportSheetdéfinition.	34
préfixe		Préfixe de la feuille.	ExpenseCube
nom		Nom de la feuille.	Cube de frais
description		La description textuelle de la feuille, le cas échéant.

Contenu de l'élément

(aucun)