importDimensionMapping

Adaptive Planning

Documentation Workday Adaptive Planning (Workday 2025R2)
Intégration
Gérer l'intégration des données
Documentation de l'API
Méthodes de création, de mise à jour et de lecture des métadonnées et des données

Dernière mise à jour : 2023-06-23

Prise en charge dans API v19 et supérieure

Catégorie	Soumission des métadonnées
Description	L'API importDimensionMapping peut être utilisée pour importer des valeurs de dimensions dérivées.
Autorisations requises pour appeler
Paramètres obligatoires à la demande	Identifiants

L'API importDimensionMapping peut être utilisée pour importer les conditions de mappage qui déterminent les valeurs de dimension de mappage à renseigner automatiquement sur les lignes d'une feuille modèle. Elle peut être utilisée pour créer, mettre à jour et supprimer des conditions de mappage. Les valeurs des dimensions dérivées sur les lignes des feuilles modèles ne prennent pas en charge les versions virtuelles.

Format de demande

<?xml version='1.0' encoding='UTF-8'?>
<call method="importDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <version name="Budget 2017" id="7"/>
  <dimensions>
        <dimension id="345" name="Area">
            <mappingCriteria>
                <mappingCriterion id="121">
                    <mapTo dimensionValueId="877" dimensionValue="East"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" valueId="15" value="MA"/>
                </mappingCriterion>
                <mappingCriterion id="122">
                    <mapTo dimensionValueId="876" dimensionValue="West"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" id="5">
                        <dimensionValue id="900" code="CA"/>
                        <dimensionValue id="901" code="CO"/>
                    </dimension>
                </mappingCriterion>
            </mappingCriteria>
        </dimension>
    </dimensions>
</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 indiqué dans les identifiants a accès à plusieurs instances Adaptive Planning, cet attribut peut être utilisé pour indiquer qu'il a l'intention d'accéder à une instance différente de 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 exportInstances .	MYINSTANCE1
Contenu de l'élément
(aucun)

élément de version
Nom du marqueur		version
Description		Indique la version pour laquelle importer des mappages.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
Nom	Obligatoire lorsque l'identifiant n'est pas indiqué.	Nom de la version.	Budget 2017
id	Obligatoire lorsque le nom n'est pas indiqué.	Identifiant de version	7
Contenu de l'élément
Contient un ou plusieurs éléments de périmètre.

é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	Obligatoire lorsque l'identifiant n'est pas indiqué.	Nom de la dimension dont vous souhaitez importer les mappages	Graphique en aires
id	Obligatoire lorsque le nom n'est pas indiqué.	Identifiant de la dimension dont vous souhaitez importer les mappages.	15
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
supprimer	N	Saisissez "yes" pour supprimer toutes les conditions de mappage dans mappingCriterion. Une valeur vide ou toute valeur autre que "oui" est ignorée et les conditions de mappage ne sont pas supprimées.	oui
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
dimensionValue	Obligatoire lorsque dimensionValueId n'est pas indiqué.	Nom de la valeur de dimension mappée par ce critère de mappage.	Graphique en aires
dimensionValueId	Obligatoire lorsque dimensionValue n'est pas indiqué.	Le nom de l'identifiant de la valeur de dimension mappé à ce critère de mappage.	12
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 . Au moins, un élément de dimension pour la dimension 'Périmètre' est obligatoire ainsi qu'un élément de dimension pour une dimension personnalisée.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	Obligatoire lorsque l'identifiant n'est pas indiqué.	Nom de la dimension	Secteur d'activité
id	Obligatoire lorsque le nom n'est pas indiqué.	Identifiant de la dimension
valeur	N	Nom de la valeur de dimension. Obligatoire sauf s'il existe dimensionValue	Commerce de détail
valueId	N	Identifiant de la valeur de dimension. Cette valeur ou this est obligatoire sauf s'il existe des éléments dimensionValue
Contenu de l'élément
Éléments dimensionValue

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 valeur .
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Le nom de la valeur de dimension	Commerce de détail
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 de la valeur de dimension	Commerce de détail
id	Obligatoire lorsque le code n'est pas indiqué.	Identifiant de la valeur de dimension	25
Contenu de l'élément
(aucun)

Exemples :

Le critère de mappage permet de mapper les valeurs de dimension Siège social de la dimension de périmètre et Massachusetts dans la dimension État à la valeur de dimension Est dans la dimension Domaine. Les lignes où les deux valeurs correspondent seront augmentées avec la valeur Est.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion id="123">
            <mapTo dimensionValue="East"/>
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Le critère de mappage pour mapper les valeurs de dimension Siège social dans la dimension de périmètre et CA ou CO dans la dimension État à la valeur de dimension Est dans la dimension Domaine. Les lignes où les deux valeurs correspondent seront augmentées avec la valeur Est.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State">         
                <dimensionValue code="CA"/>  
                <dimensionValue code="CO"/>
            </dimension>
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Format de la réponse

Réponse réussie


<?xml version="1.0" encoding="UTF-8"?>
<response success="true"/>

Réponse d'échec


<?xml version="1.0" encoding="UTF-8"?>
<response success="false">
    <messages>
        <message>There are duplicate mapping conditions. Make all mappingCriterion conditions unique</message>
    </messages>
</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 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.

exportVersions

importGroups

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