importGroups

Categoria	Modifica dei metadati
Descrizione	Importare i gruppi di utenti creati nel sistema principale o in un sistema esterno. In caso di esito positivo, l'API restituisce i dettagli per i gruppi importati. Non è possibile utilizzare questa API per aggiornare i gruppi di utenti creati nell'interfaccia utente di Adaptive Planning.
Autorizzazioni necessarie per richiamare	Autorizzazione Gestione gruppi utenti globali
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. Per importare i gruppi di utenti, l'utente deve disporre dell'autorizzazione

Accesso come amministratore

per la gestione dei gruppi di utenti

Formato richiesta

<?xml version='1.0' encoding='UTF-8'?>
<call method="importGroups" callerName="a string that identifies your client application"
dataSource="WORKDAY/EXTERNAL" mode="REPLACE_ALL/UPDATE" userIdentifier="userName/userGUID/wid">
  <credentials login="sampleuser@company.com" password="my_pwd" />
    <groups>
        <group
          externalID="userGroup_ID_1"
          name="new user group"
           >
          <users>
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2E"
                  userName="user1"
                  wid="A9ADBCB81AA2F9BAE040307F02092C2E" />
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2F"
                   userName="user3"
                   wid="A9ADBCB81AA2F9BAE040307F02092C2F" />
          </users>
        </group>
     </groups>
</call>

Attributi query

Nome	Descrizione	Obbligatorio
dataSource	L'origine dei dati dei gruppi di utenti: WORKDAY L'origine dei dati dei gruppi di utenti è Workday. Questi gruppi non possono essere modificati in Adaptive Planning. EXTERNAL. L'origine dei dati dei gruppi di utenti è qualsiasi altro sistema esterno a Workday. Dalla pagina Configurazione generale, l'amministratore può abilitare la modifica dei gruppi con un'origine dati EXTERNAL. È quindi possibile aggiornare questi gruppi utilizzando l'interfaccia utente di Adaptive Planning. Consultare Riferimenti: Configurazione generale.	S
modalità	La modalità per la chiamata API: REPLACE_ALL. La modalità sostituisce tutti i gruppi di utenti nell'istanza di Adaptive Planning con i gruppi di utenti specificati nel payload. AGGIORNAMENTO. La modalità aggiorna solo i gruppi di utenti specificati nel payload.	S
userIdentifier	L'identificatore per gli utenti specificati nei gruppi di utenti: userName. Il nome utente per l'utente specificato. userGUID. L'ID utente globale per l'utente specificato. wid L'ID Workday per l'utente specificato.	S

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 mostra che l'azione è stata eseguita dall'utente. Pertanto, l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API abbia 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. Inoltre, per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei periodi di tempo e la formattazione della data appropriati). Le impostazioni internazionali specificano anche 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ù di un'istanza di Adaptive Planning, questo attributo può specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, viene utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
Nessuno

elemento di gruppo
Nome tag		gruppo
Descrizione		Specifica un insieme di gruppi di utenti da creare o aggiornare.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
externalID	S	L'identificatore esterno del gruppo di utenti.	user_group_1
nome	S	Il nome del gruppo di utenti.	Security Admins
Contenuto dell'elemento
Elemento Users

elemento utente
Nome tag		utente
Descrizione		Specifica uno o più utenti da aggiungere al gruppo di utenti.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
userGUID	S (a condizione che l'ID utente specificato dal chiamante API sia userGUID)	L'identificatore globale dell'utente.	B9ADBCB81AA2F9BAE040307F02092C2
userName	S (a condizione che l'ID utente specificato dal chiamante API sia userName)	Il nome utente dell'utente.	updateMail@company.com
wid	S (a condizione che l'ID utente specificato dal chiamante API sia wid)	L'ID Workday dell'utente.	A9ADBCB81AA2F9BAE040307F02092C2E
Contenuto dell'elemento
In caso di utente non valido (ad es. userGUID/userName/wid non validi), l'utente non valido verrà ignorato e la richiesta verrà elaborata per il gruppo per gli altri utenti validi. Tuttavia, per i seguenti scenari correlati all'elemento <user>, l'intero gruppo verrà rifiutato nel payload. ID utente mancante: <user/> <user userName=""/> <user userName/userGUID/wid=" "/> Messaggio di errore; Identificativo utente mancante. Specificare un userName/userGUID/wid valido per tutti gli utenti. Formato WID non valido: Lunghezza di WID inferiore o superiore a 32 caratteri. Messaggio di errore: specificare un userWID valido per tutti gli utenti. userGUID formato non valido: Lunghezza di userGUID inferiore o superiore a 32 caratteri. userGUID non è alfanumerico. Messaggio di errore: specificare un userGUID valido per tutti gli utenti.

Formato risposta

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
      <result>
          <imported_groups>
              <group success="true" externalID="ID_1" id="33" name="New Group 1" />
          </imported_groups>
      </result>
  </output>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
Contenuto dell'elemento
A seconda che sia stata effettuata la chiamata create o update, un singolo elemento risultato con elementi di stato create_usergroup o update_usergroup.

import_groups
Nome tag		import_groups
Nome attributo	Obbligatorio?	Valore	Esempio
successo del gruppo	S	Lo stato restituito, vero o falso.	"vero"
messaggio	S	Il messaggio di stato	"Il nuovo gruppo di utenti è stato creato correttamente." "Il payload è stato parzialmente cancellato dalle iscrizioni degli utenti. Riprovare e, se il problema persiste, contattare l'assistenza."
Contenuto dell'elemento
Nessuno.