updateAssociations

Adaptive Planning

updateAssociations

Categoria	Modifica dei metadati
Descrizione	Aggiornare la proprietà/associazione per le entità (ad es. Livello). È possibile aggiornare più associazioni con più valori in un'unica chiamata. In caso di esito positivo, l'API restituisce un messaggio di esito positivo. Se l'API non riesce, viene restituito un elenco completo degli errori e delle relative cause.
Autorizzazioni necessarie per richiamare	Model Management: Model Management Model: Organization Structure: All Levels Admin Access: Users
Parametri obbligatori su richiesta	Credenziali

Consultare Concetto: Associazioni e Importare associazioni.

Le seguenti condizioni si applicano alle updateAssociations:

Ogni associazione ha un tipo, un'operazione facoltativa e un insieme di ID valore dim (ID entità).

Per creare una nuova associazione, specificare l'ID entità (ad es. ID livello) a cui si desidera assegnare la proprietà e l'elenco degli ID utente (id, WID o nome utente).

Per un'associazione, se lo stesso ID entità viene menzionato più volte, viene utilizzato l'ultimo.

Gli utenti specificati nella richiesta ma non presenti nel sistema verranno ignorati. Gli utenti validi rimanenti nella richiesta verranno elaborati e i dettagli dell'associazione verranno aggiornati.

Per le associazioni di dimensioni personalizzate, i campi code, name e dimId sono obbligatori.

La richiesta può contenere zero o una sola associazione per la proprietà del livello. Qualsiasi altra associazione di livello richiede i campi aggiuntivi code, name e dimId.

Formato richiesta


<?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>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
impostazioni internazionali	N	Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).	fr_FR
instanceCode	N	Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning, questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

elemento associazioni
Nome tag		associazioni
Descrizione		È consentita una sola richiesta di elemento di associazione per payload. Contiene uno o più elementi di associazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio

Contenuto dell'elemento
Contiene uno o più elementi di associazione.

elemento di associazione
Nome tag		associazione
Descrizione		Specifica l'associazione da creare/aggiornare per l'elenco di entità.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
type	y	Il tipo dell'entità per la quale si desidera creare/aggiornare l'associazione. Può assumere solo i seguenti valori: level customdimension	level
operazione	N	La modalità operativa per questa associazione. Può accettare solo questi valori - (update or replaceAll) Se operation="replaceAll", tutte le voci di proprietà esistenti per quel tipo di associazione verranno eliminate e verranno salvati solo i dettagli di proprietà menzionati nella richiesta. Se operation="update", verranno aggiornati solo gli ID entità (ad es. ID livello) menzionati nella richiesta. Se l'operazione non è menzionata, verrà impostato automaticamente il comportamento di "aggiornamento".	aggiorna
codice	In modo condizionale	Il codice dell'associazione da creare/aggiornare. L'unico caso in cui non è obbligatorio è la proprietà del livello. Obbligatorio per tutti gli altri casi.	TL1
nome	In modo condizionale	Il nome dell'associazione da creare/aggiornare. L'unico caso in cui non è obbligatorio è la proprietà del livello. Obbligatorio per tutti gli altri casi.	TestLevels1
dimId	In modo condizionale	ID per cui dimValueIds avrà i dettagli di proprietà aggiornati. Obbligatorio in caso di dimensione personalizzata.	12
Contenuto dell'elemento
Contiene un elemento dimValueIds.

dimValueIds element
Nome tag		dimValueIds
Descrizione		Specifica l'elenco di dimValueId.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio

Contenuto dell'elemento
Contiene uno o più elementi dimValueId.

dimValueId element
Nome tag		dimValueId
Descrizione		Specifica
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per l'entità.	23
Contenuto dell'elemento
Contiene al massimo un elemento users. Se l'elemento users non viene menzionato, tutta la proprietà esistente per dmiValueId verrà rimossa.

elemento users
Nome tag		utenti
Descrizione		Specifica gli ID utente negli elementi ID, WID o username.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio

Contenuto dell'elemento
Contiene l'elenco degli ID utente separati da virgole. Gli utenti non presenti nel sistema verranno ignorati/ignorati. Se nessuno degli ID utente viene menzionato, tutta la proprietà esistente per l'entità (dimValueId) verrà rimossa. Se lo stesso tag identificativo viene specificato più volte in un determinato tag utente, la chiamata restituirà una condizione di errore. <id> 1, 2, 3 </id> : specifica che la proprietà deve essere assegnata agli utenti con ID 1, 2 e 3. <username>johno@greenco.com</username> : specifica che la proprietà deve essere assegnata all'utente con nome utente johno@greenco.com . <WID> ABC, CSD </WID> : specifica che la proprietà deve essere assegnata agli utenti con ID Workday ABC e CSD.

Formato risposta


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

Elemento di risposta
Nome tag		risposta
Descrizione		Specifica
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	"True" o "false", che indica se la chiamata API è stata eseguita correttamente o meno.	true
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo.

Elemento Messaggi
Nome tag		messaggi
Descrizione		Contenitore per uno o più elementi del messaggio
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio

Contenuto dell'elemento
Contiene uno o più elementi del messaggio.

Elemento messaggio
Nome tag		messaggio
Descrizione		Rappresenta un messaggio inviato dal sistema al chiamante. I messaggi vengono utilizzati per i messaggi di errore con richieste non riuscite e per i messaggi di conferma in caso di esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
type	N	Specifica il tipo di messaggio.	AVVISO ERRORE INFO
Contenuto dell'elemento

Descrizioni dei messaggi di errore

Tipo	Messaggio	Esempio/Descrizione
Errore	errore: elemento "Y" incompleto; elemento obbligatorio "Y" mancante	Nella richiesta manca l'elemento obbligatorio, ad esempio associazione, dimValueId
Errore	il valore dell'attributo "type" non è valido; deve essere uguale a "livello"	All'associazione è associato un tipo non corretto.
Errore	DimValueId può avere al massimo un elemento utenti.	L'oggetto dimValueId può avere al massimo un elemento users.
Avviso	ID utente -5 non presente nel sistema. WID -98A non presente nel sistema. ID nome utente stevec@comp non presente nel sistema.	I valori dell'ID utente non sono corretti. Sono stati ignorati e gli utenti validi rimanenti sono stati elaborati.
Errore	DimValue Id -123 non presente nel sistema.	L'ID valore dim non è corretto.