exportData

Adaptive Planning

Novità (Workday 2025R2)

exportData

Categoria	Recupero dei dati
Descrizione	Restituisce un insieme di dati dalla versione richiesta nell'istanza della richiesta.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali, Versione, Formato, Filtri

La richiesta di questo metodo contiene i parametri che verranno utilizzati per cercare i dati nella versione specificata e restituire valori che corrispondono ai filtri e al formato richiesti. Questo è il metodo di base utilizzato per recuperare i dati da Adaptive Planning e può essere utilizzato per recuperare valori da qualsiasi conto, inclusi conti standard, conti CoGe, conti modellati, conti cubo, conti personalizzati, conti metrica, ipotesi e tassi di cambio.

Se si esporta una versione del piano, l'esportazione includerà i dati degli importi effettivi per eventuali periodi di sovrapposizione degli importi effettivi. Verranno visualizzati gli importi effettivi o i dati del piano come nell'interfaccia utente dei fogli.

I valori delle singole suddivisioni vengono aggregati quando vengono esportati da

exportData.

Per API v16 e versioni successive,

exportData

esporta anche i dati per le versioni virtuali.

Consultare customReportValuesper un approccio più mirato al recupero dei dati.

Consultare Riferimenti: exportData Performance per sapere come garantire che le richieste traggano vantaggio dai miglioramenti delle prestazioni e della scalabilità rilasciati nella versione 2024R1 per l'API v39.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportData" callerName="a string that identifies your client application" stream="true">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<version name="Budget 2014" isDefault="false"/>
<format useInternalCodes="true" includeUnmappedItems="false" />
<filters>
<accounts>
<account code="A100" isAssumption="true" includeDescendants="false"/>
<account code="L100" isAssumption="false" includeDescendants="true"/>
</accounts>
<levels>
<level name="Development" isRollup="true" includeDescendants="true"/>
<level name="QA" isRollup="false" includeDescendants="false"/>
</levels>
<dimensionValues>
<dimensionValue dimName="Customer" name="A Corp" directChildren="true"/>
<dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/>
</dimensionValues>
<timeSpan start="11/2013" end="12/2014"/>
</filters>
<dimensions>
<dimension name="Product"/>
<dimension name="CountryRegion"/>
</dimensions>
<rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single">
<currency useCorporate="false" useLocal="false" override="AUD"/>
</rules>
</call>

Ogni chiamata di questa chiamata API deve contenere esattamente un elemento di ciascuno dei tipi elencati:

chiamata

credenziali

versione

formato

Una richiesta può contenere anche uno dei seguenti elementi:

filtri:

conti > conto

livelli > livello

dimensionValues > dimensionValue

timeSpan

dimensioni > dimensione

regole > valuta

elemento di chiamata
Nome tag		chiamata
Descrizione		Indica quale metodo API viene chiamato utilizzando il relativo attributo del metodo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
metodo	S	Il metodo chiamato	exportData
callerName	S	Una stringa che identifica l'applicazione client.	"esempio di applicazione client Adaptive Planning"
stream Disponibile nell'API v39+	N	Consente a exportData di riavviare lo streaming dei dati al client non appena vengono elaborati. Per impostazione predefinita, è impostato su false. Si noti che l'abilitazione dello streaming in exportData richiede modifiche al formato della risposta.	true
Contenuto dell'elemento
Esattamente un elemento di ciascuno dei seguenti tipi: credenziali versione formato

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 abbia esito positivo .. L'autorizzazione Funzionalità di esportazione nell'interfaccia utente di Planning non influisce su exportData.
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 versione
Nome tag		versione
Descrizione		Indica la versione da utilizzare per recuperare i dati richiesti. È necessario specificare una versione per ogni chiamata.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	N	Il nome della versione da utilizzare per ricevere i dati. È possibile accedere a una sola versione all'interno di una singola chiamata API. Se non viene specificato un nome, il flag isDefault deve essere impostato su true per questo elemento.	Budget 2014
isDefault	N	Se il chiamante desidera accedere alla versione predefinita corrente dell'istanza indipendentemente dal nome, questo attributo può essere impostato su true, nel qual caso l'attributo name del tag (se presente) viene ignorato. In caso contrario, se questo valore è false o se questo attributo non è presente, affinché la chiamata abbia esito positivo deve esistere ed essere accessibile all'utente.	falso
Contenuto dell'elemento
(nessuno)

