exportSheetDefinition

Format de demande de feuille modèle


 <?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <modeled-sheet id="3"/>
   </call>

L'élément d'appel contient un élément identifiants ainsi qu'une feuille modèle unique.

é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)

élément de feuille modèle
Nom du marqueur		modeled-sheet
Description		Identifie une feuille modèle unique demandée via un appel d'API exportSheetdéfinition.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de la feuille.	234
displayNameEnabled Uniquement disponible dans API v31 et supérieure pour les instances qui activent le nom d'affichage.	N	displayNameEnabled=true indique que exportSheetDefinition doit respecter les propriétés du nom d'affichage de code , displayNameType , et description lorsque l'option Activer le nom d'affichage est activée pour l'instance. displayNameEnabled=false indique que l'API exportSheetDefinition doit continuer après le contrat API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API exportSheetdéfinition ignore les propriétés code , displayNameType et description . La valeur par défaut pour displayNameEnabled est "faux".	false
Contenu de l'élément
(aucun)

Format de réponse de la feuille modèle


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <output>
       <modeled-sheet id="11" prefix="Personnel" name="Personnel" description="Personnel Sheet"
                              available-in-actuals="false" allow-splits="true" split-column-title="Is Split Child Row" strataId="51">
           <columns>
               <levels code="Plan" name="Plan" read-only="false" splittable="false" required="true">
                   <level id="1" />
                   <level id="7" />
               </levels>
               <text code="LastName" name="Last Name" read-only="false" splittable="false" required="false" />
               <text code="FirstName" name="First Name" read-only="false" splittable="false" required="false" />
               <text code="ID" name="ID" read-only="false" splittable="false" required="false" />
               <dimension code="JobCode" name="JobCode" read-only="false" splittable="false" required="false" id="9">
                   <value id="19" name="E1" />
                   <value id="20" name="E2" />
                   <value id="21" name="E3" />
               </dimension>
               <text-selector code="BenefitsSelector" name="Benefits" read-only="false" splittable="false" required="true" id="27">
                   <value id="208" name="No" />
                   <value id="209" name="Yes" />
               </text-selector>
               <date code="StartDate" name="Start" read-only="false" splittable="false" required="false" />
               <date code="EndDate" name="End" read-only="false" splittable="false" required="false" />
               <number code="HoursPerWeek" name="Hr/Week" read-only="false" splittable="false" required="false" />
               <text-selector code="per" name="per" read-only="false" splittable="false" required="true" id="28">
                   <value id="210" name="Yr" />
                   <value id="211" name="Hr" />
               </text-selector>
               <initial-balance code="PayRate" name="Pay Rate" read-only="false" splittable="false" required="false" id="143" />
               <display code="PayRate" name="Pay Rate Display Column" read-only="true" splittable="false" required="false" id="7" />
               <level-currency code="" name="Currency" read-only="true" splittable="false" required="false" id="8" />
           </columns>
       </modeled-sheet>
   </output>
</response>

L'élément de feuille modèle contient une ou plusieurs colonnes enfants dans l'ordre défini pour la feuille :

périmètre(s)

dimension

text-Selector

text

nombre

date

solde initial

level-currency

afficher

intervalle de temps

é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 feuille modèle
Nom du marqueur		modeled-sheet
Description		Représente une seule feuille modèle renvoyée en réponse à un appel d'API export-Sheets.
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.	234
préfixe	O	Préfixe de la feuille.	Capital
nom	O	Nom de la feuille.	Modèle d'investissement
disponible dans les montants réels	O	Peut être vraie ou fausse. Indique si la feuille modèle est disponible dans la version de montants réels ou non.	vrai
description	N	La description textuelle de la feuille, le cas échéant.	Il s'agit du modèle d'investissement...
Allow-Splits	O	Vrai signifie que la feuille modèle autorise les subdivisions.	vrai
split-column-title	N	Le titre de la colonne supplémentaire à importer lorsque l'option Autoriser les subdivisions est activée. Utilisez une chaîne localisée si des paramètres régionaux sont indiqués dans la demande. Cet attribut n'est présent que lorsque Allow-Splits est paramétré sur true (vrai) et qu'au moins une colonne peut être subdivisée.	Est une ligne enfant de subdivision
stratId	O	L'identifiant de la strate associé à cette feuille modèle	2
Contenu de l'élément
Un seul élément de colonnes.

élément de colonnes
Nom du marqueur		colonnes
Description		Conteneur pour un ou plusieurs éléments de colonne.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs des éléments suivants, ordonnés de la même manière que dans la feuille : périmètre(s) dimension text-Selector text nombre date solde initial level-currency afficher intervalle de temps

