exportInstances

Categoria	Metadata retrieval.
Descrizione	Restituisce i metadati per l'elenco completo di tutte le istanze di Adaptive Planning a cui l'utente ha accesso.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante e un tag di inclusione facoltativo per indicare quali istanze includere nella risposta. Una volta verificate le credenziali dell'utente, il metodo restituisce un documento XML che descrive l'istanza specificata nelle credenziali o l'insieme completo di tutte le istanze a cui l'utente ha accesso. Se la funzionalità Istanze multiple non è stata acquistata, la chiamata restituisce sempre un singolo elemento per l'istanza a cui appartiene l'utente.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportInstances" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <include accessibleInstances="true"/>
</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 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 include
Nome tag		includere
Descrizione		Rappresenta un insieme di flag che indicano quali aspetti delle informazioni delle istanze devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, il valore predefinito è false per accessInstances.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accessibleInstances	N	Vero o falso. Se la risposta deve includere altre istanze oltre alla singola istanza specificata nelle credenziali Il valore predefinito, se l'elemento o il relativo attributo non è presente, è false. Se incluso ed è vero, l'API deve restituire l'elenco di tutte le istanze a cui l'utente ha accesso. Queste istanze non vengono restituite in modo nidificato o con indicazione padre; vengono semplicemente enumerati con le proprietà mostrate nell'API. La prima istanza restituita è sempre l'istanza predefinita per l'utente.	Falso
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
  <instances>
    <instance code="INSTANCE1" name="Globo Industries" sessionTimeout="60" calendarType="G" systemCurrency="USD" products="PLANNING,DISCOVERY" options="TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA" workdayTenantID="mytenant" workdayEnvironment="Prod" workdayUiUrl="www.myworkday.com/mytenant/d/home.html" workdayRestUrl="www.myworkday.com/ccx/service/" datasources="WORKDAY,GREAT PLAINS,INTACCT,SALESFORCE,NETSUITE" notificationType="NONE"/>
  </instances>
</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
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. 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 istanze
Nome tag	istanze
Descrizione	Contenitore per uno o più elementi di istanza.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi di istanza.

elemento istanza
Nome tag		istanza
Descrizione		Descrive una singola istanza a cui l'utente ha accesso, inclusi alcuni attributi di tale istanza.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Il codice istanza dell'istanza. Può essere utilizzato per specificare un'istanza alternativa per una chiamata API all'interno dell'elemento credenziali.	INSTANCE1
nome	S	Il nome dell'istanza. La configurazione viene eseguita in Amministrazione > Configurazione generale per l'istanza.	Globo Industries
sessionTimeout	S	Timeout in minuti della sessione utente.	60
systemCurrency	S	Il codice ISO per la valuta di sistema.	USD
prodotti	S	Elenco separato da virgole di nomi di prodotti abilitati per l'istanza.	PIANIFICAZIONE,CONSOLIDAMENTO,DISCOVERY, INTEGRAZIONE
opzioni	S	Elenco separato da virgole dei vari moduli abilitati per l'istanza.	TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA
origini dati	S	Elenco separato da virgole di origini dati abilitate per l'istanza.	WORKDAY, NETSUITE, SALES FORCE
workdayTenantID disponibile nell'API v20+	N	L'ID o il nome del tenant di Workday che identifica il tenant in modo univoco. Richiede la configurazione di Adaptive Planning per Workday, abilitata dal provisioning.	tenant
workdayEnvironment disponibile nell'API v20+	N	Ambiente Workday come Prod (produzione), Sandbox (sandbox) o Impl (implementazione). Richiede la configurazione di Adaptive Planning per Workday, abilitata dal provisioning.	Prod
workdayUiUrl disponibile nell'API v20+	N	Il nome di dominio dell'URL dell'interfaccia utente Workday per il tenant Workday. Richiede la configurazione di Adaptive Planning per Workday, abilitata dal provisioning.	www.myworkday.com/mytenant/d/home.html
workdayRestUrl disponibile nell'API v20+	N	Il nome di dominio dell'URL REST per il tenant Workday. Richiede la configurazione di Adaptive Planning per Workday, abilitata dal provisioning.	www.myworkday.com/ccx/service/
notificationType disponibile nell'API v24+	N	Il tipo di notifica per il tenant Workday. Richiede la configurazione di Adaptive Planning per Workday, abilitata dal provisioning.	NESSUNO
Contenuto dell'elemento
(nessuno)