elemento di formato
Nome tag		formato
Descrizione		Indica il tipo di formattazione da utilizzare nei singoli campi dei dati da restituire.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
useInternalCodes	S	Impostare su "true" per fare in modo che i codici conto e i codici livello vengano emessi utilizzando i codici immessi in Account e Level Admins. Impostare su "false" per mappare i codici nei dati di output utilizzando Esporta mappature conti o Esporta mappature livelli nella scheda Esporta.	true
useIds	N	Impostare su "true" per avere i conti, i livelli e le dimensioni nelle risposte espresse negli ID, anziché nei codici. Inoltre, i conti, i livelli e le dimensioni nella sezione ` ` dovranno essere espressi nei rispettivi ID. Il valore predefinito è "false" se non è presente nella richiesta.	true
includeUnmappedItems	N	Questo attributo si applica solo se useInternalCodes è false e vengono utilizzate mappature di esportazione. Se non diversamente specificato, gli elementi che non hanno Mappatura esportazione nella scheda Esportazione non verranno emessi nell'output. Se includeUnmappedItems è impostato su "true", i conti o i livelli che non hanno Mappatura esportazione verranno emessi, utilizzando i codici interni (quelli impostati in Amministrazione conti o livelli) come codici, producendo una combinazione di elementi mappati e non mappati nel dati, ma un insieme completo di dati. Se questo flag è impostato su "false", alcuni elementi richiesti potrebbero non essere emessi, se tali elementi non hanno la mappatura esportazione.	falso
includeCodes	N	Questa opzione è utile solo quando l'impostazione effettiva di abilitazione del nome visualizzato è attiva. Impostare su "true" per includere la colonna del codice per il livello nella risposta dell'API. Impostare su "false" per escludere la colonna del codice per il livello nella risposta dell'API. Il valore predefinito è false.	falso
includeNames Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Questa opzione è utile solo quando l'impostazione effettiva di abilitazione del nome visualizzato è attiva. Impostare "true" per includere la colonna del nome per il livello nella risposta dell'API. Impostare "false" per escludere la colonna del nome per il livello nella risposta dell'API. Il valore predefinito è false.	falso
includeDisplayNames Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Questa opzione è utile solo quando l'impostazione effettiva di abilitazione del nome visualizzato è attiva. Impostare "true" per includere la colonna del nome visualizzato per il livello nella risposta API. Impostare "false" per escludere la colonna del nome visualizzato per il livello nella risposta API. Il valore predefinito è false.	falso
displayNameEnabled Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che l'API exportData richiede l'attributo code nella richiesta per specificare le entità livello e dimensione quando Abilita nome visualizzato è su ON per l'istanza. displayNameEnabled=false indica che l'API exportData continua a seguire il contratto API precedente alla v30 anche quando l'impostazione Abilita nome visualizzato è attiva per l'istanza. L'attributo name viene utilizzato al posto dell'attributo code. Per ogni livello e dimensione, i valori degli attributi del nome e del codice devono corrispondere. Il valore predefinito per displayNameEnabled è "false".	falso
Contenuto dell'elemento
(nessuno)

Filtri Elemento
Nome tag	filtri:
Descrizione	Contiene le specifiche per i filtri che determinano quali dati della versione richiesta vengono recuperati dall'API. Questo elemento specifica i conti, i livelli, i mesi e i valori dimensione che verranno recuperati.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento conti obbligatorio, un singolo elemento livelli facoltativo, un singolo elemento timeSpan obbligatorio e un singolo elemento facoltativo dimensionValues.

elemento conti
Nome tag	conti
Descrizione	Contenitore per uno o più elementi del conto.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi del conto.

