exportDimensionMapping

Adaptive Planning

Nouveautés (Workday 2025R2)

Prise en charge dans API v19 et supérieure

Catégorie	Metadata retrieval
Description	Permet d'exporter les critères de mappage des dimensions dérivées pour une ou plusieurs dimensions dans une version donnée.
Autorisations requises pour appeler
Paramètres obligatoires à la demande	Identifiants

Cette API permet de récupérer une liste de critères de mappage pour une ou plusieurs dimensions dérivées. Pour chaque dimension de la demande, il récupère les valeurs mapTo et les conditions de valeur de dimension.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <dimensions>
    <dimension name="Area">                       
    </dimension>
  </dimensions>
  <version name = "Budget 2017"/>
  <filters>
    <keyword value="Alameda" />
    <levels>
      <level code="HQ" includeDescendants="true" />
    </levels>
    <dimensionValues>
      <dimensionValue dimName="Geography" code="California" />
      <dimensionValue dimId="34" uncategorized="true" />
      <dimensionValue dimName="Region" code="Bay Area" uncategorized="true" />
      <dimensionValue dimId="19" id="78" />
    </dimensionValues>
    <attributes>
      <attribute id="1" uncategorized="true"/>
      <attribute name="attributeName1" value="attributeValue1"/>
      <attribute id="3" valueId="31" uncategorized="true"/>
    </attributes>
  </filters>
</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 période 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 la méthode API xref.	MYINSTANCE1
Contenu de l'élément
(aucun)

élément de version
Nom du marqueur		version
Description		Indique la version à partir de laquelle récupérer les lignes modèles.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
Nom	O	Nom de la version.	Budget 2017
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimensions
Description		Conteneur pour une liste d'éléments <dimension>.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
éléments de dimension

élément de dimension
Nom du marqueur		dimension
Description		Décrit une dimension pour laquelle importer des mappages.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Nom de la dimension pour laquelle importer des mappages	Graphique en aires
Contenu de l'élément
Un élément mappageCriteria.

éléments de filtre
Nom du marqueur		filtres
Description		Contient la spécification des filtres qui déterminent quelles données de la version et de la dimension demandée sont extraites par l'API. Cet élément indique le mot-clé, les périmètres et les valeurs de dimension qui seront extraits dans les entrées de critères de mappage correspondants.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un seul élément de mot de passe facultatif, un seul élément de périmètre facultatif et un seul élément dimensionValues facultatif.

élément périmètres
Nom du marqueur		périmètre(s)
Description		Conteneur pour les éléments de périmètre 0 ou 1.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Élément de périmètre 0 ou 1

élément de périmètre
Nom du marqueur		level
Description		Indique un périmètre d'organisation dont les données doivent être exportées dans cet appel d'API.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Le nom du périmètre à exporter. Ce nom est indiqué dans l'administration de l'organisation.	Développement
code Dans l'API v30 et supérieure, utilisez le code au lieu de nom.	Obligatoire lorsque l'identifiant n'est pas indiqué.	Le code du périmètre à exporter. Ce code est tel qu'il est indiqué dans Administration de l'organisation.	Développement
id	Obligatoire lorsque le code n'est pas indiqué.	L'identifiant système interne du périmètre à exporter.	8
includeDescendants	O	Indique si l'export doit inclure ou non tous les descendants du périmètre spécifié. Si la valeur est true, tous les enfants de ce périmètre seront également exportés, de même que leurs enfants, etc., etc. Si la valeur est false (faux), ce périmètre sera exporté seul.	Vrai
Contenu de l'élément
(aucun)

Élément dimensionValues
Nom du marqueur		dimensionValues
Description		Conteneur pour les éléments dimensionValue de zéro ou plus.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
0 ou plusieurs éléments dimensionValue .