élément périmètres
Nom du marqueur		périmètre(s)
Description		Représente la colonne "périmètre" sur une feuille modèle. Conteneur pour un ou plusieurs éléments de périmètre.
Attributs de l'élément
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	vrai
Contenu de l'élément
Un ou plusieurs éléments de périmètre.

élément de périmètre
Nom du marqueur		level
Description		L'un des périmètres définis pour cette unité légale qui se trouve dans cette feuille (ou sur laquelle cette feuille a été placée). Les métadonnées de périmètre, y compris la structure hiérarchique, peuvent être obtenues en appelant exportLevels.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne du périmètre.	42
Contenu de l'élément
(aucun)

élément de texte
Nom du marqueur		text
Description		Représente une colonne de la feuille qui contient le texte saisi par l'utilisateur.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimension
Description		L'une des dimensions définies pour cette unité légale. Représente une colonne de la feuille contenant la dimension.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
Contenu de l'élément
Un ou plusieurs éléments de valeur, dont chacun a une valeur sélectionnable dans la dimension pour cette feuille. Si une valeur de dimension n'est pas incluse ici, elle ne pourra pas être utilisée sur les lignes de données de cette feuille.

élément de valeur
Nom du marqueur		valeur
Description		L'une des valeurs définies pour cette dimension ou ce sélecteur de texte. Les métadonnées de dimension complètes, y compris leur structure hiérarchique, peuvent être obtenues par un appel distinct à exportDimensions.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne pour la valeur.	42
code Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Le code de la valeur de membre de la dimension, le cas échéant, tel que saisi dans Administration des dimensions.	Mexique
nom	O	Représentation imprimée de la valeur.	Mexique
displayName Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	Nom d'affichage de la valeur du membre, dérivé du type de nom displayName.	Mexique
Contenu de l'élément
(aucun)

élément text-Selector
Nom du marqueur		text-Selector
Description		Liste personnalisée des valeurs définies pour cette feuille. Représente une colonne de sélecteur de texte sur une feuille modèle.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	vrai
id	O	Identifiant numérique interne.	42
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément numérique
Nom du marqueur		nombre
Description		Représente une colonne de la feuille qui contient un nombre saisi par l'utilisateur.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
Contenu de l'élément
(aucun)

élément de date
Nom du marqueur		date
Description		Représente une colonne de la feuille contenant une date saisie par l'utilisateur.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
Contenu de l'élément
(aucun)

élément du solde initial
Nom du marqueur		solde initial
Description		Représente une colonne de la feuille contenant une valeur fournie par l'utilisateur pour le solde initial d'un compte, avec une formule qui détermine le changement mensuel de la valeur du compte.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
id	O	Identifiant numérique interne du compte associé à cette colonne.	42
Contenu de l'élément
(aucun)

élément de devise du périmètre
Nom du marqueur		level-currency
Description		Représente une colonne de la feuille qui affiche le code de la devise associée à chaque ligne. Il s'agit de la devise du périmètre où se trouve la ligne.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne. Pour les éléments de devise de périmètre, cette valeur est toujours vraie.	vrai
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
id	O	Identifiant numérique interne.	42
Contenu de l'élément
(aucun)

élément d'affichage
Nom du marqueur		afficher
Description		Représente une colonne de la feuille qui contient un calcul basé sur une ligne, en lecture seule.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
id	O	Identifiant numérique interne.	42
Contenu de l'élément
(aucun)

élément d'intervalle de temps
Nom du marqueur		intervalle de temps
Description		Au plus un par feuille, cela représente un ensemble de colonnes d'intervalle de temps, qui apparaît à droite de la feuille et peut contenir des données périodiques.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Identifiant symbolique de la colonne, utilisé dans les formules et les références de feuille.	MyColumn
nom	O	Titre affichable de la colonne, tel qu'il apparaît sur la feuille.	Ma colonne
lecture seule	O	Vrai si la colonne est marquée comme étant en lecture seule dans la feuille, et si des valeurs peuvent être saisies dans la colonne.	false
splittable	O	Vrai si les subdivisions de lignes peuvent avoir des valeurs différentes pour cette colonne, Faux si les subdivisions doivent avoir la même valeur que leur parent.	vrai
obligatoire	O	Vrai si cet attribut est un champ obligatoire.	false
id	O	Identifiant numérique interne du compte associé à cet intervalle de temps.	42
Contenu de l'élément
(aucun)

Format de demande de feuille cube


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
     <credentials login="sampleuser@company.com" password="my_pwd"/>
     <cube-sheet id="4"/>
   </call>

L'élément d'appel contient un élément identifiants, ainsi qu'une seule feuille cube.

é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 disposer d'un ensemble d'autorisations contenant les autorisations requises pour la méthode appelée.	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)