elemento conto
Nome tag		account
Descrizione		Specifica un conto per l'esportazione dei dati nella chiamata API exportData. Se più di un elemento conto viene inserito all'interno dell'elemento conti, verranno esportati tutti i conti che corrispondono a uno qualsiasi degli elementi del conto. Se un determinato elemento di conto non genera conti corrispondenti, tale elemento viene ignorato mentre gli altri elementi continuano a essere validi.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Il codice del conto da esportare. Questo codice è specificato in Amministrazione conto.	Current_Assets
isPrestazioni	S	Indica se il codice specifica un conto di ipotesi o un conto non di ipotesi. È possibile utilizzare un unico codice sia per un'ipotesi che per un conto. Utilizzare questo flag per indicare il tipo di conto.	falso
includeDescendants	S	Indica se l'esportazione deve includere o meno tutti i discendenti del conto specificato. Se impostato su true, verranno esportati tutti i figli di questo conto, così come i relativi figli e così via. Se è impostato su false, il conto verrà esportato come valore di conto di rollup singolo.	true
Contenuto dell'elemento
(nessuno)

elemento livelli
Nome tag	livelli
Descrizione	Contenitore per uno o più elementi di livello.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi di livello. Se la richiesta include livelli inaccessibili, sarà presente un solo elemento livello, che rappresenta il livello più alto dell'organizzazione.

elemento livello
Nome tag		level
Descrizione		Specifica un livello di organizzazione per l'esportazione dei dati nella chiamata API exportData. Se più di un elemento livello viene inserito all'interno dell'elemento livelli, tutti i livelli specificati verranno esportati. Se un determinato elemento di livello non ha livelli corrispondenti nell'istanza, tale elemento viene ignorato mentre gli altri elementi sono ancora validi. È necessario filtrare per codice anziché per nome quando si soddisfano tutte le seguenti condizioni: L'istanza abilita i metadati duplicati attivando Nome visualizzato. API di chiamata v30 o successiva. La proprietà displayNameEnabled dell'elemento format è true.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	S Il codice si esclude sempre a vicenda con il nome. Quando si applicano entrambe le condizioni, è necessario utilizzare solo il codice: L'impostazione Abilita nome visualizzato è ATTIVA displayNameEnabled="true" nell'elemento format In caso contrario, non includere il codice.	Il codice del livello da esportare. Questo codice è specificato in Amministrazione organizzazione. Il codice è supportato solo quando l'impostazione effettiva di abilitazione del nome visualizzato è attiva.	Sviluppo
nome	S Il nome si esclude sempre a vicenda con il codice. Quando displayNameEnabled="false" nell'elemento format, è necessario utilizzare solo name. Questa è l'impostazione predefinita, se non specificato.	Il nome del livello da esportare. Questo nome è specificato in Amministrazione organizzazione. Il nome è supportato solo per le richieste API precedenti alla v30 quando le impostazioni di abilitazione del nome visualizzato effettive sono disattivate. Poiché l'API recupera i livelli facendo corrispondere l'attributo code alla stringa del nome inclusa nella richiesta, l'attributo name viene considerato funzionalmente come attributo code. Per recuperare correttamente i livelli in base ai nomi, i relativi attributi nome e codice devono corrispondere.	Sviluppo
isRollup	S	Se questo livello ha elementi secondari, isRollup="true" emetterà il valore di rollup per il livello (inclusi i valori di tutti i relativi elementi secondari) e isRollup="false" emetterà solo il valore non categorizzato per il livello (i valori immessi in Modifica Dati per quel livello). Se questo livello non ha figli, isRollup deve essere impostato su false (o omesso completamente dal tag).	falso
includeDescendants	S	Indica se l'esportazione deve includere o meno tutti i discendenti del livello specificato. Se impostato su true, verranno esportati anche tutti i figli di questo livello, così come i loro figli e così via. Se impostato su false, questo livello verrà esportato da solo. Si noti che è diverso da isRollup: isRollup influisce sul valore che verrà emesso per questo livello, mentre include Descendants indica se nell'esportazione devono essere inclusi anche i discendenti. Se isRollup e includeDescendants sono impostati su true e il livello è un livello padre, l'output conterrà i valori sia per il livello di rollup che per il livello non di rollup (non categorizzato) per questo livello e per ciascuno dei suoi discendenti.	true
Contenuto dell'elemento
(nessuno)

