exportCalendar

Questa API è supportata nell'API v33+.

Aggiornato nell'API v40 (21 settembre 2024).

Categoria	Recupero dei metadati
Descrizione	Restituisce i metadati del calendario.
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. Una volta verificato il chiamante, il metodo restituisce un documento XML che descrive l'elenco completo delle informazioni del calendario.

Formato richiesta

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportCalendar" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
</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
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>
<calendars>
  <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" />
</calendars>
</output>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	"True" o "false", che indica se la chiamata API è stata eseguita correttamente o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
Contenuto dell'elemento
Esattamente un elemento di output obbligatorio.

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

elemento calendari
Nome tag		calendari
Descrizione		Contenitore per uno o più elementi dei calendari.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi del calendario.

elemento di calendario
Nome tag		calendario
Descrizione		Rappresenta un calendario.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Contiene l'identificatore intero specifico del calendario specifico.	1
isDefault	S	"Vero" o "falso", indicando se il calendario specifico è il calendario predefinito.	true
nome	S	Contiene il nome del calendario.	DefaultTimeHierarchy
codice Disponibile nell'API v40+	N	Contiene il codice calendario quando sono presenti i codici calendario.	DefaultTimeHierarchy
Contenuto dell'elemento
(nessuno)