updateDimensionValue

Adaptive Planning

Nouveautés (Workday 2025R2)

Non pris en charge dans API v20 et supérieure

Catégorie	Modification des métadonnées
Description	Mettre à jour une valeur de dimension. Si elle fonctionne, l'API renvoie le détail de la dimension et toutes les valeurs de dimension, y compris celle qui vient d'être mise à jour.
Autorisations requises pour appeler	Rapport modèle
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. 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 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 (toute la piste d'audit ou l'historique des 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 dans l'ordre pour l'API appelez pour 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 mois 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 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
id	O	Identifiant de la valeur de dimension.	34
nom	O	Nom de la valeur de dimension.	NewDimensionValue
shortName	N	Nom abrégé de la valeur de dimension.	NewDimensionValue - Nom abrégé
parentId	N	Identifiant de la valeur de dimension parent.	220
description	N	Description de la valeur de dimension.	Il s'agit d'une valeur NewDimensionValue
Contenu de l'élément
(aucun)

élément 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	O	Identifiant de l'attribut de dimension généré par le système.	20
valueID	O	Identifiant unique de la valeur d'attribut de dimension générée par le système. Si cette valeur est 0, alors cet attribut est supprimé du compte.	170
Contenu de l'élément
(aucun)

Format de la 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	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
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un é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 seul élément comptes. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi.

élément de dimension
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
id	O	Le numéro d'identification du système interne pour la dimension. Cela peut être utilisé pour identifier les dimensions dans d'autres appels d'API, tels que exportDimensionFamily.	16
nom	O	Nom de la dimension tel qu'il apparaît sur les rapports et les feuilles.	Customer
shortName	N	Le nom abrégé de la dimension, le cas échéant, tel que saisi dans Administration des dimensions	client.
autoCreate	O	1 si le champ " L'importation de données crée automatiquement des valeurs de dimension" est défini pour la dimension sélectionnée ; 0 autrement.	0
listDimension	O	1 si la dimension sélectionnée est une dimension en liste ; 0 autrement.	1
keepSorted	O	1 si la dimension sélectionnée reste triée, 0 sinon.	1
useOnLevels	O	1 si la dimension sélectionnée peut être utilisée sur les périmètres, 0 sinon.	1
Contenu de l'élément
0 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
id	O	Numéro d'identifiant système interne associé à cette valeur de membre de la dimension.	34
nom	O	Libellé de la valeur de membre de la dimension, tel qu'il est affiché sur les rapports et utilisé dans les formules.	Entreprise A
shortName	N	Nom abrégé de la valeur de dimension, le cas échéant, tel que saisi dans Administration des dimensions	A
description	N	Description de la valeur de dimension, le cas échéant, telle que saisie dans l'option Administration des dimensions.	Une société
Contenu de l'élément
Aucun 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 s'agrègent implicitement à cette valeur.

élément 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	O	Identifiant de l'attribut de dimension généré par le système.	20
nom	O	Le nom de l'attribut de dimension	Type d'études
valueID	O	Identifiant unique de la valeur d'attribut de dimension générée par le système.	170
valeur	O	Valeur de l'attribut de dimension.	Tech1
Contenu de l'élément
(aucun)

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