importTransactions

Adaptive Planning

Novità (Workday 2025R2)

importTransactions

Categoria	Inoltro dei dati
Descrizione	Inserisce nuove transazioni.
Autorizzazioni necessarie per richiamare	Importazione
Parametri obbligatori su richiesta	Credentials, ImportTransactionsOptions, RowData

Questo metodo si applica solo se si dispone dell'accesso a Transazioni.

È possibile eliminare le transazioni solo durante l'importazione. Se si desidera rimuovere tutte le transazioni durante l'importazione, valutare la possibilità di importare una riga vuota ed eliminare i dati rimanenti.

Questo metodo può essere utilizzato per eliminare righe di transazione esistenti che soddisfano determinati criteri, per inserire nuove righe di transazione nel sistema o per eseguire entrambe le azioni in un'unica chiamata (ad esempio, sostituire un insieme di righe di transazione con un altro insieme di righe).

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="importTransactions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <importTransactionsOptions allowParallel="false" useMappings="false"/>
  <rowData>
    <header>Posting Date|Transaction Type|Account|Plan|Transaction Amount</header>
    <rows>
       <row>01/02/2011|Invoice|70110|Marketing|100</row>
    </rows>
  </rowData>
</call>

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

credenziali

importTransactionsOptions

rowData

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

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
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)

importTransactionsOptions element
Nome tag		importTransactionsOptions
Descrizione		Specifica le opzioni da utilizzare quando si esegue l'importazione. Se almeno uno deideleteStartDate,deleteEndDate oTransactionTypes sono specificati, quindi questa chiamata al metodo tenterà di eliminare tutte le transazioni esistenti che corrispondono ai criteri specificati.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
deleteStartDate	N	Se questa chiamata al metodo ha lo scopo di eliminare alcune transazioni esistenti, questo attributo specifica la data di inizio dell'insieme di transazioni da eliminare (inclusa). Se non specificato, tutte le transazioni che hanno una data corrispondente o precedente aldeleteEndDate (e che corrisponde a uno dei valori facoltativi specificatiTransactionTypes) verranno eliminati.	11/01/2012
deleteEndDate	N	Se questa chiamata al metodo ha lo scopo di eliminare alcune transazioni esistenti, questo attributo specifica la data di fine dell'insieme di transazioni da eliminare (inclusa). Se non specificato, tutte le transazioni che hanno una data corrispondente o successiva aldeleteStartDate (e che corrispondono a uno dei valori facoltativi specificatiTransactionTypes) verranno eliminati.	12/31/2012
TransactionTypes	N	Un insieme di tipi di transazione che verranno eliminati, separati dal simbolo della barra verticale. Se non specificato, tutte le transazioni indicate tradeleteStartDate anddeleteEndDate verrà eliminato. Se ndeleteStartDate ordeleteEndDate, tutte le transazioni dei tipi specificati verranno eliminate, indipendentemente dalle date.	Fattura\|Ordine di acquisto
allowParallel	S	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	N	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	N	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 v31+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che l'API deve prevedere le colonne Codice conto, Codice livello, Codice dimensione e Nome dimensione nel payload quando l'impostazione Abilita nome visualizzato è attiva per l'istanza. displayNameEnabled=false indica che l'API deve continuare a seguire il contratto API precedente alla v30 anche quando l'impostazione Abilita nome visualizzato è attiva per l'istanza. Il valore predefinito per displayNameEnabled è "false".	falso
Contenuto dell'elemento
(nessuno)

rowData element
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 mesi 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 per l'importazione riuscita e non riuscita dei dati delle transazioni.

Esempio di successo


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <messages>
       <message key="row-imported">1 row was imported.</message>
   </messages>
</response>

Non riuscito (con contesto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message>
       <message key="import-detail">Additional information:</message>
       <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">
           <context>
               <col header="Posting Date" value="01/02/2011" />
               <col header="Transaction Type" value="Invoice12" />
               <col header="Account" value="70110" />
               <col header="Plan" value="Marketing" />
               <col header="Transaction Amount" value="100.0" />
     
           </context>
     Invalid Dimension Choice: Invoice12 on row 1 column B
   
       </message>
     </messages>
</response>

Non riuscito (nessun contesto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message>
       <message key="import-detail">Additional information:</message>
       <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">Invalid Dimension Choice: Invoice12 on row 1 column B</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.

context element
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