exportSheetDefinition

Formato richiesta foglio modellato


 <?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <modeled-sheet id="3"/>
   </call>

L'elemento call contiene un elemento credenziali e un singolo foglio modellato.

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 di foglio modellato
Nome tag		foglio modellato
Descrizione		Identifica un singolo foglio modellato richiesto tramite una chiamata API exportSheetDefinition.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per il foglio.	234
displayNameEnabled Disponibile solo nell'API v31+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che exportSheetDefinition deve rispettare le proprietà del nome visualizzato di code , displayNameType e description quando Abilita nome visualizzato è attivo per l'istanza. displayNameEnabled=false indica che l'API exportSheetDefinition deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API exportSheetDefinition ignora le proprietà code , displayNameType e description . Il valore predefinito per displayNameEnabled è "false".	falso
Contenuto dell'elemento
(nessuno)

Formato risposta foglio modellato


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <output>
       <modeled-sheet id="11" prefix="Personnel" name="Personnel" description="Personnel Sheet"
                              available-in-actuals="false" allow-splits="true" split-column-title="Is Split Child Row" strataId="51">
           <columns>
               <levels code="Plan" name="Plan" read-only="false" splittable="false" required="true">
                   <level id="1" />
                   <level id="7" />
               </levels>
               <text code="LastName" name="Last Name" read-only="false" splittable="false" required="false" />
               <text code="FirstName" name="First Name" read-only="false" splittable="false" required="false" />
               <text code="ID" name="ID" read-only="false" splittable="false" required="false" />
               <dimension code="JobCode" name="JobCode" read-only="false" splittable="false" required="false" id="9">
                   <value id="19" name="E1" />
                   <value id="20" name="E2" />
                   <value id="21" name="E3" />
               </dimension>
               <text-selector code="BenefitsSelector" name="Benefits" read-only="false" splittable="false" required="true" id="27">
                   <value id="208" name="No" />
                   <value id="209" name="Yes" />
               </text-selector>
               <date code="StartDate" name="Start" read-only="false" splittable="false" required="false" />
               <date code="EndDate" name="End" read-only="false" splittable="false" required="false" />
               <number code="HoursPerWeek" name="Hr/Week" read-only="false" splittable="false" required="false" />
               <text-selector code="per" name="per" read-only="false" splittable="false" required="true" id="28">
                   <value id="210" name="Yr" />
                   <value id="211" name="Hr" />
               </text-selector>
               <initial-balance code="PayRate" name="Pay Rate" read-only="false" splittable="false" required="false" id="143" />
               <display code="PayRate" name="Pay Rate Display Column" read-only="true" splittable="false" required="false" id="7" />
               <level-currency code="" name="Currency" read-only="true" splittable="false" required="false" id="8" />
           </columns>
       </modeled-sheet>
   </output>
</response>

L'elemento del foglio modellato contiene una singola colonna figlio che ne contiene una o più nell'ordine definito per il foglio:

livelli

dimensione

selettore di testo

testo

numero

date

saldo iniziale

level-currency

display

periodo

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 foglio modellato
Nome tag		foglio modellato
Descrizione		Rappresenta un singolo foglio modellato restituito nella risposta a una chiamata all'API export-sheets.
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	S	Il prefisso del foglio.	Capitale
nome	S	Il nome del foglio.	Modello capitale
disponibili in importi effettivi	S	Può essere vero o falso. Indica se il foglio modellato è disponibile o meno nella versione importi effettivi.	true
descrizione	N	La descrizione testuale del foglio, se presente.	Questo è il modello capitale...
allow-split	S	Vero significa che il foglio modellato consente le suddivisioni.	true
split-column-title	N	Il titolo della colonna aggiuntivo per l'importazione quando sono abilitate le suddivisioni consentite. Utilizzare una stringa localizzata se nella richiesta sono specificate le impostazioni internazionali. Questo attributo è presente solo quando allow-splits è impostato su true e almeno una colonna è frazionabile.	Riga figlio suddivisione
strataId	S	L'ID strati associato al foglio modellato	2
Contenuto dell'elemento
Un singolo elemento colonne.

elemento colonne
Nome tag		colonne
Descrizione		Contenitore per uno o più elementi colonna.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più dei seguenti elementi, ordinati come appaiono nel foglio: livelli dimensione selettore di testo testo numero date saldo iniziale level-currency display periodo

elemento livelli
Nome tag		livelli
Descrizione		Rappresenta la colonna "livello" in un foglio modellato. Contenitore per uno o più elementi di livello.
Attributi dell'elemento
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	true
Contenuto dell'elemento
Uno o più elementi di livello.

