updateAssociations

Adaptive Planning

updateAssociations

Catégorie	Modification de métadonnées
Description	Mettez à jour la propriété/association des entités (par exemple, Niveau). Plusieurs associations avec plusieurs valeurs peuvent être mises à jour en un seul appel. En cas de réussite, l’API renvoie un message de réussite. Si l’API échoue, une liste complète des erreurs et leurs causes sont retournées.
Autorisations obligatoires pour pouvoir être appelées	Gestion du modèle : Gestion du modèle modèle : Structure d’organisation : Accès administrateur de tous les niveaux : Utilisateurs
Paramètres requis sur demande	Identifiants

Voir : Concept : associations Et Importer les associations.

Les conditions suivantes s’appliquent à la mise à jour des Associations :

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

Pour créer une nouvelle association, précisez l’identifiant de l’entité (par exemple, l’identifiant de niveau) à laquelle nous souhaitez attribuer la propriété et la liste des identifiants utilisateur (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 précisés dans la demande, mais absents du système, seront ignorés. Les utilisateurs valides restants dans la demande seront traités et les détails de leur association seront mis à jour.

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

La demande peut contenir zéro ou une seule association pour la propriété de niveau. Toute autre association de niveau nécessite les champs supplémentaires de code, de nom et de 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 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 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 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 l’API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

élément des associations
Nom du marqueur		associations
Description		Une seule demande d'élément d'associations est autorisée par charge utile. 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 d’entités.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
type	y	Le type d’entité pour lequel l’association doit être créée/mise à jour. Elle peut uniquement prendre les valeurs suivantes : niveau customdimension	niveau
opération	N	Le mode opérationnel pour cette association. Il peut prendre uniquement les valeurs suivantes - (mettez à jour ou remplacez Tout) Si Operation="replaceAll", toutes les entrées de participation existantes pour ce type d’association seront supprimées et seuls les détails de participation indiqués dans la demande seront enregistrés. Si Operation="update", seuls les identifiants d’entités (par exemple, les identifiants de niveaux) indiqués dans la demande seront mis à jour. Si l'opération n'est pas mentionnée, elle définira par défaut le comportement de type "Mettre à jour".	mettre à jour
code	Conditionnellement	Le code de l’association à créer/mettre à jour. Le seul cas où elle n’est pas obligatoire est dans le cas de l’appropriation d’un niveau. Obligatoire pour tous les autres cas.	TL1
nom	Conditionnellement	Le nom de l'association à créer/mettre à jour. Le seul cas où elle n’est pas obligatoire est dans le cas de l’appropriation d’un niveau. Obligatoire pour tous les autres cas.	TestLevels1
dimId	Conditionnellement	L'identifiant pour lequel dimValueIds verra les détails de propriété mis à jour. Obligatoire en cas de dimension personnalisée.	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		Précise
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d’identifiant de 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 retirée.

élément users
Nom du marqueur		utilisateurs
Description		Indique les identifiants utilisateur dans les éléments de l’identifiant, de l’identifiant Workday ou du 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 utilisateur séparés par des virgules. Les utilisateurs absents du système seront ignorés/omis. Si aucun des identifiants utilisateur n’est mentionné, tous les éléments de propriété existants pour l’entité (dimValueId) seront retirés. 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 ayant des identifiants 1, 2 et 3. <username> entrées de Johno@greenco.com<username> : Cela précise que la propriété doit être attribuée à l'utilisateur dont le nom d'utilisateur Régimey de notaire avec le nom d'utilisateur apparaîtra. <WID> ABC, CSD }<WID> : Cela précise que la propriété doit être accordée aux utilisateurs ayant un identifiant Workday ABC et CSD.

Format de 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 réponse
Nom du marqueur		réponse
Description		Précise
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	"true" ou "false", indiquant si l'appel d'API a réussi ou non.	vrai
Contenu de l'élément
Un seul élément de message facultatif.

Élément de messages
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 renvoyé par le système à l’appelant. Les messages sont utilisés pour les messages d’erreur indiquant un échec des demandes et pour les messages de confirmation en cas de réussite.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
type	N	Indique le type du message.	AVERTISSEMENT D'ERREUR INFORMATION
Contenu de l'élément

Descriptions du message d'erreur

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