updateDimensionValue

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

Non pris en charge dans l'API v20 +

Catégorie	Modification de métadonnées
Description	Mettez à jour une valeur de dimension. En cas de réussite, l’API renvoie les détails de la dimension et toutes les valeurs de dimension, y compris celle qui vient d’être mise à jour.
Autorisations obligatoires pour pouvoir être appelées	Modèle
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur d’identifiants pour désigner et autoriser l’utilisateur auteur de l’appel. L'utilisateur doit avoir l'autorisation Modèle pour créer la dimension.

Cette méthode renvoie une erreur s’il existe des modifications non publiées.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensionValue" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimensionValue
       id="10"
       name="New Dimension Value">
       <attributes>
         <attribute attributeId="20" valueId="170" />
       </attributes>
   </dimensionValue>
</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), et par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action dans l’ordre pour l’API. appel pour 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 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)

Élément dimensionValue
Nom du marqueur		dimensionValue
Description		Indique une valeur de dimension à mettre à jour.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
dimensionId	N	Identifiant de la dimension à laquelle appartient la valeur.	3
identifiant	Y	L'identifiant de la valeur de dimension.	34
nom	Y	Le nom de la valeur de dimension.	NewDimensionValue
shortName	N	Nom abrégé de la valeur de dimension.	NewDimensionValue - Raccourci
parentId	N	L'identifiant de la valeur de dimension parent.	220
description	N	Description de la valeur de dimension.	Ceci est une NewDimensionValue
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
valueID	Y	Identifiant unique de la valeur d'attribut de dimension générée par le système. Si cette valeur est 0, cet attribut est supprimé du compte.	170
Contenu de l'élément
(aucun)

Format de réponse

Voici des exemples de réponses pour une mise à jour réussie ou non d’une valeur de dimension.

Exemple de réussite


<?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">
               <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="" /></dimensionValue>
      </dimension>
      <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
               <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>
   </dimensions>
 </output>
</response>

Exemple d'erreur


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
        <message type="ERROR" key="invalid-attributevalueid" values="-50" dimensionValueId="10">Invalid attribute value id: "-50"</message>
    </messages>
</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 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 exportDimensionFamily.	16
nom	Y	Le nom de la dimension, tel qu’il apparaît sur les rapports et les feuilles.	Client
shortName	N	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 au tri, 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
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
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
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.

é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	Y	La valeur de l'attribut de dimension.	Tech1
Contenu de l'élément
(aucun)

updateDimensions

updateLevel

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