elemento livello
Nome tag		level
Descrizione		Uno dei livelli definiti per l'azienda presente nel foglio (o in cui è stato inserito il foglio). I metadati del livello, inclusa la struttura gerarchica, possono essere ottenuti chiamando exportLevels.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il livello.	42
Contenuto dell'elemento
(nessuno)

elemento di testo
Nome tag		testo
Descrizione		Rappresenta una colonna del foglio che contiene il testo immesso dall'utente.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
Contenuto dell'elemento
(nessuno)

elemento dimensione
Nome tag		dimensione
Descrizione		Una delle dimensioni definite per l'azienda. Rappresenta una colonna del foglio che contiene la dimensione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
Contenuto dell'elemento
Uno o più elementi valore, ognuno dei quali è un valore selezionabile valido nella dimensione del foglio. Se un valore della dimensione non è incluso qui, tale valore non può essere utilizzato nelle righe di dati del foglio.

elemento valore
Nome tag		valore
Descrizione		Uno dei valori definiti per questa dimensione o per il selettore di testo. I metadati delle dimensioni completi, inclusa la relativa struttura gerarchica, possono essere ottenuti tramite una chiamata separata a exportDimensions.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il valore.	42
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice per il valore membro della dimensione, se presente, immesso in Amministrazione dimensione.	Messico
nome	S	Rappresentazione stampata del valore.	Messico
displayName Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il nome visualizzato del valore membro, come derivato da displayNameType.	Messico
Contenuto dell'elemento
(nessuno)

elemento text-selector
Nome tag		selettore di testo
Descrizione		Elenco personalizzato di valori definito per questo foglio. Rappresenta una colonna del selettore di testo in un foglio modellato.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	true
ID	S	Identificatore numerico interno.	42
Contenuto dell'elemento
Uno o più elementi valore.

elemento numerico
Nome tag		numero
Descrizione		Rappresenta una colonna del foglio che contiene un numero immesso dall'utente.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
Contenuto dell'elemento
(nessuno)

elemento data
Nome tag		date
Descrizione		Rappresenta una colonna del foglio che contiene una data immessa dall'utente.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
Contenuto dell'elemento
(nessuno)

elemento di saldo iniziale
Nome tag		saldo iniziale
Descrizione		Rappresenta una colonna del foglio che contiene un valore fornito dall'utente per il saldo iniziale di un conto con una formula che determina la variazione mensile del valore del conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
ID	S	Identificatore numerico interno del conto associato a questa colonna.	42
Contenuto dell'elemento
(nessuno)

elemento level-currency
Nome tag		level-currency
Descrizione		Rappresenta una colonna del foglio che visualizza il codice della valuta associato a ogni riga. Questa è la valuta del livello in cui si trova la riga.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna. Per gli elementi di valuta livello, questo valore è sempre vero.	true
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
ID	S	Identificatore numerico interno.	42
Contenuto dell'elemento
(nessuno)

elemento di visualizzazione
Nome tag		display
Descrizione		Rappresenta una colonna del foglio che contiene un calcolo di sola lettura basato su riga.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
ID	S	Identificatore numerico interno.	42
Contenuto dell'elemento
(nessuno)

elemento timespan
Nome tag		periodo
Descrizione		Al massimo una per foglio, rappresenta un insieme di colonne di un intervallo di tempo, che vengono visualizzate a destra del foglio e possono contenere dati periodici.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore simbolico per la colonna, utilizzato nelle formule e nei riferimenti del foglio.	MyColumn
nome	S	Titolo visualizzabile della colonna, come mostrato nel foglio.	Mia colonna
di sola lettura	S	True se la colonna è contrassegnata come di sola lettura nel foglio, false se è possibile immettere valori nella colonna.	falso
splittable	S	Vero se le suddivisioni di righe possono avere valori diversi per questa colonna, falso se le suddivisioni devono avere lo stesso valore del padre.	true
obbligatorio	S	Vero se questo attributo è un campo obbligatorio.	falso
ID	S	Identificatore numerico interno del conto associato a questo intervallo di tempo.	42
Contenuto dell'elemento
(nessuno)

Formato richiesta foglio cubo


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
     <credentials login="sampleuser@company.com" password="my_pwd"/>
     <cube-sheet id="4"/>
   </call>

L'elemento call contiene un elemento credenziali e un singolo foglio cubo.

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 set di autorizzazioni 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)

elemento cubo-sheet
Nome tag		foglio cubo
Descrizione		Identifica un singolo foglio cubo richiesto tramite una chiamata API exportSheetDefinition.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per il foglio.	234
Contenuto dell'elemento
(nessuno)

