exportDimensionMapping

Adaptive Planning

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

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

Pris en charge dans l'API v19 +

Catégorie	Metadata retrieval
Description	Exporte les critères de mappage de dimensions dérivées pour une ou plusieurs dimensions dans une version donnée.
Autorisations obligatoires pour pouvoir être appelées
Paramètres requis sur 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 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 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 la méthode de l’API xref.	MYINSTANCE1
Contenu de l'élément
(aucun)

Élément de version
Nom du marqueur		version
Description		Indique à partir de quelle version extraire les rangées modélisées.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
Nom	Y	Le nom de la version.	Budget 2017
Contenu de l'élément
(aucun)

é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	Y	Nom de la dimension pour laquelle importer les mappages	Aires
Contenu de l'élément
Un élément mappageCriteria.

Filtres d'élément
Nom du marqueur		filtres
Description		Contient la spécification des filtres qui déterminent les données de la version et des dimensions demandées qui sont récupérées par l’API. Cet élément précise le mot-clé, les niveaux et les valeurs de dimension que contiennent les entrées de critère de mappage correspondants qui seront récupérés.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un seul élément de mot-clé facultatif, un seul élément de niveau facultatif et un seul élément de dimensionValeurs facultatif.

Élément Niveaux
Nom du marqueur		niveaux
Description		Conteneur pour les éléments de zéro ou d’un niveau .
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Élément de niveau de zéro ou d'un

élément de niveau
Nom du marqueur		niveau
Description		Indique un niveau d'organisation pour que les données soient exportées dans cet appel d'API.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	Le nom du niveau à exporter. Ce nom est tel qu'il est indiqué dans la section Administration de l'organisation.	Développement
code Dans l’API v30+, utilisez un code plutôt qu’un nom.	Obligatoire lorsque l'identifiant n'est pas précisé.	Le code du niveau à exporter. Ce code est tel qu'il est indiqué dans la section Administration des organisations.	Développement
identifiant	Obligatoire lorsque le code n'est pas précisé.	Le numéro d’identifiant de système interne du niveau à exporter.	8
includeDescendants	Y	Indique si l'exportation doit inclure ou non tous les descendants du niveau précisé. Si la valeur est Vrai, tous les enfants de ce niveau seront également exportés, tout comme leurs enfants, etc. S'il est défini à Faux, ce niveau sera exporté seul.	Vrai
Contenu de l'élément
(aucun)

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

dimensionValue Element
Nom du marqueur		dimensionValue
Description		Indique que les données exportées doivent contenir uniquement les entrées de critère de mappage qui contiennent la dimensionValue indiquée correspondante. Si plusieurs éléments dimensionValue se trouvent dans l’élément dimensionValeurs, les entrées de critères de mappage exportés doivent contenir toutes les dimensions/valeurs précisées. Par exemple, si une demande précise les valeurs de dimension Region=Est et Produit=Produit_A, le critère de mappage doit avoir la région East et le produit Product_A pour que le critère de mappage puisse être exporté. Notez également que chaque dimensionValue dans l’élément dimensionValeurs doit appartenir à une dimension différente. Par exemple, une demande avec les valeurs de dimension Region= East et Region = West ne sera pas acceptée. Dans le cas où les dimensions de filtrage des données entrantes 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 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.	ouest des États-Unis
code Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	Requis lorsque l’identifiant n’est pas précisé	Code de la valeur de dimension à exporter.	ouest des États-Unis
sans catégorie	N	Si la valeur est Vrai, les données exportées contiendront le critère de mappage avec uniquement la valeur de dimension correspondante et non les valeurs d’une de ses valeurs descendantes (le cas échéant). N’a aucun effet sur les valeurs de dimension sans enfant. Si elle n’est pas précisée, la valeur par défaut est Faux.	vrai
dimId	obligatoire lorsque dimName n'est pas indiqué.	Le numéro d’identifiant de système interne de la dimension à laquelle appartient la valeur de dimension (voir l’attribut de nom ci-dessus).	15
uncategorizedOfDimension	N	Précisez l’attribut uncategorizedOfDimension au lieu des attributs dimName/uncategorized . Si elle est précisée, la valeur de l’attribut doit être un numéro d’identifiant de système interne d’une dimension (et non une valeur de dimension) et le filtre précise que les données doivent être sans catégorie dans cette dimension pour correspondre au filtre. Les attributs sans catégorie seront ignorés et supposeront qu'ils sont vrai. Ignoré si dimName est indiqué.	15
identifiant	Requis lorsque le code n'est pas précisé	Indiquez l'identifiant au lieu des attributs de nom . Le numéro d'identifiant de système interne de la valeur de dimension à exporter. Doivent être précisés à la place des attributs de nom pour indiquer la valeur de la dimension. Pour déterminer les identifiants internes, consultez l’API exportDimensions . Omis si le nom est précisé.	14
Contenu de l'élément
(aucun)

Format de 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	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 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	Y	Nom de la dimension pour laquelle importer les mappages	Aires
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
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
dimensionValueId	Y	L'identifiant de la valeur de dimension à laquelle ce critère de mappage est mappé.	11
dimensionValue	Y	Nom de la valeur de dimension à laquelle ce critère de mappage est mappé.	Californie
dimensionValueCode	Y	Le code de la valeur de dimension à laquelle ce critère de mappage est mappé.	CA
dimensionValueDisplayName	Y	Nom d'affichage de la valeur de dimension à laquelle ce critère de mappage est mappé.	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ériver la valeur de dimension mapTo.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	Nom de la dimension	Aires
ValueId	N	L'identifiant de la valeur de dimension. Obligatoire sauf s'il existe des éléments dimensionValue.	282
valeur	N	Le 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	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
identifiant	Y	Identifiant de la valeur de dimension	10
nom	Y	Nom de la valeur de dimension	Colorado
code	Y	Code de la valeur de dimension	CO
displayName	Y	Nom d'affichage de la valeur de dimension	Colorado
Contenu de l'élément
(aucun)

élément de message
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.

export Locales

exportModeledSheet

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