exportSheets

Categoria	Recupero dei metadati
Descrizione	Restituisce l'elenco completo di tutti i fogli definiti per l'istanza specificata. Sono inclusi i fogli "incompleti" e i fogli assegnati agli utenti.
Autorizzazioni necessarie per richiamare	IMP (importazione dati) o MOD (creazione, modifica ed eliminazione di fogli)
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 fogli trovati nell'istanza dell'utente.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheets" 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 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)

Formato risposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
    <sheets>
      <modeled-sheet id="1" name="Personnel" prefix="Personnel" description="Personnel Sheet" />
      <modeled-sheet id="2" name="Crossover Personnel" prefix="Crossovers" description="Personnel Sheet" />
      <modeled-sheet id="3" name="Sales" prefix="Sales" description="Sales Sheet" />
      ...
      <standard-sheet id="6" name="Model Summary" prefix="" description="Configurable Model Summary Sheet" />
      <standard-sheet id="8" name="Expenses" prefix="" description="" />
      <standard-sheet id="9" name="Balance" prefix="" description="" />
      <standard-sheet id="10" name="Assumptions" prefix="" description="" />
      ...
      <cube-sheet id="17" name="Expense Cube" prefix="ExpenseCube" description="" />
      <cube-sheet id="19" name="Sale Cube" prefix="SalesCube" description="" />
    </sheets>
  </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 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
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Un singolo elemento di fogli cubo obbligatorio. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento fogli
Nome tag		foglio
Descrizione		Contenitore per uno o più elementi di fogli standard, fogli modellati e fogli cubo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi foglio standard, foglio modellato e foglio cubo.

elemento di foglio standard
Nome tag		foglio standard
Descrizione		Rappresenta un singolo foglio standard restituito nella risposta a una chiamata API exportSheets.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per il foglio. Può essere utilizzato per identificare i fogli in altre chiamate API, ad esempio exportSheetDefinition.	123
prefisso	S	Il prefisso del foglio. Per i fogli standard, è sempre vuoto. Altri tipi di foglio hanno valori non vuoti per questo attributo.
nome	S	Il nome del foglio.	Modalità di rollup
descrizione	N	La descrizione testuale del foglio, se presente.	Queste sono le modalità di rollup...
Contenuto dell'elemento
(nessuno)

elemento di foglio modellato
Nome tag		foglio modellato
Descrizione		Rappresenta un singolo foglio modellato restituito nella risposta a una chiamata all'API exportSheets.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per il foglio. Può essere utilizzato per identificare i fogli in altre chiamate API, ad esempio exportSheetDefinition.	234
prefisso (API v38 e precedenti) codice (API v39+)	S	API v38: il prefisso del foglio. API v39: il codice del foglio.	Capitale
nome	S	Il nome del foglio.	Modello capitale
descrizione	N	La descrizione testuale del foglio, se presente.	Questo è il modello capitale...
Contenuto dell'elemento
(nessuno)

elemento cubo-sheet
Nome tag		foglio cubo
Descrizione		Rappresenta un singolo foglio cubo restituito nella risposta a una chiamata API exportSheets.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID		Il numero ID di sistema interno per il foglio. Può essere utilizzato per identificare i fogli in altre chiamate API, ad esempio exportSheetDefinition.	34
prefisso		Il prefisso del foglio.	ExpenseCube
nome		Il nome del foglio.	Cubo di spesa
descrizione		La descrizione testuale del foglio, se presente.

Contenuto dell'elemento

(nessuno)