Formato risposta foglio cubo


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
    <output>
        <cube-sheet id="24" prefix="SummaryCube" name="Summary Cube" isGlobal="0" description="" strataId="1" horizontalAxis="-3" verticalAxis="-2" maxColumnWidth="0" suppressZeroRows="0" rearrangeGLAndCustomAccounts="0" hideRollupTotals="0">
            <dimensions>
                <dimension id="3" uncategorized="false" rollup="false" name="Company" newValueBehavior="parent" editableOnSheet="false">
                    <value id="35" />
                </dimension>
                <dimension id="4" uncategorized="false" rollup="false" name="CountryRegion" newValueBehavior="parent" editableOnSheet="false">
                    <value id="144" />
                    <value id="133" uncategorized="true" />
                    <value id="133" rollup="true" />
                    <value id="122" rollup="true" />
                    <value id="143" />
                </dimension>
                <levels>
                    <level id="1" />
                    <level id="2" />
                    <level id="8" />
                    <level id="10" />
                    <level id="9" />
                    <level id="5" />
                    <level id="3" />
                    <level id="4" />
                    <level id="11" />
                    <level id="13" />
                    <level id="15" />
                    <level id="16" />
                </levels>
                <accounts>
                    <account id="455" code="" isAssumption="false" />
                    <account id="456" code="" isAssumption="false" />
                    <account id="457" code="SummaryCube.Input" isAssumption="false" />
                    <account id="458" code="SummaryCube.CubeMetric" isAssumption="false" />
                </accounts>
                <time initialBalance="true" visibleTimeStratumCodes="month" />
            </dimensions>
        </cube-sheet>
    </output>
</response>

L'elemento cubo-sheet contiene una singola dimensione figlio che li contiene nell'ordine definito per il foglio:

dimensione (una o più)

attributo (zero o più)

livelli (uno)

conti (uno)

tempo (uno)

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 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.
strataId	S	L'ID strato del foglio.	5
horizontalAxis	S	L'ID della dimensione che deve essere visualizzata sull'asse orizzontale per impostazione predefinita.	-3
verticalAxis	S	L'elenco degli ID dimensione che devono essere visualizzati sull'asse verticale per impostazione predefinita.	-2
maxColumnWidth	S	Larghezza massima in pixel per le colonne (zero se non viene specificato).	20
suppressZeroRows	S	"1" se zero righe sono soppresse, "0" in caso contrario.	suppressZeroRows="0"
riorganizzareGLAndCustomAccounts	S	"1" se il foglio cubo deve utilizzare il trattamento dei conti CoGe, "0" in caso contrario.	rearrangeGLAndCustomAccounts="0"
hideRollupTotals	S	"1" se i totali di rollup devono essere nascosti, "0" in caso contrario.	hideRollupTotals="0"
Contenuto dell'elemento
(nessuno)

elemento dimensioni
Nome tag		dimensioni
Descrizione		Contenitore per le dimensioni del foglio.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più livelli, dimensioni, conti, elementi temporali.

elemento dimensione
Nome tag		dimensione
Descrizione		Una delle dimensioni definite per questo foglio cubo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	L'identificatore numerico interno per la dimensione.	34
non categorizzato	S	Vero significa che l'elemento non categorizzato della dimensione stessa (l'elemento radice non categorizzato) è disponibile come selezione nel cubo.	true
rollup	S	Vero significa che l'elemento di rollup della dimensione stessa (il rollup di tutti gli elementi) è disponibile come selezione nel cubo.	true
nome Disponibile nell'API v22+	S	Nome di questa dimensione.	Articolo prodotto
Contenuto dell'elemento
Uno o più elementi valore, che indicano quali valori dimensione sono disponibili nel foglio.

