exportDimensions
Cette API prend en charge uniquement l’utilisateur Concept : règles d’accès dans l’API v22 et au-delà.
Catégorie | Metadata retrieval |
Description | Renvoie les métadonnées pour la liste complète de toutes les dimensions du système. |
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 l’ensemble des dimensions personnalisées du système, y compris toutes leurs valeurs membres. Cette méthode ne renvoie aucune des dimensions système obligatoires telles que Version, Temps ou Comptes, chacune étant disponible dans son propre appel d’API de métadonnées. Les valeurs de membres d’une dimension sont retournées sous forme d’arborescence, les membres parents contenant leurs enfants.
Vous pouvez rechercher des identifiants de dimension avec
exportDimensions
request sans élément dimensionIDs. Cela produit une liste de toutes les dimensions et de leurs identifiants. Passez en revue la réponse pour trouver les identifiants de dimension dont vous avez besoin. Les identifiants de dimension ne sont pas disponibles à partir de 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 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 afin que l’appel d’API puisse être exécuté 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) | |||
inclure un élément | |||
Nom du marqueur | inclure | ||
Description | Représente un ensemble d'indicateurs indiquant quels aspects 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 la version demandée. La valeur par défaut, si l’élément ou son attribut n’est pas présent, doit renvoyer toutes les dimensions et valeurs. Si un nom de version est indiqué, les valeurs de dimension qui ne sont pas disponibles pour la version indiquée ne seront pas retournées. Si le nom de version indiqué est introuvable, cette API renvoie une erreur. Si à la fois les attributs versionName et versionID sont transmis, l’attribut versionID est ignoré. <?xml version='1.0' encodage='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" raccourciName="" autoCreate=" 0" listDimension="0" joinSorted="0" UseOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engineing" ShortName=""> <dimensionValue id=" 52" name="QA" description="Assurance qualité courte"Name="" Global <dimension id="7" name="Education" courte="" autoCreate="0" listDimension="1" conserveSorted="0" UseOnLevels="0" seqNo="21"> <dimensionValue id="32" nom ="Graduate" description="Graduate" description="Graduate diplôme" ShortName=""> <attributs> <attribute attributeId="21" name="Type d’études" valueId="197" value="actif/certificat) /<attributes> <dimensionValue > <dimensionValue id="33" name="Mauters" description="Degré de maîtrise" raccourciName=""> <attributs> Ctrl. attribut testes> }<dimensionValue> <dimensionValue id="34" name="phd" description="phd" raccourciName="" t/dimension> _dimensions> _output> rangée Quand une version est précisée, l’appel aboutit uniquement si l’utilisateur a accès à la version. | Budget 2004 |
versionID Pris en charge dans l'API v17 + mis à jour dans l'API v18 | N | Identique à versionName (au-dessus), sauf en prenant un numéro d’identifiant de version comme paramètre. Indique si la réponse doit exclure les valeurs de dimension qui ne sont pas disponibles pour la version demandée. La valeur par défaut, si l’élément ou son attribut n’est pas présent, doit renvoyer toutes les dimensions et valeurs. Si un identifiant de version est indiqué, les valeurs de dimension qui ne sont pas disponibles pour la version indiquée ne seront pas retournées. Si l’identifiant de version indiqué est introuvable, cette API renvoie une erreur. Si à la fois les attributs versionName et versionID sont transmis, l’attribut versionID est ignoré. Quand une version est précisée, l’appel aboutit uniquement si l’utilisateur a accès à la version. | 3 |
dimensionIDs Pris en charge dans l'API v17 + | N | Une liste d'identifiants qui s'afficheront dans la réponse de l'API. Ce filtre filtre une dimension, mais pas une valeur de dimension. | "1,2,3,14" |
attributs | N | Indique si la réponse doit inclure les attributs dans la réponse pour chaque dimension plate. | faux |
inaccessibleValues Pris en charge dans l'API v18 + | N | Indique si la réponse doit inclure des valeurs inaccessibles à l’utilisateur actuel. La valeur par défaut est Faux. Seuls les utilisateurs disposant des autorisations "Modélisation" ou "Importer à tous les niveaux" peuvent définir cette option à Vrai. | 1 |
dimensionValues Pris en charge dans l'API v22+ | N | Indique si la réponse doit inclure des valeurs de dimension pour chaque dimension. La valeur par défaut est vraie. Si la valeur est Faux, renvoie uniquement les dimensions filtrées, et non les valeurs de dimension. Si dimensionValeurs ne fait pas partie de l’élément d’inclusion, renvoie toutes les dimensions et leurs valeurs. Si l'élément d'inclusion ne fait pas partie de la demande, toutes les dimensions et leurs valeurs seront retournées. | faux |
displayNameEnabled
Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage. | N | displayNameEnabled=true indique que exportDimensions doit respecter les propriétés de 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 de l’API antérieure à la version 30, 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 « false ». | vrai |
Contenu de l'élément | |||
(aucun) | |||
Format de 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 | 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 de dimensions | |
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 |
identifiant | Y | Le numéro d’identifiant de système interne pour la dimension. Cela peut être utilisé pour désigner des dimensions dans d’autres appels d’API, tels que exportDimensionFamis. | 16 |
nom | Y | Le nom de la dimension, tel qu’il apparaît sur les rapports et les feuilles. | Client |
code
Disponible uniquement dans l'API v39+. | N | Le nom de la dimension, tel qu’il apparaît sur les rapports et les feuilles. Il ne s'affichera qu'avec l'API v39+ | Client |
displayNameType
Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage. | N | La représentation interne du format de nom d’affichage sélectionné pour les valeurs dans les pages d’administration des dimensions.
| NOM |
shortName | N | Le nom abrégé de la dimension, le cas échéant, tel qu’il est entré dans l’administration des dimensions. | client. |
autoCreate | Y | 1 si la dimension sélectionnée comporte l’ensemble de champs « Importation de données crée automatiquement des valeurs de dimension », 0 dans le cas contraire. | 0 |
listDimension | Y | 1 si la dimension sélectionnée est une dimension de liste, 0 dans le cas contraire. | 1 |
keepSorted | Y | 1 si la dimension sélectionnée est conservée et triée, 0 dans le cas contraire. | 1 |
useOnLevels | Y | 1 si la dimension sélectionnée peut être utilisée dans les niveaux, 0 dans le cas contraire. | 1 |
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future. | |||
description
Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage. | N | La description telle qu’elle est entrée dans l’administration des dimensions. | |
Contenu de l'élément | |||
Zéro 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 |
identifiant | Y | Le numéro d'identifiant de système interne pour cette valeur de membre de la dimension. | 34 |
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. | Une entreprise |
nom | Y | Étiquette de la valeur membre de la dimension, telle qu'elle est affichée dans les rapports et utilisée dans les formules. | Une entreprise |
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. | Une entreprise |
shortName | N | Nom abrégé de la valeur de dimension, le cas échéant, tel qu'il est entré dans l'administration des dimensions | A |
description | N | Description de la valeur de dimension, le cas échéant, telle qu’elle est entrée dans l’administration des dimensions | Une société |
Contenu de l'élément | |||
Zéro 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 sont implicitement regroupés dans cette valeur. Un élément de propriétés facultatif. | |||
élément de 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 | Indique une propriété personnalisée. Les valeurs des éléments de propriété contiennent uniquement des caractères numériques. | ||
Attributs de l'élément | |||
Nom de l’attribut | Obligatoire? | Valeur | Exemple |
nom | Y | Le nom de la propriété. | Latitude |
valeur | N | La valeur de la propriété. | 33.6015 |
Contenu de l'élément | |||
(aucun) | |||
élément d'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 | Y | Identifiant de l'attribut de dimension généré par le système. | 20 |
nom | Y | Nom de l'attribut de dimension | Type d'études |
valueID | Y | Identifiant unique de la valeur d'attribut de dimension générée par le système. | 170 |
valeur
Pris en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est ACTIVÉ. | Y | La 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 valeur d'attribut pour cet attribut.
Pour les 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 les API v32 et API v33, valueName n’a de sens que lorsque :
| Tech1 |
valueDisplayName
Disponible uniquement dans l’API v32+ pour les instances qui activent le nom d’affichage. | Y | Pour l’API v32 et les versions plus récentes, valueDisplayName n’a de sens que lorsque :
| Tech1 |
Contenu de l'élément | |||
(aucun) | |||