exportDimensionFamilies

Categoria	Recupero dei metadati
Descrizione	Restituisce i metadati che descrivono le relazioni tra insiemi di conti e insiemi di dimensioni.
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 un insieme di famiglie di dimensioni, che descrivono in che modo insiemi di dimensioni specifici sono correlati a insiemi di conti specifici. Ogni famiglia è composta da un insieme di conti e da un insieme di dimensioni, il che indica che tali dimensioni si applicano a tali conti, mentre altre dimensioni no. I conti e le dimensioni possono appartenere a più famiglie. Le famiglie sono definite come segue:

I conti in un foglio modellato appartengono a una famiglia per quel foglio, che contiene tutte le dimensioni inserite nel foglio e tutte le dimensioni dell'organizzazione.

I conti in un foglio cubo appartengono a una famiglia per quel foglio, che contiene tutte le dimensioni inserite nel foglio e tutte le dimensioni dell'organizzazione.

I conti in un foglio standard con dimensioni appartengono a una famiglia per quel foglio, che contiene tutte le dimensioni inserite nel foglio e tutte le dimensioni organizzazione.

I fogli standard che non contengono dimensioni non hanno una famiglia di dimensioni associata.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionFamilies" 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>
   <families>
     <family name="Personal" id="381" accounts="734-739, 744" dimensions="9321,9422, 9455, 9458" />
     <family name="Capital" id="382" accounts="853" dimensions="4" />
     <family name="Sales" id="386" accounts="769, 4112" dimensions="" />
     <family name="Balance" id="255" accounts="545, 66" dimensions="6,7" />
   </families>
 </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 famiglie
Nome tag		famiglie
Descrizione		Contenitore per uno o più elementi della famiglia.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi della famiglia.

elemento familiare
Nome tag		famiglia
Descrizione		Descrive una singola famiglia di dimensioni associata a un singolo foglio modellato o cubo. Viene inoltre generata una singola famiglia per tutte le ipotesi e i tassi di cambio non modellati e non cubo. Questa famiglia generica ha id = 0.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome della famiglia di dimensioni. La famiglia composta da tutte le ipotesi non cubo e dai conti tasso di cambio (che non hanno dimensioni) avrà il nome "*". La famiglia di dimensioni di un foglio standard ha lo stesso nome del foglio standard, mentre la famiglia di dimensioni di un foglio cubo o modellato utilizza il prefisso del foglio come nome della famiglia.	Capitale
ID	S	L'ID della famiglia di dimensioni, ovvero l'ID del foglio con cui è descritta la famiglia.	3
conti	S	L'insieme di numeri ID conto appartenenti a questa famiglia. Gli ID sono gli ID di sistema interni dei conti, visibili nella chiamata API exportAccounts. Gli ID sono separati da virgole e possono contenere intervalli con trattino, a indicare che sono inclusi tutti gli ID all'interno dell'intervallo.	734-739,744
dimensioni	S	L'insieme di numeri ID dimensione appartenenti a questa famiglia. Gli ID sono gli ID di sistema interni per le dimensioni, visibili nella chiamata API exportDimensions. Gli ID sono separati da virgole e possono contenere intervalli con trattino, a indicare che sono inclusi tutti gli ID all'interno dell'intervallo.	9321.9422.9455.9458
Contenuto dell'elemento
(nessuno)