exportDimensionFamilies

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées décrivant les relations entre les ensembles de comptes et les ensembles de dimensions.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
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 un ensemble de familles de dimensions, qui décrit comment des ensembles spécifiques de dimensions sont associés à des ensembles spécifiques de comptes. Chaque famille se compose d'un ensemble de comptes et d'un ensemble de dimensions, ce qui indique que ces dimensions s'appliquent à ces comptes, contrairement aux autres dimensions. Les comptes et les dimensions peuvent appartenir à plusieurs familles. Les familles sont définies comme suit :

Les comptes sur une feuille modèle appartiennent à une famille pour cette feuille, qui contient toutes les dimensions placées sur cette feuille et toutes les dimensions d'organisation.

Les comptes d'une feuille cube appartiennent à une famille pour cette feuille, qui contient toutes les dimensions placées sur cette feuille et toutes les dimensions d'organisation.

Les comptes des feuilles standard avec dimensions appartiennent à une famille pour cette feuille, qui contient toutes les dimensions placées dans cette feuille ainsi que toutes les dimensions d'organisation.

Les feuilles standard sur lesquelles aucune dimension n'a été placée n'ont pas de famille de dimensions associées.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionFamilies" 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 (toute la piste d'audit ou l'historique des 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>
   <families>
     <family name="Personal" id="381" accounts="734-739, 744" dimensions="9321,9422, 9455, 9458" />
     <family name="Capital" id="382" accounts="853" dimensions="4" />
     <family name="Sales" id="386" accounts="769, 4112" dimensions="" />
     <family name="Balance" id="255" accounts="545, 66" dimensions="6,7" />
   </families>
 </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 officielement dépréciée. 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
(aucun)
Contenu de l'élément
Un seul élément comptes. 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 famille
Nom du marqueur		familles
Description		Conteneur pour un ou plusieurs éléments de famille.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de famille.

élément de famille
Nom du marqueur		famille
Description		Décrit une famille de dimensions uniques associée à une feuille modèle ou cube unique. Une famille unique est également sortie pour toutes les hypothèses et taux de change non modèles et non cubes. L'identifiant de cette famille capture- tout est égal à 0.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Nom de la famille de dimensions. La famille composée de tous les comptes de taux de change et d'hypothèses non cubes (qui n'ont aucune dimension) doit s'appeler '*'. La famille de dimensions d'une feuille standard porte le même nom que la feuille standard, tandis que la famille de dimensions d'une feuille cube ou modèle utilise le préfixe de la feuille comme nom de famille.	Capital
id	O	Identifiant de la famille de dimensions, qui est l'identifiant de la feuille décrite par cette famille.	3
comptes	O	L'ensemble des identifiants de compte appartenant à cette famille. Les identifiants sont les identifiants système internes des comptes, visibles dans l'appel d'API exportAccounts. Les identifiants sont séparés par des virgules et peuvent contenir des fourchettes avec tiret, ce qui indique que tous les identifiants de la fourchette sont inclus.	734-739,744
dimensions	O	L'ensemble des numéros d'identifiant de dimension appartenant à cette famille. Les ID sont les identifiants système internes des dimensions, visibles dans l'appel d'API exportDimensions. Les identifiants sont séparés par des virgules et peuvent contenir des fourchettes avec tiret, ce qui indique que tous les identifiants de la fourchette sont inclus.	9 321, 9 422, 9 455, 9 458
Contenu de l'élément
(aucun)