exportDimensionFamilies

Catégorie	Metadata retrieval
Description	Renvoie des métadonnées décrivant les relations entre les ensembles de comptes et les ensembles de dimensions.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
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 un ensemble de familles de dimensions, qui décrivent la façon dont des ensembles de dimensions précis sont associés à des ensembles de comptes donnés. 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 d’une feuille modélisée 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 sur une feuille standard avec des dimensions appartiennent à une famille pour cette feuille, qui contient toutes les dimensions placées sur cette feuille et toutes les dimensions d’organisation.

Les feuilles standard auxquelles aucune dimension n’est associée n’ont pas de famille de dimensions associée.

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 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), et 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 appeler 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)

Format de 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	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. 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
(aucun)
Contenu de l'élément
Un élément de comptes unique. 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 des familles
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 la famille.

élément de famille
Nom du marqueur		famille
Description		Décrit une famille de dimensions unique associée à une seule feuille modélisée ou cube. Une seule famille est également sortie pour toutes les hypothèses et tous les taux de change non modélisés et non cubes. L’identifiant de cette famille de type rattrapage est 0.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	Le nom de la famille de dimensions. La famille comprenant toutes les hypothèses qui ne sont pas des cubes et les comptes de taux de change (qui n’ont pas de dimension) aura le nom « * ». 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élisée utilise le préfixe de la feuille comme nom de famille.	Amortissement
identifiant	Y	L’identifiant de la famille de dimensions, qui est l’identifiant de la feuille utilisée pour décrire cette famille.	3
comptes	Y	L’ensemble des numéros d’identifiant de compte appartenant à cette famille. Les identifiants sont les identifiants de système interne des comptes, visibles dans l’appel d’API exportAccounts. Les identifiants sont séparés par des virgules et peuvent contenir des plages avec un tiret, ce qui indique que tous les identifiants de la plage sont inclus.	734-739,744
dimensions	Y	L'ensemble des numéros d'identifiant de dimension appartenant à cette famille. Les identifiants sont les identifiants de système interne pour les dimensions, visibles dans l’appel d’API exportDimensions. Les identifiants sont séparés par des virgules et peuvent contenir des plages avec un tiret, ce qui indique que tous les identifiants de la plage sont inclus.	9321,9422,9455,9458
Contenu de l'élément
(aucun)