exportRoles

Non supportato nell'API v25+. Utilizzare exportPermissionSets.

Categoria	Recupero dei metadati
Descrizione	Restituisce i metadati per l'elenco completo di tutti i ruoli nell'istanza.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene solo un tag di credenziali per identificare e autorizzare l'utente chiamante. Una volta verificato, il metodo restituisce un documento XML che descrive l'insieme completo di tutti i ruoli trovati nell'istanza dell'utente.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportRoles" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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é l'API chiamata per ottenere l'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 di un ruolo contenente le autorizzazioni necessarie per il metodo richiamato.	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)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <roles>
     <role id="1" name="Standard" permissions="SHT,RPT,SCOREBOARD"/>
     <role id="2" name="Administrative" permissions="SHT,RPT,SCOREBOARD,SAL,MOD,IMP,EXP"/>
   </roles>
 </output>
</response>

I ruoli e le autorizzazioni sono ordinati per nome.

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
obsoleto	N	Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta da Adaptive Planning . Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.	falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di conti. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento ruoli
Nome tag	ruoli
Descrizione	Contenitore per uno o più elementi del ruolo.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi del ruolo.

elemento ruolo
Nome tag		ruolo
Descrizione		Descrive un singolo ruolo disponibile nell'istanza.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID sistema interno per il ruolo. Viene utilizzato per identificare il ruolo assegnato a un utente nella chiamata API exportUsers.	1
nome	S	Il nome del ruolo, come mostrato in Amministrazione ruolo.	Standard
autorizzazioni	S	Un elenco di codici separati da virgole per le autorizzazioni assegnate a questo ruolo. I codici sono abbreviazioni interne come "SHT" per Sheet Access e "RPT" per Report Access.	SHT,RPT,SCOREBOARD
Contenuto dell'elemento
(nessuno)