updateAssociations

Adaptive Planning

updateAssociations

Catégorie	Modification des métadonnées
Description	Mettez à jour la responsabilité ou l'association des entités (par exemple, Périmètre). Plusieurs associations avec plusieurs valeurs peuvent être mises à jour dans un appel. Si l'opération s'effectue avec succès, l'API renvoie un message indiquant que l'opération s'effectue correctement. Si l'API échoue, une liste complète des erreurs et de leurs causes est renvoyée.
Autorisations requises pour appeler	Gestion du modèle : Gestion du modèle : Structure d'organisation : Accès administrateur de tous les périmètres : Utilisateurs
Paramètres obligatoires à la demande	Identifiants

Voir Concept : associations et Importer les associations.

Les conditions suivantes s'appliquent aux updateAssociations :

Chaque association a un type, une opération facultative et un ensemble d'identifiants de valeur de dimension (identifiants de l'entité).

Pour créer une nouvelle association, indiquez l'identifiant de l'entité (par exemple, identifiant de périmètre) à laquelle nous souhaitez accorder la responsabilité et la liste des identifiants utilisateurs (identifiant, identifiant Workday ou nom d'utilisateur).

Pour une association, si le même identifiant d'entité est mentionné plusieurs fois, le dernier est utilisé.

Les utilisateurs indiqués dans la demande mais absents du système seront ignorés. Les utilisateurs valides restants dans la demande seront traités et leurs informations d'association seront mises à jour.

Pour les associations de dimensions personnalisées, les champs code, name et dimId sont des champs obligatoires.

La demande peut contenir zéro ou une seule association pour la responsabilité de périmètre. Pour toutes les autres associations de périmètres, vous aurez besoin des champs supplémentaires de code, de nom et dimId.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAssociations" callerName="me">
<credentials login="sampleuser@greenco.com" password="my_pwd"/>
<associations>
  <association type="level" operation = "update">
   <dimValueIds>
     <dimValueId id = "2">
         <users>
             <id> 1, 2, 3 , 87654</id>
         </users>        
     </dimValueId>
     <dimValueId id = "24">
         <users>
             <WID>23,12</WID>
             <username>stevec@grEENco.com</username>
         </users>
     </dimValueId>
     <dimValueId id = "6">
         <users>
             <id> 1, 2, 3 </id>
             <username>johno@greenco.com, johnstevec@greenco.com</username>
             <WID> ABC, CSD </WID>
         </users>
     </dimValueId>
     <dimValueId id = "12">          
     </dimValueId>      
   </dimValueIds>
 </association>
 <association type="customdimension" code= "CD1" name="CustomDim1" operation="replaceAll" dimId="8">
   <dimValueIds>
     <dimValueId id = "86">
         <users>
             <id> 14, 45</id>
         </users>        
     </dimValueId>
     <dimValueId id = "92">
         <users>
             <id>20, 21</id>
             <WID>ABCD</WID>
             <username>stevec@grEENco.com</username>
         </users>
     </dimValueId>
   </dimValueIds>
 </association>
 <association type="customdimension" code= "CD2" name="CustomDim2" operation="update" dimId="4">
   <dimValueIds>
     <dimValueId id = "16">
         <users>
             <id> 20, 21</id>
         </users>        
     </dimValueId>
   </dimValueIds>
 </association>
 <association type="level" code= "TL2" name="TestLevels2" operation="update" dimId="-1">
   <dimValueIds>
     <dimValueId id = "1">
         <users>
             <id> 15</id>
         </users>        
     </dimValueId>
   </dimValueIds>
 </association>
</associations>
</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 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 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 l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

élément associations
Nom du marqueur		associations
Description		Une seule demande d'élément d'association est autorisée par données utiles. Il contient un ou plusieurs éléments d'association.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple

Contenu de l'élément
Contient un ou plusieurs éléments d'association.

élément d'association
Nom du marqueur		association
Description		Indique l'association à créer/mettre à jour pour la liste des entités.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
type	y	Type d'entité pour laquelle l'association doit être créée/mise à jour. Il peut prendre uniquement les valeurs suivantes : level customdimension	level
opération	N	Le mode de fonctionnement de cette association. Seules les valeurs suivantes sont prises en charge : (mettre à jour ou remplacer tout) Si Operation="replaceAll", toutes les entrées de participations existantes pour ce type d'association seront supprimées et seules les données de participations indiquées dans la demande seront enregistrées. Si Operation="update", seuls les identifiants de l'entité (par exemple, les identifiants de périmètre) mentionnés dans la demande seront mis à jour. Si l'opération n'est pas mentionnée, le comportement "Mettre à jour" par défaut sera affiché.	mettre à jour
code	Sous conditions	Le code de l'association en cours de création/mise à jour. Le seul cas où elle n'est pas obligatoire est celui de la responsabilité de périmètre. Obligatoire pour tous les autres cas.	TL1
nom	Sous conditions	Le nom de l'association en cours de création/mise à jour. Le seul cas où elle n'est pas obligatoire est celui de la responsabilité de périmètre. Obligatoire pour tous les autres cas.	TestLevels1
dimId	Sous conditions	L'identifiant dont dimValueIds fera l'objet d'une mise à jour du détail de la participation. Obligatoire pour les dimensions personnalisées.	12
Contenu de l'élément
Contient un élément dimValueIds.

dimValueIds element
Nom du marqueur		dimValueIds
Description		Indique la liste de dimValueId.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple

Contenu de l'élément
Contient un ou plusieurs éléments dimValueId.

Élément dimValueId
Nom du marqueur		dimValueId
Description		Spécifie
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de l'entité.	23
Contenu de l'élément
Contient au plus un élément users. Si l'élément users n'est pas mentionné, toute la propriété existante de dmiValueId sera supprimée.

élément users
Nom du marqueur		utilisateur(s)
Description		Indique les identifiants utilisateur dans les éléments Identifiant, Identifiant Workday ou Nom d'utilisateur.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple

Contenu de l'élément
Contient la liste des identifiants utilisateurs séparés par des virgules. Les utilisateurs absents du système seront ignorés. Si aucun identifiant utilisateur n'est mentionné, toutes les participations existantes dans l'entité (dimValueId) seront supprimées. Si le même marqueur d'identifiant est fourni plusieurs fois dans un marqueur d'utilisateurs particulier, l'appel renverra une condition d'erreur. <id> 1, 2, 3 <id> : indique que la propriété doit être attribuée aux utilisateurs avec les identifiants 1, 2 et 3. <nom d'utilisateur>][ Nouvelles personnel <WID> ABC, CSD <WID> : indique que la propriété doit être attribuée aux utilisateurs avec les identifiants Workday ABC et CSD.

Format de la réponse


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <messages>
     <message type="INFO">Associations were saved successfully.</message>
 </messages>
</response>

Élément de la réponse
Nom du marqueur		réponse
Description		Spécifie
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.	vrai
Contenu de l'élément
Un seul élément de messages facultatifs.

Élément de message
Nom du marqueur		messages
Description		Conteneur pour un ou plusieurs éléments de message
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple

Contenu de l'élément
Contient 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 avec des demandes qui ont échoué, et pour les messages de confirmation sur les réussites.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
type	N	Indique le type du message.	AVERTISSEMENT D'ERREUR INFO
Contenu de l'élément

Descriptions des messages d'erreur

Type	Message	Exemple/Description
Erreur	erreur : élément "Y" incomplet; élément obligatoire manquant "Y"	Il manque l'élément obligatoire dans la demande - par exemple, l'association dimValueId
Erreur	la valeur de l'attribut "type" n'est pas valide ; doit être égal à "périmètre"	L'association est associée à un type incorrect.
Erreur	DimValueId doit inclure au maximum un élément users.	L'élément dimValueId doit inclure au maximum un élément users.
Avertissement	Code utilisateur -5 absent du système. Identifiant Workday -98A absent du système. Identifiant du nom d'utilisateur Stevec@comp absent du système.	Les valeurs de l'identifiant utilisateur sont incorrectes. Elles ont été ignorées et les utilisateurs valides restants ont été traités.
Erreur	Code dimValue - 123 absent du système.	Le code de la valeur de dimension est incorrect.