élément de feuille cube
Nom du marqueur		feuille cube
Description		Identifie une feuille cube unique demandée via un appel d'API exportSheetdéfinition.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de la feuille.	234
Contenu de l'élément
(aucun)

Format de réponse de la feuille cube


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
    <output>
        <cube-sheet id="24" prefix="SummaryCube" name="Summary Cube" isGlobal="0" description="" strataId="1" horizontalAxis="-3" verticalAxis="-2" maxColumnWidth="0" suppressZeroRows="0" rearrangeGLAndCustomAccounts="0" hideRollupTotals="0">
            <dimensions>
                <dimension id="3" uncategorized="false" rollup="false" name="Company" newValueBehavior="parent" editableOnSheet="false">
                    <value id="35" />
                </dimension>
                <dimension id="4" uncategorized="false" rollup="false" name="CountryRegion" newValueBehavior="parent" editableOnSheet="false">
                    <value id="144" />
                    <value id="133" uncategorized="true" />
                    <value id="133" rollup="true" />
                    <value id="122" rollup="true" />
                    <value id="143" />
                </dimension>
                <levels>
                    <level id="1" />
                    <level id="2" />
                    <level id="8" />
                    <level id="10" />
                    <level id="9" />
                    <level id="5" />
                    <level id="3" />
                    <level id="4" />
                    <level id="11" />
                    <level id="13" />
                    <level id="15" />
                    <level id="16" />
                </levels>
                <accounts>
                    <account id="455" code="" isAssumption="false" />
                    <account id="456" code="" isAssumption="false" />
                    <account id="457" code="SummaryCube.Input" isAssumption="false" />
                    <account id="458" code="SummaryCube.CubeMetric" isAssumption="false" />
                </accounts>
                <time initialBalance="true" visibleTimeStratumCodes="month" />
            </dimensions>
        </cube-sheet>
    </output>
</response>

L'élément de feuille cube contient une dimension unique contenant les éléments suivants dans l'ordre défini pour la feuille :

dimension (un ou plusieurs)

attribut (zéro ou plus)

périmètres (un)

comptes (un)

temps (un)

é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 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.
stratId	O	L'identifiant de la strate de la feuille.	5
horizontalAxis	O	Identifiant de la dimension à afficher par défaut sur l'axe horizontal.	-3
axe vertical	O	Liste des codes de dimension à afficher par défaut sur l'axe vertical.	-2
maxColumnWidth	O	Largeur maximale en pixels pour les colonnes (zéro si non précisé).	20
suppressZeroRows	O	"1" si les lignes nulles sont supprimées, "0" si elles ne le sont pas.	suppressZeroRows="0"
rearrangeGLAndCustomAccounts	O	"1" si la feuille cube doit utiliser le traitement des comptes du Grand livre, "0" si ce n'est pas le cas.	rearrangeGLAndCustomAccounts="0"
hideRollupTotals	O	"1" si les totaux d'agrégat doivent être masqués, "0" si ce n'est pas le cas.	hideRollupTotals="0"
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimensions
Description		Conteneur pour les dimensions de la feuille.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs périmètres, dimensions, comptes, éléments de temps.

élément de dimension
Nom du marqueur		dimension
Description		L'une des dimensions définies pour cette feuille cube.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne de la dimension.	34
sans catégorie	O	Vrai signifie que l'élément sans catégorie de la dimension elle-même (élément racine non catégorisé) est disponible comme sélection dans le cube.	vrai
agrégat	O	Vrai signifie que l'élément d'agrégat de la dimension elle-même (agrégat de tous les éléments) est disponible comme sélection dans le cube.	vrai
nom Disponible dans API v22 et supérieure	O	Nom de cette dimension.	Article de produit
Contenu de l'élément
Un ou plusieurs éléments de valeur indiquant les valeurs de dimension disponibles dans la feuille.

élément d'attribut
Nom du marqueur		attribut
Description		L'un des attributs placés dans cette feuille cube. Les métadonnées d'attribut, y compris leur structure hiérarchique, peuvent être obtenues en appelant les attributs exportAttributes.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne de l'attribut.	34
sans catégorie	O	Vrai signifie que l'élément non catégorisé de l'attribut lui-même (l'élément racine non catégorisé) est disponible comme sélection dans le cube.	vrai
agrégat	O	Vrai signifie que l'élément d'agrégat de l'attribut lui-même (l'agrégat de tous les éléments) est disponible comme sélection dans le cube.	vrai
nom Disponible dans API v22 et supérieure	O	Le nom de l'attribut.	Type de magasin
newValueBehavior	O	Comportement attendu pour la disponibilité de nouvelles valeurs de dimension, disponible ou non disponible ou parent.	parent
Contenu de l'élément
Un ou plusieurs éléments de valeur indiquant quelles valeurs de l'attribut sont disponibles dans la feuille.

