importDimensionMapping

Adaptive Planning

Notes de publication (Workday 2025R2)

Pris en charge dans l'API v19 +

Catégorie	Soumission de métadonnées
Description	L'API ImportDimensionMapping peut être utilisée pour importer des valeurs de dimensions dérivées.
Autorisations obligatoires pour pouvoir être appelées
Paramètres requis sur demande	Identifiants

L’API ImportDimensionMapping peut être utilisée pour importer les conditions de mappage qui déterminent les valeurs de la dimension de mappage à remplir automatiquement dans les rangées de la feuille modélisée. Il peut être utilisé pour créer, mettre à jour et supprimer des conditions de mappage. Les valeurs de dimension dérivées sur les rangées de la feuille modélisée 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 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 invoquer 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 période 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 indiquer 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 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 les mappages.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
Nom	Obligatoire lorsque l'identifiant n'est pas précisé.	Le nom de la version.	Budget 2017
identifiant	Obligatoire lorsque le nom n'est pas précisé.	Identifiant de la version	7
Contenu de l'élément
Contient un ou plusieurs éléments de niveau.

Élément de dimensions
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 nous souhaitez importer des mappages.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Obligatoire lorsque l'identifiant n'est pas précisé.	Nom de la dimension à importer les mappages	Aires
identifiant	Obligatoire lorsque le nom n'est pas précisé.	Identifiant de la dimension à importer des mappages.	15
Contenu de l'élément
Un élément mappageCriteria.

Élément mappageCriteria
Nom du marqueur		mappageCritères
Description Description		Conteneur pour une liste d'éléments <mappingCriterion>
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	N	Si un identifiant est fourni, un critère de mappage existant avec 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
Des éléments mappageCriterion pour chaque valeur de dimension de la dimension dérivée.

Élément mappage de critères
Nom du marqueur		mappageCritère
Description Description		Décrit les dimensions individuelles et les valeurs de dimension qui déterminent le mappage d’une valeur de dimension. Doit être suivi par un groupe de marqueurs mapTo , dimension et dimensionValue .
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	N	Si un identifiant est fourni, un critère de mappage existant avec cet identifiant sera mis à jour. Si aucun identifiant n’est fourni, un nouveau critère de mappage est ajouté à la dimension.	12
supprimer	N	Entrez "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 en fonction 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ée.	Nom de la valeur de dimension à laquelle ce critère de mappage est mappé.	Aires
dimensionValueId	Obligatoire lorsque dimensionValue n'est pas indiquée.	Le nom de la valeur de dimension à laquelle ce critère de mappage est mappé.	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ériver la valeur de dimension mapTo . Au moins un élément de dimension pour la dimension 'Niveau' 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 précisé.	Nom de la dimension	Secteur d'activité
identifiant	Obligatoire lorsque le nom n'est pas précisé.	Identifiant de la dimension
valeur	N	Le nom de la valeur de dimension. Obligatoire sauf s'il existe dimensionValue	Détail
valueId	N	L'identifiant de la valeur de dimension. Cette valeur ou cette valeur 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	Y	Nom de la valeur de dimension	Détail
code Dans l’API v30+, utilisez un code plutôt qu’un nom.	Obligatoire lorsque l'identifiant n'est pas précisé.	Code de la valeur de dimension	Détail
identifiant	Obligatoire lorsque le code n'est pas précisé.	Identifiant de la valeur de dimension	25
Contenu de l'élément
(aucun)

Exemples :


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <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 RQ dans la dimension Niveau et MA dans la dimension État à la valeur de dimension East dans la dimension Aires. Les rangées où les deux valeurs correspondent seront incrémentées par East. Comme l'attribut d'identifiant est précisé, ce critère de mappage remplacera un critère de mappage existant avec cet identifiant.


<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 RQ dans la dimension de niveau et CA ou CO dans la dimension d’état à la valeur de dimension East dans la dimension Aires. Les rangées où les deux valeurs correspondent seront incrémentées par East.


<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 réponse

Réponse à une réussite


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

Réponse à un é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	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
Contenu de l'élément
Un seul élément de message facultatif et un seul é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 renvoyé par le système à l’appelant. Les messages sont utilisés pour envoyer des messages d’erreur lorsque les demandes échouent, pour envoyer des messages d’avertissement lorsque les demandes réussissent et pour les messages de confirmation lorsque les demandes réussissent.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
clé	N	Lorsqu’elle est fournie, une clé est un moyen de repérer un message ou un type de message particulier, ce qui est utile à des fins d’enregistrement automatique d’erreurs et de récupération 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 improbable que les clés changent à l’avenir en raison d’ajustements de formulation ou de changements de terminologie.	invalid-attributevalueid
Contenu de l'élément
Le texte du message. Ce texte est dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des renseignements variables, tels que le nombre de rangées traitées, ou la colonne ou la valeur particulière qui a causé une erreur.

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

Que désirez-vous porter à notre attention? Information exacte Répond à ma question Facile à trouver Facile à comprendre M'aide à effectuer ma tâche Information complète et détaillée

Que désirez-vous porter à notre attention? Information inexacte Ne répond pas à ma question Difficile à trouver Difficile à comprendre Ne m'aide pas à effectuer ma tâche Information incomplète ou pas assez détaillée

Décrivez-nous la tâche que vous effectuez. Quelle information supplémentaire pourrait améliorer ce contenu? Voulez-vous partager d’autres détails?

Nom complet

Courriel

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

Merci pour vos commentaires