dimensionValue Element
Nom du marqueur		dimensionValue
Description		Indique que les données exportées ne doivent contenir que les entrées de critère de mappage qui contiennent la dimensionValue spécifiée correspondante. Si plusieurs éléments dimensionValue se trouvent dans l'élément dimensionValues, les entrées de critères de mappage exportées doivent contenir toutes les dimensions/valeurs indiquées. Par exemple, si une demande indique les valeurs de dimension Région=Est et Produit=Produit_A, le critère de mappage doit indiquer que Région contient Est et que Produit contient Produit_A pour pouvoir être exporté. Notez également que chaque dimensionValue dans l'élément dimensionValues doit appartenir à une dimension différente. Par exemple, une demande avec les valeurs de dimension Région=Est et Région=Ouest ne sera pas acceptée. Dans le cas où les dimensions de filtre d'entrée n'appartiennent à aucune des dimensions demandées, elles seront ignorées.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
dimName	obligatoire lorsque le paramètre uncategorizedOfDimension n'est pas indiqué	Le nom de la dimension à laquelle appartient la valeur de dimension (voir l'attribut de nom ci-dessous).	Région
nom	N	Nom de la valeur de dimension à exporter.	US West
code Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	Obligatoire si l'identifiant n'est pas indiqué	Le code de la valeur de dimension à exporter.	US West
sans catégorie	N	Si la valeur est true (vrai), les données exportées contiennent le critère de mappage avec uniquement la valeur de dimension correspondante et aucune valeur d'aucune de ses valeurs descendantes (le cas échéant). N'a aucun effet sur les valeurs de dimension sans enfants. Si aucune valeur n'est indiquée, la valeur par défaut est false (faux).	vrai
dimId	obligatoire lorsque dimName n'est pas indiqué.	Le numéro d'identification du système interne de la dimension à laquelle appartient la valeur de dimension (voir l'attribut de nom ci-dessus).	15
uncategorizedOfDimension	N	Indiquez uncategorizedOfDimension à la place des attributs dimName/uncategorized . Si elle est indiquée, la valeur de l'attribut doit être un numéro d'identifiant système interne d'une dimension (pas une valeur de dimension) et le filtre indique que les données doivent être entièrement sans catégorie dans cette dimension pour correspondre au filtre. Les attributs sans catégorie seront ignorés et supposés être vrais. Ignoré si dimName est indiqué.	15
id	Obligatoire si le code n'est pas indiqué	Indiquez l'identifiant à la place des attributs de nom . Numéro d'identifiant système interne de la valeur de dimension à exporter. Doit être indiqué à la place des attributs de nom pour indiquer la valeur de dimension. Pour déterminer les identifiants internes, voir l'API exportDimensions . Ignoré si le nom est indiqué.	14
Contenu de l'élément
(aucun)

Format de la réponse


<response success="true">
 <output>
        <mappings>
            <version name="Budget 2017"/>
            <dimensions>
                <dimension name="Area">
                    <mappingCriteria>
                        <mappingCriterion id="121">
                            <mapTo dimensionValue="East"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State" value="MA"/>
                        </mappingCriterion>
                        <mappingCriterion id="122">
                            <mapTo dimensionValue="West"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State">
                                <dimensionValue name="CO"/>
                                <dimensionValue name="CA"/>
                            </dimension>
                        </mappingCriterion>
                    </mappingCriteria>
                </dimension>
            <dimensions/>
        </mappings>
    </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
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un élément de sortie obligatoire.

élément de dimension
Nom du marqueur		dimensions
Description		Conteneur pour une liste d'éléments <dimension>.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
éléments de dimension

élément de dimension
Nom du marqueur		dimension
Description		Décrit une dimension pour laquelle importer des mappages.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Nom de la dimension pour laquelle importer des mappages	Graphique en aires
Contenu de l'élément
Un élément mappageCriteria.

Élément mappingCriteria
Nom du marqueur		mappagesCritères
Description Description		Conteneur pour une liste d'éléments <mappingCriterion>
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	N	Si un identifiant est fourni, un critère de mappage existant portant cet identifiant sera mis à jour. Si aucun identifiant n'est fourni, un nouveau critère de mappage est ajouté à la dimension.	12
Contenu de l'élément
Les éléments mappingCriterion pour chaque valeur de la dimension dérivée.

Élément mappageCriteria
Nom du marqueur		mappageCritère
Description Description		Décrit les dimensions individuelles et les valeurs de dimension qui déterminent si une valeur de dimension est mappée à. Doit être suivi d'un groupe de marqueurs mapTo , dimension et dimensionValue .
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	N	Si un identifiant est fourni, un critère de mappage existant portant cet identifiant sera mis à jour. Si aucun identifiant n'est fourni, un nouveau critère de mappage est ajouté à la dimension.	12
Contenu de l'élément
Contient un élément mapTo et jusqu'à six éléments de dimension.

Élément mapTo
Nom du marqueur		mapTo
Description		Indique la valeur de dimension dérivée des critères de mappage.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
dimensionValueId	O	Identifiant de la valeur de dimension à laquelle ce critère de mappage est mappé.	11
dimensionValue	O	Nom de la valeur de dimension mappée par ce critère de mappage.	Californie
dimensionValueCode	O	Le code de la valeur de dimension à laquelle ce critère de mappage est mappé.	CA
dimensionValueDisplayName	O	Nom d'affichage de la valeur de dimension mappée à ce critère de mappage.	Californie
Contenu de l'élément
(aucun)

élément de dimension
Nom du marqueur		dimension
Description		Décrit l'une des dimensions utilisées pour déterminer la valeur de dimension mapTo.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Nom de la dimension	Graphique en aires
ValueId	N	Identifiant de la valeur de dimension. Obligatoire sauf s'il existe des éléments dimensionValue.	282
valeur	N	Nom de la valeur de dimension. Obligatoire sauf s'il existe des éléments dimensionValue	West
valueCode	N	Le code de la valeur de dimension. Obligatoire sauf s'il existe des éléments dimensionValue.	Nous
valueDisplayName	N	Le nom d'affichage de la valeur de dimension. Obligatoire sauf s'il existe des éléments dimensionValue.	West
Contenu de l'élément
(aucun)

dimensionValue Element
Nom du marqueur		dimensionValue
Description		(Facultatif) Si plusieurs valeurs de dimension doivent être répertoriées pour un marqueur de dimension , une série de marqueurs dimensionValue peut être utilisée à la place de l'attribut de nom .
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Identifiant de la valeur de dimension	10
nom	O	Le nom de la valeur de dimension	Colorado
code	O	Le code de la valeur de dimension	CO
displayName	O	Le nom d'affichage de la valeur de dimension	Colorado
Contenu de l'élément
(aucun)

élément de messages
Nom du marqueur	messages
Description	Conteneur pour un ou plusieurs éléments de message.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de message.

élément de message
Nom du marqueur		message
Description		Représente un message que le système renvoie à l'appelant. Les messages sont utilisés pour les messages d'erreur lorsque les demandes n'ont pas abouti, pour les messages d'avertissement lorsque les demandes ont abouti et pour les messages de confirmation lorsque les demandes ont abouti.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
clé	N	Lorsqu'elle est fournie, une clé permet d'identifier un message ou un type de message particulier, utile pour l'enregistrement et la récupération automatisés des erreurs dans les programmes clients. Les clés ne changent pas selon les paramètres régionaux des demandes, même lorsque la langue du message change. Il est également peu probable que les clés changent à l'avenir en raison d'ajustements du libellé ou de la terminologie.	invalid-attributvalueid
Contenu de l'élément
Texte du message. Ce texte est exprimé dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux soient pris en charge). Le texte peut également contenir des informations variables telles que le nombre de lignes qui ont été traitées ou la colonne ou la valeur particulière qui a généré une erreur.

Cela vous a-t-il été utile?

Souhaitez-vous nous signaler quelque chose ? Exact Répond à ma question Facile à trouver Facile à comprendre Utile pour ma tâche Complet et détaillé

Souhaitez-vous nous signaler quelque chose ? Inexact Ne répond pas à ma question Pas facile à trouver Pas facile à comprendre Inutile pour ma tâche Incomplet ou pas assez détaillé

Décrivez-nous votre tâche en cours. Quelles informations supplémentaires pourraient améliorer ce contenu ? Voulez-vous partager des informations supplémentaires ?

Nom complet

E-mail

Workday utilisera votre nom et votre adresse électronique pour répondre à vos commentaires. Vos données seront traitées conformément à notre Déclaration de confidentialité.

Merci pour votre feedback