timeSpan element
Nome tag		timeSpan
Descrizione		Indica quali periodi di tempo devono essere restituiti nella risposta. I periodi di tempo compresi tra l'intervallo specificato, inclusi, sono inclusi nell'output come colonne di dati separate; non vengono aggregati o sottoposti a rollup.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
inizio	S	Il codice del primo periodo di tempo nell'intervallo di periodi di tempo di cui esportare i dati. Il periodo di tempo di inizio deve essere un periodo di tempo foglia.	01/2015
fine	S	Il codice dell'ultimo periodo di tempo nell'intervallo di periodi di tempo per cui i dati vengono esportati. Il periodo di tempo di fine deve essere un periodo di tempo foglia.	03/2015
strato	N	Il codice dello strato temporale per i dati esportati. Se specificati, i periodi di tempo di inizio e di fine devono rientrare nello strato temporale. Lo strato temporale deve essere uguale o superiore al conto con lo strato temporale più alto nella richiesta. Consultare: Modificare gli strati temporali predefiniti. Modificare gli strati temporali predefiniti nei fogli cubo e modellati con dati. Ad esempio, per indicare uno strato del trimestre è necessario che tutti i conti abbiano lo strato del trimestre, dell'anno o di un valore superiore.	month
Contenuto dell'elemento
(nessuno)

dimensionValues
Nome tag	dimensionValues
Descrizione	Contenitore per uno o più elementi dimensionValue. Questo elemento è facoltativo e non deve essere visualizzato se non si desidera filtrare i valori dimensione.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi dimensionValue.

