importStandardData

Adaptive Planning

Novità (Workday 2025R2)

importStandardData

Aggiornato nell'API v40 (13 settembre 2024)

Categoria	Inoltro dei dati
Descrizione	Inserisce o sostituisce i dati nei conti standard.
Autorizzazioni necessarie per richiamare	Importa in tutte le sedi Cancella dati (API v36+ per supportare la modalità REPLACE)
Parametri obbligatori su richiesta	Credentials, ImportDataOptions, Version, RowData

includeDescendants

La richiesta di questo metodo contiene i parametri che verranno utilizzati per determinare la versione che riceverà le righe di dati fornite. I dati possono essere importati in qualsiasi conto standard (Conto CoGe, Conto personalizzato, Ipotesi o Tasso di cambio) indipendentemente dal fatto che il conto sia stato inserito in un foglio.

importStandardData non può eseguire l'importazione in conti che utilizzano Immissione dati
per impostazione sostitutiva della formula
.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="importStandardData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" useMappings="false" />
<version name="Budget 2004" isDefault="false" />
<rowData>
<header>Account|Level|Split Label|Product|Region|11/2005|01/2006</header>
<rows>
<row>70110|Corporate Plan||Bunnyrabbit Toy|Western-US|2037|4032</row>
</rows>
</rowData>
</call>

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

credenziali

importDataOptions

versione

rowData

intestazione

righe

Una mancata corrispondenza tra il numero di caratteri pipe ( | ) nell'intestazione e i dati causerà un errore per l'API v30 o successiva.

Per API v36+, se l'attributo della modalità importDataOptions è REPLACE, è necessario specificare anche un elemento di ambito:

Esempio: Richiesta modalità di sostituzione

Disponibile solo nell'API v36+


<?xml version='1.0' encoding='UTF-8'?>
<call method="importStandardData" callerName="a string that identifies your client application">
<credentials login="nobody@company.com" password="password" instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" allowParallel="true" moveBPtr="false" useMappings="false" mode="replace" />
<version name="Budget 2011" isDefault="false" />
<scope>
<accounts mode="explicit">
<account includeDescendants="false">30490</account>
<account includeDescendants="false">70313</account>
</accounts>
<levels mode="explicit">
<level includeDescendants="false">Development</level>
<level includeDescendants="true">Sales</level>
</levels>
<time mode="input" />
</scope>
<rowData>
<header>Account|Level|Split Label|Base Pay|CapitalAssetClass|Company|CountryRegion|01/2011</header>
<rows>
<row>30490|Asia Sales||120-150K|Furniture|ABC Cons|Washington|1</row>
<row>70313|Development||100-120K|OtherEquipment|ABC Cons|Maharashtra|2</row>
</rows>
</rowData>
</call>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere una singola chiamatacredenziali 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
login	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 appropriato,i nomi dei periodi di tempo e la formattazione della data). 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 importDataOptions

Nome tag

importDataOptions

Descrizione

Specifica le opzioni da utilizzare quando si esegue l'importazione.

Attributi dell'elemento

Nome attributo

Obbligatorio?

Valore

Esempio

planOrActuals

Impostare su "Piano" o "Importi effettivi" per specificare il tipo di dati da importare. Se questa impostazione è in conflitto con la versione specificata inTag versione,Il valore del tag di versione ha la precedenza e questa impostazione viene ignorata.

Piano

moveBPtr

Utilizzato solo quando ilL'attributo planOrActuals è impostato suImporti effettivi SemoveBPtr è impostato sutrue, l'importazione sposterà il puntatore di disponibilità degli importi effettivi nella versione importi effettivi in modo che sia l'ultimo periodo di tempo trovato nei dati importati. Se impostato sufalse, l'importazione non influirà sui periodi di tempo che mostrano gli importi effettivi in nessuna versione. Questo attributo deve essere impostato su false ifplanOrActuals è impostato suPiano

false

allowParallel

Utilizzato solo quando ilL'attributo planOrActuals è impostato suImporti effettivi Se impostato sutrue, l'importazione procederà anche se è già in corso un'altra importazione di importi effettivi o transazioni per questa istanza. Se impostato sufalse, un tentativo di importazione avrà esito negativo se è già in corso un'importazione di importi effettivi o transazioni per questa istanza.

falso

useMappings

Specifica se utilizzare le mappature di importazione per conti, piani e valori dimensione all'interno degli elementi riga. Consideratovero per impostazione predefinita. Sefalse, devono essere utilizzati gli ID interni: i conti sono identificati da codice, livelli e valori dimensione in base al nome.

