exportSheetDefinition

Format de demande de feuille modélisée


 <?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 d’identification ainsi qu’une seule feuille modélisée.

é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 (à l’aide du séparateur des milliers, des noms de mois 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 de feuille modélisée
Nom du marqueur		modeled-sheet
Description		Désigne une feuille modélisée unique demandée au moyen d’un appel d’API exportSheetDefinition.
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.	234
displayNameEnabled Disponible uniquement dans l’API v31+ 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 de exportSheetDefinition 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 exportSheetDefinition ignore les propriétés code , displayNameType Et description . La valeur par défaut pour displayNameEnabled est « false ».	faux
Contenu de l'élément
(aucun)

Format de réponse de feuille modélisée


<?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élisée contient un enfant de colonne unique contenant une ou plusieurs des valeurs suivantes dans l’ordre défini pour la feuille :

niveaux

dimension

sélecteur de texte

texte

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	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 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 de Exporter des feuilles.
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.	234
préfixe	Y	Préfixe de la feuille.	Amortissement
nom	Y	Le nom de la feuille.	Modèle immobilisable
disponibles dans les chiffres réels	Y	Peut être vrai ou faux. Indique si la feuille modélisée est disponible ou non dans la version des chiffres réels.	vrai
description	N	Description textuelle de la feuille, le cas échéant.	Ceci est le modèle immobilisable...
autoriser les subdivisions	Y	Vrai signifie que la feuille modélisée autorise les subdivisions.	vrai
split-column-title	N	Le titre de la colonne supplémentaire à importer lorsque l'autorisation de 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 Autoriser les subdivisions est défini à Vrai et au moins une colonne peut être subdivisée.	Ligne enfant de subdivision
strataId	Y	L'identifiant de strate associé à cette feuille modélisée	2
Contenu de l'élément
Un seul élément de colonnes.

élément columns
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, dans l’ordre indiqué sur la feuille : niveaux dimension sélecteur de texte texte nombre date solde initial level-currency afficher intervalle de temps

élément niveaux
Nom du marqueur		niveaux
Description		Représente la colonne "niveau" dans une feuille modélisée. Conteneur pour un ou plusieurs éléments de niveau.
Attributs de l'élément
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	vrai
Contenu de l'élément
Un ou plusieurs éléments de niveau.

élément de niveau
Nom du marqueur		niveau
Description		Un des niveaux définis pour cette société qui se trouve sur cette feuille (ou sur lequel cette feuille a été placée). Les métadonnées de niveau, y compris la structure hiérarchique, peuvent être obtenues par un appel à exportLevels.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne pour le niveau.	42
Contenu de l'élément
(aucun)

élément de texte
Nom du marqueur		texte
Description		Représente une colonne dans la feuille qui contient le texte entré par l'utilisateur.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimension
Description		L’une des dimensions définies pour cette société. Représente une colonne dans la feuille qui contient la dimension.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
Contenu de l'élément
Un ou plusieurs éléments de valeur, chacun d’eux étant une valeur pouvant être sélectionnée valide dans la dimension de cette feuille. Si une valeur de la dimension n'est pas incluse ici, cette valeur ne peut pas être utilisée dans les rangées de données de cette feuille.

élément de valeur
Nom du marqueur		valeur
Description		Une des valeurs définies pour ce sélecteur de dimension ou 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
identifiant	Y	Identifiant numérique interne pour la valeur.	42
code Disponible uniquement dans l’API v30+ 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 qu’il est entré dans l’administration des dimensions.	Mexique
nom	Y	Représentation imprimée de la valeur.	Mexique
displayName Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	Nom d’affichage de la valeur membre, tel que dérivé de displayNameType.	Mexique
Contenu de l'élément
(aucun)

élément de sélecteur de texte
Nom du marqueur		sélecteur de texte
Description		Liste personnalisée de valeurs définies pour cette feuille. Représente une colonne de sélecteur de texte dans une feuille modélisée.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	vrai
identifiant	Y	Identifiant numérique interne.	42
Contenu de l'élément
Un ou plusieurs éléments de valeur.

élément de nombre
Nom du marqueur		nombre
Description		Représente une colonne de la feuille contenant un numéro entré par l’utilisateur.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
Contenu de l'élément
(aucun)

élément de date
Nom du marqueur		date
Description		Représente une colonne de la feuille qui contient une date entrée par l’utilisateur.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
Contenu de l'élément
(aucun)

élément du solde initial
Nom du marqueur		solde initial
Description		Représente une colonne de la feuille qui contient 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	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
identifiant	Y	Identifiant numérique interne du compte associé à cette colonne.	42
Contenu de l'élément
(aucun)

élément de devise du niveau
Nom du marqueur		level-currency
Description		Représente une colonne sur la feuille qui affiche le code de la devise associée à chaque rangée. Il s’agit de la devise du niveau où se trouve la rangée.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne. Pour les éléments de devise du niveau, cette valeur est toujours vraie.	vrai
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
identifiant	Y	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 contenant un calcul en lecture seule fondé sur des rangées.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
identifiant	Y	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 une par feuille, cela représente un ensemble d’intervalles de temps de colonnes, qui apparaissent à droite de la feuille et peuvent contenir des données périodiques.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
code	Y	Un identifiant symbole pour la colonne, utilisé dans les formules et les références de la feuille.	MyColumn
nom	Y	Titre affiché de la colonne, comme on le voit sur la feuille.	Ma colonne
lecture seule	Y	Vrai si la colonne est marquée en lecture seule sur la feuille, faux si des valeurs peuvent être entrées dans la colonne.	faux
splittable	Y	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
requis	Y	Vrai si cet attribut est un champ obligatoire.	faux
identifiant	Y	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 de créances, ainsi qu’une seule feuille cube.

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

élément de feuille cube
Nom du marqueur		feuille cube
Description		Désigne une seule feuille cube demandée au moyen d’un appel d’API exportSheetDefinition.
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.	234
Contenu de l'élément
(aucun)

Format de réponse de 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 un enfant de dimensions uniques qui contient ces éléments dans l’ordre défini pour la feuille :

dimension (une ou plusieurs)

attribut (zéro ou plus)

niveaux (un)

comptes (un)

fois (une)

é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 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.
strataId	Y	L'identifiant de strate de la feuille.	5
horizontalAxis	Y	Identifiant de la dimension qui doit être affichée par défaut sur l'axe horizontal.	-3
verticalAxe	Y	La liste des identifiants de dimension à afficher sur l'axe vertical par défaut.	-2
maxColumnWidth	Y	Largeur maximum en pixels pour les colonnes (zéro si non précisée).	20
suppressZeroRows	Y	"1" si les rangées nulles sont supprimées, "0" si elles ne le sont pas.	suppressZeroRows="0"
rearrangeGLAndCustomAccounts	Y	"1" si la feuille cube doit utiliser Traitement de compte de grand livre général, "0" si elle ne l’est pas.	rearrangeGLAndCustomAccounts="0"
hideRollupTotals	Y	« 1 » si les totaux des agrégats doivent être masqués, « 0 » dans le cas contraire.	hideRollupTotals="0"
Contenu de l'élément
(aucun)

élément de dimensions
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 niveaux, dimensions, comptes ou éléments de temps.

élément de dimension
Nom du marqueur		dimension
Description		Une des dimensions définies pour cette feuille cube.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	L'identifiant numérique interne de la dimension.	34
sans catégorie	Y	Vrai signifie que l’élément sans catégorie de la dimension elle-même (l’élément racine sans catégorie) est disponible en tant que sélection dans le cube.	vrai
regroupement	Y	Vrai signifie que l’élément d’agrégat de la dimension elle-même (l’agrégat de tous les éléments) est disponible en tant que sélection dans le cube.	vrai
nom Disponible dans l'API v22+	Y	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 sur la feuille.

élément d'attribut
Nom du marqueur		attribut
Description		L'un des attributs placés sur cette feuille cube. Les métadonnées d’un attribut, y compris sa structure hiérarchique, peuvent être obtenues par un appel à exportAttributes.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	L'identifiant numérique interne pour l'attribut.	34
sans catégorie	Y	Vrai signifie que l’élément sans catégorie de l’attribut lui-même (l’élément racine sans catégorie) est disponible en tant que sélection dans le cube.	vrai
regroupement	Y	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 en tant que sélection dans le cube.	vrai
nom Disponible dans API v22 +	Y	Le nom de l'attribut.	Type de magasin
newValueBehavior	Y	Comportement attendu pour la disponibilité de la nouvelle valeur de dimension, soit disponible, 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 sur la feuille.

élément de valeur
Nom du marqueur		valeur
Description		Une des valeurs de cette dimension qui a été marquée comme disponible sur la feuille. La même valeur d’identifiant peut s’afficher jusqu’à deux fois : avec et sans la valeur hors catégorie définie à Vrai. Les métadonnées de dimension, y compris sa structure hiérarchique, peuvent être obtenues par un appel à exportDimensions.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne pour la valeur de dimension.	34
regroupement	N	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 Faux est utilisée.	vrai
sans catégorie	N	vrai 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 Faux est utilisée.	vrai
Contenu de l'élément
(aucun)

élément niveaux
Nom du marqueur		niveaux
Description		Conteneur appliqué pour un ou plusieurs éléments de niveau. Les niveaux individuels sont retournés, même s’ils touchent uniquement la visibilité. Les données peuvent être importées dans n'importe quel niveau.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de niveau.

élément de niveau
Nom du marqueur		niveau
Description		Niveau trouvé sur cette feuille, sur lequel cette feuille s'affiche. Les métadonnées de niveau, y compris sa structure hiérarchique, peuvent être obtenues par un appel à exportLevels.
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne pour le niveau.	12
Contenu de l'élément
(aucun)

élément des comptes
Nom du marqueur		comptes
Description		Conteneur appliqué pour un ou plusieurs éléments de compte. Les comptes individuels sont retournés, même s’ils n’affectent que 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. Les éléments de compte disponibles et l’ordre déterminé par l’option Utiliser le traitement de compte GL dans les propriétés de la feuille cube.

élément de compte
Nom du marqueur		compte
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 par un appel à exportAccounts.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Identifiant numérique interne du compte.	23
code Disponible dans l'API v22+	N	Le code de compte pour le compte.	SalesCubeWithAttribute.Unit_Price
Contenu de l'élément
(aucun)

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

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

élément users
Nom du marqueur		utilisateurs
Description		Conteneur pour les feuilles affectées à des utilisateurs indiquant les propriétés d'accessibilité d'une feuille cube. L'utilisateur qui appel doit disposer de l'autorisation de modèle pour afficher cet élément et tous les enfants de cet élément.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
isExcludedFromWorkflow	Y	Indicateur qui indique si une feuille est exclue ou non du flux des travaux.	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
identifiant	Y	Valeur entière indiquant 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élisée ou cube donnée.
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	Des données d’identification et une spécification de la feuille demandée.