dimensionValue
Nome tag		dimensionValue
Descrizione		Indica che i dati esportati devono contenere solo valori che corrispondono al valore dimensionValue specificato. Più valori di dimensioni diverse nell'elemento dimensionValues funzionano come se fossero raggruppati in base alle relative dimensioni. I dati vengono restituiti se almeno uno dei valori dimensionValues corrisponde in ogni dimensione. Per dimensionValues all'interno della stessa dimensione, i dati possono corrispondere a qualsiasi valore dimensione. Ad esempio, se una richiesta specifica i valori dimensione Area=Est, Area geografica=Ovest e Prodotto=Prodotto_A, i dati devono corrispondere a Area est o Area ovest, ma devono corrispondere anche a Prodotto_A Prodotto per poter essere esportati. È necessario filtrare per codice anziché per nome quando si soddisfano tutte le seguenti condizioni: L'istanza abilita i metadati duplicati attivando Nome visualizzato. API di chiamata v30 o successiva. La proprietà displayNameEnabled dell'elemento format è true.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
dimName	N	Il nome della dimensione a cui appartiene il valore dimensione (consultare l'attributo name di seguito).	Area geografica
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice del valore dimensione da esportare. L'attributo code è significativo solo quando l'impostazione di abilitazione effettiva del nome visualizzato è attiva per l'istanza.
nome	N	Il nome del valore dimensione da esportare. Il nome è supportato solo per le richieste API precedenti alla v30 quando le impostazioni di abilitazione del nome visualizzato effettive sono disattivate.	Stati Uniti occidentali
directChildren	N	Se impostato su true, l'API esporterà i dati di rollup per ciascuno dei figli diretti di questo valore dimensione, ma non un rollup per il valore stesso. In altre parole, in questo modo exportData esporti i valori "di un livello inferiore" nella struttura ad albero delle dimensioni rispetto al valore specificato. Se non specificato, il valore predefinito è false.	falso
non categorizzato	N	Se impostato su true, corrisponde al valore "non categorizzato" del valore dimensione e non ai valori dei relativi valori discendenti (se presenti). Non ha effetto sui valori dimensione senza figli. Se non specificato, il valore predefinito è false.	true
uncategorizedOfDimension	N	Specificare uncategorizedOfDimension al posto degli attributi dimName/name. Se specificato, il valore dell'attributo deve essere un numero ID di sistema interno di una dimensione (non un valore dimensione) e il filtro specifica che i dati devono essere completamente non categorizzati in questa dimensione per poter corrispondere al filtro. Gli attributi directChildren e uncategorized verranno ignorati e ritenuti rispettivamente false e true. Ignorato se dimName è specificato.	15
directChildrenOfDimension	N	Specificare directChildrenOfDimension al posto degli attributi dimName/name. Se specificato, il valore dell'attributo deve essere un numero ID di sistema interno di una dimensione (non un valore dimensione) e il filtro specifica tutti i valori dimensione di primo livello della dimensione. Gli attributi directChildren e uncategorized verranno ignorati e ritenuti rispettivamente true e false. Ignorato se viene specificato dimName o uncategorizedOfDimension.	12
ID	N	Specificare l'ID al posto degli attributi dimName/name. Il numero ID sistema interno del valore dimensione da esportare. Deve essere specificato al posto degli attributi dimName/name per specificare il valore dimensione. Per determinare gli ID interni, consultare l'API exportDimensions. Ignorato se viene specificato dimName, uncategorizedOfDimension o directChildrenOfDimension.	14
Contenuto dell'elemento
(nessuno)

elemento dimensioni
Nome tag	dimensioni
Descrizione	Contenitore per uno o più elementi dimensione.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi dimensione.

elemento dimensione
Nome tag		dimensione
Descrizione		Indica che i dati esportati devono essere suddivisi o suddivisi in sezioni in base alla dimensione specificata. Si noti che questo tag non fa parte del tag dei filtri e non controlla i filtri: controlla invece il numero di righe esportate per ogni combinazione conto/livello. Per ogni dimensione specificata nell'etichetta dimensioni, ogni combinazione di valori esistente verrà esportata come riga di dati separata. Ogni dimensione presente nell'elemento dimensioni determina anche la visualizzazione di una colonna aggiuntiva nell'output, etichettata con il nome della dimensione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Nome della dimensione in base alla quale suddividere l'esportazione. Le righe di dati nell'esportazione che non possono essere suddivise per dimensione verranno visualizzate una sola volta e mostreranno il nome della dimensione stesso nella colonna in cui verrà visualizzato il nome del valore dimensione per questa dimensione.	Customer
Contenuto dell'elemento
(nessuno)

elemento regole
Nome tag		regole
Descrizione		Specifica alcune regole di output aggiuntive che controllano i tipi di righe emessi e la modalità di rendering di alcuni valori di campo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
includeZeroRows	N	Impostare su "true" per generare righe anche se contengono solo zeri o spazi vuoti. Impostare su "false" per omettere le righe senza dati dall'output. Il valore predefinito è false. Questa opzione non è disponibile nell'interfaccia utente dell'applicazione per le esportazioni che includono dimensioni. Per le chiamate API, True viene ignorato quando si esportano i dati per dimensione. I dati verranno emessi solo per i valori dimensione che contengono dati.	true
includeRollups Disponibile nell'API v24 e versioni precedenti. Non disponibile nell'API v25+.	N	Se è impostato su true, i valori di rollup per tutti i conti e i livelli nel tag dei filtri verranno inclusi in aggiunta ai valori per i loro discendenti. Questo attributo non influisce sul comportamento delle dimensioni personalizzate specificate nei filtri dimensionValue o nell'etichetta dimensioni. Il valore predefinito è false. Il flag includeRollups si applica solo quando non viene applicato alcun filtro esplicito ai conti o ai livelli. Se in un filtro sono inclusi conti individuali, è necessario specificare i singoli conti di rollup se si desidera che vengano inclusi.	falso
includeRollupAccounts Disponibile nell'API v25+.	N	Se è impostato su true, i valori di rollup per tutti i conti nel tag dei filtri verranno inclusi in aggiunta ai valori per i loro discendenti. Questo attributo non influisce sul comportamento delle dimensioni personalizzate specificate nei filtri dimensionValue o nell'etichetta dimensioni. Il valore predefinito è false.	falso
includeRollupLevels Disponibile nell'API v25+.	N	Se è impostato su true, i valori di rollup per tutti i livelli nel tag dei filtri verranno inclusi in aggiunta ai valori per i loro discendenti. Questo attributo non influisce sul comportamento delle dimensioni personalizzate specificate nei filtri dimensionValue o nell'etichetta dimensioni. Il valore predefinito è false.	falso
markInvalidValues	N	Se è impostata su true, l'esportazione aggiungerà la lettera "I" ai valori non validi. In caso contrario, viene aggiunto "=NA()" ai valori non validi, per renderli compatibili con Excel. Il valore predefinito è false.	falso
markBlanks Aggiornato nell'API v24.	N	Se impostato su true, i valori vuoti verranno emessi come "B". In caso contrario, i valori vuoti verranno emessi come zeri. Il valore predefinito è false. Se includeZeroRows=false, le righe con una combinazione di soli spazi vuoti e zeri non verranno restituite nella risposta, anche se markBlanks=true.	falso
timeRollups	N	Ha tre valori possibili: true, false e single. Se è impostato su true, i rollup trimestrali e annuali verranno visualizzati nella posizione corretta all'interno dell'intervallo di mesi esportato. I rollup trimestrali vengono visualizzati immediatamente dopo l'ultimo mese del trimestre e i rollup annuali vengono visualizzati immediatamente dopo il rollup del trimestre per l'ultimo trimestre. Se è impostato su Single, non vengono restituiti singoli mesi, trimestri o anni e viene restituito un solo rollup temporale di tutti i mesi coperti nell'elemento timespan. Se è impostato su false, vengono restituiti solo i singoli mesi, senza colonne di rollup temporale. Il valore predefinito è false.	falso
Contenuto dell'elemento
Un elemento di valuta facoltativo per specificare la valuta da utilizzare nell'esportazione.

elemento valuta
Nome tag		valuta
Descrizione		Indica la valuta da utilizzare nell'output quando si emettono i valori dei conti in valuta.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
useCorporate	N	È possibile impostare solo uno dei tre attributi per un elemento valuta. Se useCorporate è impostato su true, è necessario utilizzare la "valuta aziendale" (la valuta nella parte superiore della struttura ad albero dell'organizzazione). Il valore predefinito è false.	falso
useLocal	N	È possibile impostare solo uno dei tre attributi per un elemento valuta. Se useLocal è impostato su true, i valori di valuta devono essere emessi nella valuta del livello organizzazione in cui risiedono. Ogni riga dell'output indica un Livello organizzazione e i valori di valuta in tale riga saranno nella valuta del livello. Il valore predefinito è false.	falso
valore sostitutivo	N	È possibile impostare solo uno dei tre attributi per un elemento valuta. Se è presente un valore sostitutivo, è necessario specificare il codice valuta di tre lettere di una delle valute configurate per l'istanza. Se specificato, tutti gli importi in valuta nell'esportazione verranno convertiti in tale valuta.	AUD
Contenuto dell'elemento
(nessuno)

Gli elementi seguenti consentono agli utenti (con le autorizzazioni corrette) di richiedere esportazioni per rollup temporali arbitrari. Questi elementi richiedono richieste che utilizzano l'API v40 e versioni successive.

tempoelemento
Nome tag		time
Descrizione		Contiene l'XML del calendario da utilizzare per mappare i periodi di tempo durante l'esportazione dei dati. Deve essere in un formato ridotto dell'XML temporale prodotto nel file exportTime API I periodi di tempo inclusi in questa sezione devono corrispondere all'elemento intervallo di tempo nel filtro. Questo elemento è obbligatorio SOLO quando si utilizza il calendario di rollup arbitrario. Disponibile solo nell'API v40 e versioni successive
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio

Contenuto dell'elemento
(nessuno)

stratoelemento
Nome tag		strato
Descrizione		Rappresenta uno strato del calendario. Disponibile solo nell'API v40 e versioni successive
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore univoco definito dall'utente per lo strato temporale.	Anno
ID	S	Identificatore intero univoco generato dal sistema per lo strato temporale.	7
Contenuto dell'elemento
(nessuno)

periodoelemento
Nome tag		periodo
Descrizione		Rappresenta un singolo periodo di tempo del calendario. Disponibile solo nell'API v40 e versioni successive
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Identificatore univoco definito dall'utente per il periodo di tempo.	Q1-2004
stratumId	S	ID dello strato a cui appartiene il periodo di tempo.	2
timeslot	S	La fascia oraria del periodo di tempo.	16
ID	S	L'identificatore intero univoco generato dal sistema per il periodo di tempo.	16002
inizio	S	La data di inizio (inclusa) del periodo di tempo, nel formato AAAA-MM-GG.	2004-01-01
fine	S	La data di fine (esclusa) del periodo di tempo, nel formato AAAA-MM-GG.	2004-01-01
Contenuto dell'elemento
(nessuno)

Esempio di richiesta di rollup temporale arbitraria
:


<call method="exportData" callerName="test caller api name">
<credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" />
<version name="Budget 2004" isDefault="true" />
<format useInternalCodes="true" includeUnmappedItems="false" useIds="false" />
<rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false">
   <currency useCorporate="false" useLocal="true" />
</rules>
<filters>
   <accounts>
       <account code="70310" isAssumption="false" includeDescendants="true" />
   </accounts>
   <timeSpan start="01/1999" end="06/1999" />
</filters>
<time isCustom="1">
   <stratum code="month" label="Month" shortName="Month" id="1" />
   <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" />
 <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" />
 <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" />
 <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" />
 <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" />
 <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" />
</time>
</call>

Formato risposta

Formato risposta per non streaming


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
<message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message>
</messages>
<output><![CDATA[
Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014]
"Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05
"Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0
...
]]>
</output>
</response>

Formato risposta per streaming


<?xml version="1.0" encoding="UTF-8"?>
<response>
<output>
<![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005
"Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0
"Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]>
</output>
<messages>
<message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message>
</messages>
<status success="false" rowCountSent="2"/>
</response>

Si noti che è stata modificata la struttura della risposta per le richieste in streaming e non in streaming. Ad esempio, l'elemento e lo stato del messaggio si verificano dopo l'output.

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 messaggi
Nome tag	messaggi
Descrizione	Contenitore per uno o più elementi del messaggio.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi del messaggio.

elemento messaggio
Nome tag		messaggio
Descrizione		Rappresenta un messaggio inviato dal sistema al chiamante. I messaggi vengono utilizzati per i messaggi di errore quando le richieste non hanno esito positivo, per i messaggi di avviso quando le richieste hanno esito positivo e per i messaggi di conferma in caso di esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
chiave	N	Quando viene assegnata, una chiave è un modo per identificare un particolare messaggio o tipo di messaggio, utile ai fini della registrazione automatica degli errori e del ripristino nei programmi client. Le chiavi non cambiano nelle diverse impostazioni internazionali delle richieste, anche quando cambia la lingua del messaggio. Inoltre, è improbabile che le chiavi cambino in futuro a causa di rettifiche di testo o modifiche della terminologia.	invalid-attributevalueid
Contenuto dell'elemento
Il testo del messaggio. Questo testo è nella lingua delle impostazioni internazionali specificate nella richiesta (supponendo che le impostazioni internazionali siano supportate). Il testo può anche contenere informazioni variabili come il numero di righe elaborate o la colonna o il valore specifico che ha causato un errore.

elemento di output
Nome tag	output
Descrizione	Contiene i dati risultanti dell'esportazione in un blocco CDATA racchiuso.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un blocco CDATA contenente i dati in formato CSV dell'esportazione. Le righe sono separate da caratteri di nuova riga. La prima riga di dati restituiti è l'insieme di "intestazioni di colonna" che descrivono il formato di ciascuna delle righe seguenti. Le dimensioni e gli elementi di filtro vengono elencati per primi, seguiti dalla serie di valori del periodo di tempo richiesti. I codici periodo di tempo e le etichette generate dal sistema, ad esempio il suffisso "(Rollup)" nei livelli di rollup, vengono convertiti nelle impostazioni internazionali della richiesta, quando possibile. I valori vengono emessi in formato normalizzato, senza virgole, utilizzando un punto come separatore decimale.

elemento di stato
Nome tag		stato
Descrizione		Contiene informazioni sullo stato della richiesta e del numero di righe (SOLO per richieste di streaming)
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	"vero" o "falso". Informa se la richiesta è stata completata o meno. Anche le richieste riuscite possono contenere messaggi di avviso. Sostituisce l'attributo nella risposta SOLO nelle richieste di streaming.	"true"
rowCountSent	S	r"\d+". Rappresenta il valore numerico del numero di righe nella risposta.	"10"

Questo contenuto è stato utile?

Che cosa richiede la nostra attenzione? Preciso Risponde alla mia domanda Facile da trovare Di facile comprensione Utile per completare l'attività Completo di dettagli

Che cosa richiede la nostra attenzione? Impreciso Non risponde alla mia domanda Non facile da trovare Di non facile comprensione Non utile per completare l'attività Incompleto o senza dettagli

Indica l'attività che stai eseguendo. Quali informazioni aggiuntive potrebbero migliorare questo contenuto? Hai altri dettagli da condividere?

Nome completo

E-mail

Workday utilizzerà il vostro nome e la vostra e-mail per fornirvi le risposte relative al vostro feedback. I vostri dati saranno trattati in conformità con la nostra Informativa sulla privacy.

Grazie per il feedback