falso

includeContext

Specifica se i messaggi possono includere il blocco di contesto. I valori sonofalse (non mostrare mai il contesto) otrue (mostrare il contesto, se appropriato). Se non specificato,si presuppone vero.

falso

displayNameEnabled

Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.

displayNameEnabled=true indica che importStandardData dovrebbe essere previsto

Account Code

Level Code

Dimension Code

Dimension Name Column

nel payload quando l'opzione Abilita nome visualizzato è attiva per l'istanza.

displayNameEnabled=false indica che l'API importStandardData deve continuare a seguire il contratto API precedente alla v30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API importStandardData ignora le proprietà del nome visualizzato

Account Code

Level Code

Dimension Code

Dimension Name Column

Il valore predefinito per displayNameEnabled è "false".

falso

splitsToUnsplit

Disponibile solo in API v40+

splitsToUnsplit=true consente l'importazione di suddivisioni in una sede non suddivisa con dati esistenti. Il valore predefinito per questo attributo è false.

falso

modalità

Disponibile solo nell'API v36+

Specifica la modalità di importazione, che è APPEND o REPLACE.

Aggiungi	I fatti esistenti vengono aggiornati o vengono aggiunti nuovi fatti. Nessun fatto verrà eliminato.
Sostituisci	La richiesta deve includere un elemento di ambito che rappresenta le coordinate dell'ipercubo all'interno del quale i dati verranno sostituiti da quelli forniti nel payload. Tutti i dati esistenti all'interno dell'ambito che non hanno coordinate corrispondenti nel payload verranno eliminati.

Questo attributo mode è supportato dall'API v36 e versioni successive. La chiamata a una versione precedente dell'API con mode="REPLACE" è un errore.

Il valore predefinito per la modalità quando non è specificato è APPEND.

APPEND

Contenuto dell'elemento

(nessuno)

elemento versione
Nome tag		versione
Descrizione		Indica la versione da utilizzare per ricevere 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 fileIl flag isDefault deve essere impostato su true per questo elemento. Per ottenere un elenco delle versioni di valuta convertite e dei relativi nomi, eseguire una richiestaexportVersions con currencyVersions=true nell'elemento include.	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 ambito
Nome tag		ambito Disponibile solo nella versione API 36+
Descrizione		Specifica l'ambito dell'importazione. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
eraseCellNotes	N	Specifica se cancellare o meno le note della cella nell'ambito. Deve essere uno dei tre valori enumerati: NONE : non cancella le note delle celle. ALL - Cancella tutte le note della cella all'interno dell'ambito. MODIFIED_ONLY - Cancella le note delle celle per le celle che rientrano nell'ambito modificate dall'importazione. Sono incluse le celle precedentemente vuote in cui sono stati importati dati e le celle i cui dati sono stati cancellati. Se eraseCellNotes non è specificato, il valore predefinito è NONE.	NESSUNO
Contenuto dell'elemento
Un elemento temporale , un elemento conti e un elemento livelli , tutti obbligatori.

elemento conti
Nome tag		conti Disponibile solo nella versione API 36+
Descrizione		Specifica i conti per l'ambito di importazione. Se esiste un conto specificato ma non sono presenti dati per questo conto nei dati di importazione, i dati in questo conto verranno rimossi per l'intervallo di tempo e il resto delle coordinate dell'ambito. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
modalità	S	Specifica la modalità per l'ambito del conto. Deve essere una delle tre opzioni seguenti. EXPLICIT - Se viene specificata questa modalità, verranno visualizzati uno o più sottoelementi del conto che determineranno l'ambito del conto per l'importazione. INPUT - Quando questa modalità è specificata, l'ambito del conto sarà determinato dall'insieme univoco di conti presente nei dati di importazione. Nota: i conti mode="ALL" non sono consentiti per l'ambito di importazione standard.	EXPLICIT
Contenuto dell'elemento
Se mode è INPUT , non devono essere presenti sottoelementi <account>. Se la modalità è EXPLICIT , devono essere presenti uno o più sottoelementi <account>. Se mode è EXPLICIT e se un codice conto in un sottoelemento <account> non è valido, l'intero elemento <accounts> e, per estensione, l'<ambito>, saranno considerati non validi. Nella risposta verrà incluso un messaggio di errore per ogni codice non valido.