élément de valeur
Nom du marqueur		valeur
Description		L'une des valeurs de cette dimension qui a été marquée comme disponible dans la feuille. Le même identifiant de valeur peut s'afficher jusqu'à deux fois : avec et sans sans catégorie défini sur vrai. Les métadonnées de dimension, y compris leur structure hiérarchique, peuvent être obtenues en appelant exportDimensions.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne pour la valeur de dimension.	34
agrégat	N	true (vrai) indique l'agrégat de cette valeur de dimension. Autorisé uniquement si la valeur a des valeurs enfants dans la dimension. Si l'attribut est manquant, la valeur false (faux) est utilisée.	vrai
sans catégorie	N	true indique la valeur sans catégorie de cette valeur de dimension. Autorisé uniquement si la valeur a des valeurs enfants dans la dimension. Si l'attribut est manquant, la valeur false (faux) est utilisée.	vrai
Contenu de l'élément
(aucun)

élément périmètres
Nom du marqueur		périmètre(s)
Description		Conteneur mis en application pour un ou plusieurs éléments de périmètre. Les périmètres individuels sont renvoyés, même s'ils affectent uniquement la visibilité. Les données peuvent être importées dans n'importe quel périmètre.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de périmètre.

élément de périmètre
Nom du marqueur		level
Description		Un périmètre trouvé sur cette feuille, sur laquelle cette feuille apparaît. Les métadonnées de périmètre, y compris leur structure hiérarchique, peuvent être obtenues en appelant exportLevels.
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne du périmètre.	12
Contenu de l'élément
(aucun)

élément Comptes
Nom du marqueur		comptes
Description		Conteneur mis en application pour un ou plusieurs éléments de compte. Les comptes individuels sont renvoyés, même s'ils affectent uniquement la visibilité. Les données peuvent être importées dans n'importe quel compte d'entrée.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de compte. L'ordre et les éléments de compte disponibles sont déterminés par l'option Utiliser le traitement du compte GL dans les propriétés de la feuille cube.

élément de compte
Nom du marqueur		account
Description		L'un des comptes définis pour cette feuille cube. Les métadonnées de compte, y compris sa structure hiérarchique, peuvent être obtenues en appelant exportAccounts.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne du compte.	23
code Disponible dans API v22 et supérieure	N	Le code du compte.	SalesCubeWithAttribute.Unit_Price
Contenu de l'élément
(aucun)

élément de temps
Nom du marqueur		time
Description		Dimension Temps appliquée.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
initialBalance	O	Vrai si la dimension Temps a une valeur de solde initial.	"true"
visibleTimeStratumCodes	N	Liste des codes de strate de temps sélectionnés par dimension de temps.	"trimestre, mois, année"
(aucun)
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimension
Description		L'une des dimensions définies pour cette feuille cube.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant numérique interne de la dimension.	34
sans catégorie	O	Vrai signifie que l'élément sans catégorie de la dimension lui-même est disponible comme sélection dans le cube.	vrai
agrégat	O	Vrai signifie que l'élément d'agrégat de la dimension elle-même (agrégat de tous les éléments) est disponible comme sélection dans le cube.	vrai
nom	O	Nom de cette dimension.	"Article de produit"
newValueBehavior	O	Comportement attendu pour la disponibilité de nouvelles valeurs de dimension, disponible ou non disponible ou parent.	parent
isEditableOnSheet	N	Indicateur qui indique si cette dimension est modifiable dans la feuille.	vrai
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément users
Nom du marqueur		utilisateur(s)
Description		Conteneur des feuilles affectées à des utilisateurs indiquant les propriétés d'accessibilité d'une feuille cube. L'utilisateur appelant a besoin de l'autorisation Modèle pour afficher cet élément et tous ses enfants.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
isExcludedFromWorkflow	O	Indicateur qui indique si une feuille est exclue ou non du workflow.	vrai
Contenu de l'élément
Un ou plusieurs éléments utilisateur.

élément utilisateur
Nom du marqueur		utilisateur
Description		L'un des utilisateurs affectés à la feuille.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Valeur du nombre entier représentant l'identifiant unique d'un utilisateur affecté.	11
Contenu de l'élément
(aucun)

Catégorie	Metadata retrieval
Description	Renvoie la définition de la feuille modèle ou cube donnée.
Autorisations requises pour appeler	impl (importer des données) ou MOD (créer, modifier et supprimer des feuilles)
Paramètres obligatoires à la demande	Des identifiants et des spécifications de la feuille demandée.