elemento attributo
Nome tag		attributo
Descrizione		Uno degli attributi inseriti in questo foglio cubo. I metadati degli attributi, inclusa la relativa struttura gerarchica, possono essere ottenuti tramite una chiamata a exportAttributes.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	L'identificatore numerico interno per l'attributo.	34
non categorizzato	S	Vero significa che l'elemento non categorizzato dell'attributo stesso (l'elemento radice non categorizzato) è disponibile come selezione nel cubo.	true
rollup	S	Vero significa che l'elemento di rollup dell'attributo stesso (il rollup di tutti gli elementi) è disponibile come selezione nel cubo.	true
nome Disponibile nell'API v22 +	S	Il nome dell'attributo.	Tipo di negozio
newValueBehavior	S	Comportamento previsto per la disponibilità di nuovi valori dimensione, disponibile, non disponibile o padre.	padre
Contenuto dell'elemento
Uno o più elementi valore, che indicano quali valori dell'attributo sono disponibili nel foglio.

elemento valore
Nome tag		valore
Descrizione		Uno dei valori per questa dimensione contrassegnata come disponibile nel foglio. Lo stesso ID valore può essere visualizzato fino a due volte: con e senza uncategorized impostato su true. I metadati delle dimensioni, inclusa la relativa struttura gerarchica, possono essere ottenuti tramite una chiamata a exportDimensions.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il valore dimensione.	34
rollup	N	true indica il rollup di questo valore dimensione. Consentito solo se il valore contiene valori figlio nella dimensione. Se l'attributo è mancante, viene utilizzato false.	true
non categorizzato	N	true indica il valore non categorizzato di questo valore dimensione. Consentito solo se il valore contiene valori figlio nella dimensione. Se l'attributo è mancante, viene utilizzato false.	true
Contenuto dell'elemento
(nessuno)

elemento livelli
Nome tag		livelli
Descrizione		Contenitore applicato per uno o più elementi di livello. Vengono restituiti i singoli livelli, anche se influiscono solo sulla visibilità. I dati possono essere importati in qualsiasi livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi di livello.

elemento livello
Nome tag		level
Descrizione		Un livello trovato nel foglio, in cui viene visualizzato il foglio. I metadati del livello, inclusa la relativa struttura gerarchica, possono essere ottenuti tramite una chiamata a exportLevels.
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il livello.	12
Contenuto dell'elemento
(nessuno)

elemento conti
Nome tag		conti
Descrizione		Contenitore applicato per uno o più elementi del conto. I conti individuali vengono restituiti, anche se influiscono solo sulla visibilità. I dati possono essere importati in qualsiasi conto di input.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi del conto. Gli elementi del conto disponibili e l'ordine determinati dall'opzione Usa trattamento conti CoGe nelle proprietà del foglio cubo.

elemento conto
Nome tag		account
Descrizione		Uno dei conti definiti per questo foglio cubo. I metadati del conto, inclusa la relativa struttura gerarchica, possono essere ottenuti chiamando exportAccounts.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il conto.	23
codice Disponibile nell'API v22+	N	Il codice conto per il conto.	SalesCubeWithAttribute.Unit_Price
Contenuto dell'elemento
(nessuno)

elemento temporale
Nome tag		time
Descrizione		Dimensione temporale applicata
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
initialBalance	S	Vero se la dimensione temporale ha un valore di saldo iniziale.	"vero"
visibleTimeStratumCodes	N	Elenco di codici strato temporale selezionati in base alla dimensione temporale.	"qtr,month,year"
(nessuno)
Contenuto dell'elemento
(nessuno)

elemento dimensione
Nome tag		dimensione
Descrizione		Una delle dimensioni definite per questo foglio cubo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	L'identificatore numerico interno per la dimensione.	34
non categorizzato	S	Vero significa che l'elemento non categorizzato della dimensione stessa è disponibile come selezione nel cubo.	true
rollup	S	Vero significa che l'elemento di rollup della dimensione stessa (il rollup di tutti gli elementi) è disponibile come selezione nel cubo.	true
nome	S	Nome di questa dimensione.	"Articolo prodotto"
newValueBehavior	S	Comportamento previsto per la disponibilità di nuovi valori dimensione, disponibile, non disponibile o padre.	padre
isEditableOnSheet	N	Flag che indica se la dimensione è modificabile nel foglio.	true
(nessuno)
Contenuto dell'elemento
Uno o più elementi valore.

elemento users
Nome tag		utenti
Descrizione		Contenitore per fogli assegnati a utenti che denotano le proprietà di accessibilità per un foglio cubo. L'utente chiamante richiede l'autorizzazione Modello per visualizzare questo elemento e tutti i figli di questo elemento.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
isExcludedFromWorkflow	S	Flag che indica se un foglio è o meno escluso dal workflow.	true
Contenuto dell'elemento
Uno o più elementi utente.

elemento utente
Nome tag		utente
Descrizione		Uno degli utenti assegnati al foglio.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Valore intero che indica l'ID univoco di un utente assegnato.	11
Contenuto dell'elemento
(nessuno)

Categoria	Recupero dei metadati
Descrizione	Restituisce la definizione del foglio modellato o cubo specificato.
Autorizzazioni necessarie per richiamare	IMP (importazione dati) o MOD (creazione, modifica ed eliminazione di fogli)
Parametri obbligatori su richiesta	Credenziali e una specifica del foglio richiesto.