elemento conto
Nome tag		account Disponibile solo nella versione API 36+
Descrizione		Specifica il codice conto da includere nell'ambito dell'importazione. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
includeDescendants	N	Se il conto è foglia, includeDescendants non ha effetto. Se il conto è un conto padre, specificare questo attributo come true includerà tutti i discendenti foglia di questo conto nell'ambito. Si tratta di un errore se il conto è un conto padre e includeDescendants è false. È possibile eseguire l'importazione solo nei conti foglia. Questo è un attributo facoltativo e il valore predefinito verrà considerato come falso.	vero
selettore	N	Specifica il tipo di contenuto dell'elemento conto: Codice Il contenuto dell'elemento conto è un codice conto. Esempio: <account selector="code">30440</account> In questo esempio, 30440 è un codice conto. Digitare Il contenuto dell'elemento conto è un tipo di conto. Esempio: <account selector="type">GL</account> In questo esempio il tipo di elemento conto è tutti i conti CoGe. Al momento, sono supportati solo "CoGe" e "PERSONALIZZATO" per il tipo di conto per le importazioni standard. Tutti gli altri contenuti generano errori. Il valore predefinito per il selettore è codice.
Contenuto dell'elemento
Il codice conto con distinzione tra maiuscole e minuscole del conto utilizzato nell'ambito dell'importazione. Ad esempio, AccountsPayable. Il codice non deve essere vuoto e deve esistere il conto corrispondente. Il conto non può essere un conto di sistema o collegato. Se il conto è calcolato, deve essere presente un valore sostitutivo per l'immissione dei dati, altrimenti il conto è considerato non valido. Se un codice conto non è valido, l'intero elemento <accounts> e, per estensione, l'<ambito>, viene considerato non valido.

elemento livelli
Nome tag		livelli Disponibile solo nella versione API 36+
Descrizione		Specifica i codici livello per l'ambito di importazione. Se qui viene specificato un codice livello ma non sono presenti dati per questo livello nei dati di importazione, i dati in questo livello verranno rimossi per l'intervallo di tempo e il resto delle coordinate dell'ambito. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
modalità	S	Specifica la modalità per l'ambito del livello. Deve essere una delle tre opzioni seguenti. EXPLICIT - Se viene specificata questa modalità, verranno visualizzati uno o più sottoelementi <level> che determineranno l'ambito del livello per l'importazione. INPUT - Quando viene specificata questa modalità, l'ambito del livello sarà determinato dall'insieme univoco di livelli presente nei dati di importazione. ALL : quando questa modalità è specificata, l'ambito del livello sarà tutti i livelli importabili.	EXPLICIT
Contenuto dell'elemento
Se la modalità è INPUT o ALL, non devono essere presenti sottoelementi <level>. Se la modalità è ESPLICITA, devono essere presenti uno o più sottoelementi <level>. Se la modalità è ESPLICITA e se un codice livello in un sottoelemento <level> non è valido, l'intero elemento <levels> e, per estensione, l'<ambito>, saranno considerati non validi. Nella risposta verrà incluso un messaggio di errore per ogni codice non valido.

elemento livello
Nome tag		level Disponibile solo nella versione API 36+
Descrizione		Specifica il codice livello da includere nell'ambito dell'importazione. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
includeDescendants	N	Se il livello è un livello padre, specificare questo attributo come true includerà tutti i discendenti foglia di questo livello, incluso se stesso (il nodo Solo) nell'ambito. Questo è un attributo facoltativo. Se l'attributo non viene specificato, il valore predefinito sarà false. Se l'attributo non viene fornito o fornito come false e il livello specificato è un livello padre, l'importazione prenderà in considerazione il nodo Solo (ad esempio, solo progettazione) per quel livello come ambito. I figli del livello non verranno inclusi nell'ambito, a meno che non siano specificati in modo esplicito da altri elementi del livello.	vero
Contenuto dell'elemento
Specifica il codice con distinzione tra maiuscole e minuscole del livello. Ad esempio, <level>Sviluppo</level>. Se si verifica un problema con il codice del livello, ad esempio un livello in cui il codice non viene trovato, l'intero <levels> e, per estensione, l'<scope> vengono considerati non validi. Nella risposta verrà incluso un messaggio di errore per ogni codice non valido.

