exportDimensions
Cette API prend uniquement en charge l'utilisateur Concept : règles d'accès dans API v22 et supérieure.
Catégorie | Metadata retrieval |
Description | Renvoie les métadonnées de la liste complète de toutes les dimensions du système. |
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 l'ensemble des dimensions personnalisées du système, y compris toutes leurs valeurs de membre. Cette méthode ne renvoie aucune des dimensions système obligatoires telles que Version, Temps ou Comptes, chacune d'entre elles étant disponible dans son propre appel d'API de métadonnées. Les valeurs des membres d'une dimension sont renvoyées sous forme d'arbre, les membres parents contenant leurs enfants.
Vous pouvez rechercher des codes de dimension en utilisant
exportDimensions
Demande sans élément dimensionIDs. Une liste de toutes les dimensions et de leurs identifiants s'affichera. Révisez la réponse pour rechercher les identifiants de dimension dont vous avez besoin. Les identifiants de dimension ne sont pas disponibles dans Adaptive Planning
Interface utilisateur web.Format de demande
<?xml version='1.0' encoding='UTF-8'?> <call method="exportDimensions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include versionName="Budget 2004" dimensionIDs="1,2,4,5" dimensionValues="true"/> </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 afin que l'appel d'API s'appelle 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) | |||
inclure l'élément | |||
Nom du marqueur | inclure | ||
Description | Représente un ensemble d'indicateurs indiquant quels aspects des informations des "valeurs de dimension" doivent être inclus ou exclus de la réponse. Cet élément est facultatif : s'il est absent, la valeur par défaut est vide (ou toutes les versions) pour versionName/versionID. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
versionName Mis à jour dans l'API v18 | N | Indique si la réponse doit exclure les valeurs de dimension qui ne sont pas disponibles pour le nom de version demandé. Par défaut, si l'élément ou son attribut n'est pas présent, toutes les dimensions et valeurs sont renvoyées. Si un nom de version est indiqué, les valeurs de dimension qui ne sont pas disponibles pour la version indiquée ne seront pas renvoyées. Si le nom de version indiqué est introuvable, cette API génère une erreur. Si les deux attributs versionName et versionID sont validés, versionID est ignoré. <?xml version='1.0' encodage='UTF-8'?> <réponse réussite="true"> <output> <dimensions> <dimension id="6" name="Department" raccourciName="" autoCreate=" ? 52" name="QA" description = Assurance qualité" raccourciName="" /> <dimensionValue id="53" name="Dev" description="Développement" raccourciName="" durée/dimensionValue> }</dimension> <dimension id="7" name="Études" raccourciName="" autoCreate="0" listDimension="1" FonctionD="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name = "Obtenir un diplôme" description=" Diplôme de diplôme" sectionsName=""> <attributs> <attribute attributeId="21" name="Type d'études" valueId="197" value =="="employés" /> place d'attribut> <dimensionValue > <dimensionValue id="33" name="Matrics" description="Description des diplômes de maîtrise" raccourciName=""> <attributs> <attribut attributeId="21" name="Type d'études" valueId="196" value="Gestion" /> class tests> <dimensionValue> <dimensionValue id="34" name="Phd" description="Fd" name="" /> place d'dimension> entretien de dimension> Reporting> Reporting de la réponse> Lorsque vous indiquez une version, l'appel ne passera que si l'utilisateur y a accès. | Budget 2004 |
versionID Prise en charge dans l'API v17 et mise à jour dans l'API v18 | N | Identique à versionName (ci-dessus), sauf que le numéro d'identification de version est utilisé comme paramètre. Indique si la réponse doit exclure les valeurs de dimension qui ne sont pas disponibles pour la version demandée. Par défaut, si l'élément ou son attribut n'est pas présent, toutes les dimensions et valeurs sont renvoyées. Si un identifiant de version est indiqué, les valeurs de dimension qui ne sont pas disponibles pour la version indiquée ne seront pas renvoyées. Si l'identifiant de version indiqué est introuvable, cette API génère une erreur. Si les deux attributs versionName et versionID sont validés, versionID est ignoré. Lorsque vous indiquez une version, l'appel ne passera que si l'utilisateur y a accès. | 3 |
dimensionIDs Prise en charge dans API v17 et supérieure | N | La liste des identifiants qui apparaîtra dans la réponse API. Cela filtre pour une dimension, mais pas une valeur de dimension. | "1,2,3,14" |
attributs | N | Indique si la réponse doit inclure les attributs de la réponse pour chaque dimension plate. | false |
inaccessibleValues Prise en charge dans API v18 et supérieure | N | Indique si la réponse doit inclure des valeurs inaccessibles à l'utilisateur actuel. La valeur par défaut est false (faux). Seuls les utilisateurs disposant des autorisations "Modélisation" ou "Importer dans tous les périmètres" peuvent définir cette option sur vrai. | 1 |
dimensionValues Prise en charge dans API v22 et supérieure | N | Indique si la réponse doit inclure les valeurs de dimension pour chaque dimension. La valeur par défaut est Vrai. Si la valeur est false (faux), renvoie uniquement les dimensions filtrées, et non les valeurs de dimension. Si dimensionValues ne fait pas partie de l'élément d'inclusion, renvoie toutes les dimensions et leurs valeurs. Si l'élément à inclure ne fait pas partie de la demande, toutes les dimensions et leurs valeurs seront renvoyées. | false |
displayNameEnabled
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | displayNameEnabled=true indique que exportDimensions 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 exportDimensions doit continuer à suivre le contrat API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API exportDimensions ignore les propriétés du nom d'affichage code , displayNameType et description .La valeur par défaut pour displayNameEnabled est "faux". | vrai |
Contenu de l'élément | |||
(aucun) | |||
Format de la réponse
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""/> <dimensionValue id="52" name="QA" description="Quality Assurance" shortName=""/> <dimensionValue id="53" name="Dev" description="Development" shortName=""/> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue> <dimensionValue id="33" name="Masters" description="Masters degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> </attributes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName=""/> </dimension> <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" seqNo="14" property1="Latitude" property2="Longitude"> <dimensionValue id="521" name="United States" description="USA" shortName=""> <dimensionValue id="555" name="Alabama" description="1" shortName=""> <dimensionValue id="579" name="205" description="1" shortName=""> <dimensionValue id="4718" name="35004" description="1" shortName=""> <properties> <property name="Latitude" value="33.606" /> <property name="Longitude" value="-86.502" /> </properties> </dimensionValue> <dimensionValue id="4719" name="35005" description="" shortName=""> <properties> <property name="Latitude" value="33.593" /> <property name="Longitude" value="-86.96" /> </properties> </dimensionValue> <dimensionValue id="5073" name="35006" description="" shortName="" /> <dimensionValue id="5074" name="35007" description="" shortName="" /> </dimensionValue> </dimensionValue> <properties> <property name="Latitude" value="37.0902" /> <property name="Longitude" value="95.7129" /> </properties> </dimensionValue> </dimension> </dimensions> </output> </response>
Les dimensions sont classées par nom.
é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 dimension | |
Nom du marqueur | dimensions |
Description | Conteneur pour un ou plusieurs éléments de dimension. |
Attributs de l'élément | |
(aucun) | |
Contenu de l'élément | |
Un ou plusieurs éléments de dimension. | |
élément de dimension | |||
Nom du marqueur | dimension | ||
Description | Représente une dimension personnalisée unique renvoyée en réponse à un appel d'API exportDimensions. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
id | O | Le numéro d'identification du système interne pour la dimension. Elle peut être utilisée pour identifier les dimensions dans d'autres appels d'API, tels que exportDimensionFamilies. | 16 |
nom | O | Nom de la dimension tel qu'il apparaît sur les rapports et les feuilles. | Customer |
code
Disponible uniquement dans les API v39 et supérieure. | N | Nom de la dimension tel qu'il apparaît sur les rapports et les feuilles. Il s'affichera uniquement avec l'API v39 et supérieure | Customer |
displayNameType
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | Représentation interne du format du nom d'affichage sélectionné pour les valeurs sur les pages Administration des dimensions.
| NOM |
shortName | N | Le nom abrégé de la dimension, le cas échéant, tel que saisi dans Administration des dimensions. | client. |
autoCreate | O | 1 si le champ " L'importation de données crée automatiquement des valeurs de dimension" est défini pour la dimension sélectionnée, sinon 0. | 0 |
listDimension | O | 1 si la dimension sélectionnée est une dimension en liste, 0 sinon. | 1 |
keepSorted | O | 1 si la dimension sélectionnée reste triée, 0 sinon. | 1 |
useOnLevels | O | 1 si la dimension sélectionnée peut être utilisée sur les périmètres, 0 sinon. | 1 |
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future. | |||
description
Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage. | N | La description telle qu'elle a été saisie dans Administration des dimensions. | |
Contenu de l'élément | |||
0 ou plusieurs éléments dimensionValue. Chaque élément dimensionValue inclus représente une valeur de dimension racine dans la dimension, une valeur qui n'a pas de valeur parent. | |||
élément dimensionValue | |||
Nom du marqueur | dimensionValue | ||
Description | Représente une valeur de membre unique d'une dimension personnalisée renvoyée en réponse à un appel d'API exportDimensions. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
id | O | Numéro d'identifiant système interne associé à cette valeur de membre de la dimension. | 34 |
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. | Entreprise A |
nom | O | Libellé de la valeur de membre de la dimension, tel qu'il est affiché sur les rapports et utilisé dans les formules. | Entreprise A |
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. | Entreprise A |
shortName | N | Nom abrégé de la valeur de dimension, le cas échéant, tel que saisi dans Administration des dimensions | A |
description | N | Description de la valeur de dimension, le cas échéant, telle qu'elle est saisie dans Administration des dimensions. | Une société |
Contenu de l'élément | |||
Aucun ou plusieurs éléments dimensionValue facultatifs. Chaque élément dimensionValue inclus représente une "valeur de dimension enfant" de cette valeur de dimension, dont les membres s'agrègent implicitement à cette valeur. Un élément de propriétés facultatif. | |||
élément des propriétés | |||
Nom du marqueur | propriétés | ||
Description | Élément facultatif contenant des éléments de propriété. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
(aucun) | |||
Contenu de l'élément | |||
Jusqu'à cinq éléments de propriété. | |||
élément de propriété | |||
Nom du marqueur | propriété | ||
Description | Permet de spécifier une propriété personnalisée. Les valeurs d'élément de propriété contiennent uniquement des caractères numériques. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
nom | O | Nom de la propriété. | Latitude |
valeur | N | Valeur de la propriété. | 33,6 015 |
Contenu de l'élément | |||
(aucun) | |||
élément attributs | |||
Nom du marqueur | attributs | ||
Description | Conteneur pour un ou plusieurs éléments d'attribut de dimension. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
(aucun) | |||
Contenu de l'élément | |||
Un ou plusieurs éléments d'attribut. | |||
élément d'attribut | |||
Nom du marqueur | attribut | ||
Description | Conteneur pour un élément d'attribut de dimension. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
attributeID | O | Identifiant de l'attribut de dimension généré par le système. | 20 |
nom | O | Le nom de l'attribut de dimension | Type d'études |
valueID | O | Identifiant unique de la valeur d'attribut de dimension générée par le système. | 170 |
valeur
Prise en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est activé. | O | Valeur de l'attribut de dimension. | Tech1 |
valueCode
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d'affichage. Non pris en charge dans l'API v34. | N | Le code de la valeur d'attribut pour cet attribut.
Pour API v32 et API v33, valueCode n'a de sens que lorsque :
| Tech1 |
valueName
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d'affichage. Non pris en charge dans l'API v34. | N | Le nom de la valeur d'attribut pour cet attribut.
Pour API v32 et API v33, valueName n'a de sens que lorsque :
| Tech1 |
valueDisplayName
Uniquement disponible dans API v32 et supérieure pour les instances qui activent le nom d'affichage. | O | Pour l'API v32 et les versions ultérieures, valueDisplayName n'a de sens que lorsque :
| Tech1 |
Contenu de l'élément | |||
(aucun) | |||