elemento temporale
Nome tag		time Disponibile solo nella versione API 36+
Descrizione		Specifica uno o più intervalli di tempo che rappresentano l'ambito temporale per l'importazione. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
modalità	S	Specifica la modalità per l'ambito temporale. Deve essere una delle tre opzioni seguenti. INPUT - Quando questa modalità è specificata, l'ambito temporale sarà determinato dai codici orari in <header> elemento Se l'intestazione contiene due mesi, l'ambito dell'importazione sarà di questi due mesi. EXPLICIT - Se viene specificata questa modalità, verranno visualizzati uno o più sottoelementi timeRange che determineranno l'ambito temporale per l'importazione. VERSIONE - Quando viene specificata questa modalità, l'ambito temporale sarà l'inizio e la fine della versione, incluso l'eventuale periodo di saldo iniziale. Se la modalità è INPUT o VERSION, non è consentito alcun sottoelemento timeRange. Se sono presenti sottoelementi timeRange, questo verrà considerato come un errore.	INGRESSO
Contenuto dell'elemento
Uno o più elementi timeRange, a meno che la modalità non sia INPUT o VERSION.

elemento timeRange
Nome tag		timeRange Disponibile solo nella versione API 36+
Descrizione		Specifica un singolo intervallo di tempo per l'ambito temporale. Consentito solo quando l'attributo mode dell'elemento importDataOptions è REPLACE.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
inizio	S	Il periodo di inizio per l'intervallo di tempo dell'importazione.	07/2021
fine	S	Il periodo di fine per l'intervallo di tempo di importazione.	08/2021
Contenuto dell'elemento
Uno o più elementi timeRange, a meno che la modalità non sia INPUT o VERSION.

elemento rowData
Nome tag		rowData
Descrizione		Contenitore per le righe di dati da importare.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Esattamente unoelemento di intestazione ed esattamente unoelemento righe

elemento di intestazione
Nome tag		intestazione
Descrizione		Specifica i nomi e l'ordine delle colonne dei dati nel corrispondenteelemento righe
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Una riga di testo con nomi di colonna separati da barre verticali. Questi nomi di colonna devono corrispondere ai nomi delle dimensioni o dei campi del foglio o ai codici periodo che possono contenere dati. Sono identici ai nomi delle colonne presenti nel Modello di importazione per il foglio in cui vengono importati i dati, con ogni intestazione di colonna separata dalla successiva da una barra verticale o da un simbolo di pipe. Per le istanze che abilitano il Nome visualizzato, l'intestazione non è supportata "<dimension>" in combinazione con "<dimension> Name" o "<dimension> Code" in API v30 o versioni successive per le impostazioni internazionali supportate da Adaptive Planning.

elemento righe
Nome tag		righe
Descrizione		Contenitore per uno o piùelementi riga
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o piùelementi riga

elemento riga
Nome tag		riga
Descrizione		Dati per una singola riga in fase di importazione.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
I dati dei campi di una singola riga in fase di importazione, il valore di ogni campo separato da una barra verticale o da un simbolo di barra verticale. I campi di dati devono essere nello stesso ordine della riga nell'elemento di intestazione. Se i numeri nei valori utilizzano separatori di migliaia, si presume che siano i separatori di virgole utilizzati nelle impostazioni internazionali specificate nelle credenziali della richiesta.

Formato risposta

Questi sono esempi di risposte relative all'importazione riuscita e non riuscita di dati di conti standard.

Esempio di successo


<?xml version='1.0' encoding='UTF-8'?>
<response success="true"></response>

Non riuscito (con contesto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
<messages>
<message key="error-empty-account">
    <context>
        <col header="Account" value="" />
        <col header="Level" value="Corporate Plan" />
        <col header="Split Label" value="" />
        <col header="Product" value="Bunnyrabbit Toy" />
        <col header="Region" value="Western-US" />
        <col header="11/2005" value="2037" />
        <col header="01/2006" value="4032" />

    </context>
Account cannot be empty on row 1.

</message>
</messages>
</response>

Non riuscito (nessun contesto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
<messages>
<message key="error-empty-account">Account cannot be empty on row 1.</message>

</messages>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	In entrambi i casivero ofalse, che indica se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	vero
Contenuto dell'elemento
Un singolo facoltativoelemento messaggi

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. Un elemento di contesto facoltativo.

elemento di contesto
Nome tag		contesto
Descrizione		Contenitore per uno o più elementi colonne.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nessuno
Contenuto dell'elemento
Uno o più elementi colonne.

elemento col
Nome tag		col
Descrizione		Rappresenta il contesto del messaggio. Fornisce una coppia intestazione/valore per identificare la riga che genera il messaggio.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
intestazione	S	L'intestazione della colonna.	"Account"
valore	S	Il valore nella colonna.	"GL-29482-38233"
Contenuto dell'elemento
(nessuno)

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