exportTransactionDefinition

Categoria	Recupero dei metadati
Descrizione	Restituisce la definizione (colonne disponibili) delle transazioni nell'istanza.
Autorizzazioni necessarie per richiamare	IMP (importazione dati) o MANAGE_TX (gestione della definizione del campo transazione)
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 la definizione di una transazione nell'istanza.

Formato richiesta


<?xml version="1.0" encoding="UTF-8"?>
<call method="exportTransactionDefinition" 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
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>
   <transaction>
     <fields>
       <posting-date name="Posting Date"/>
       <type name="Transaction Type">
         <value id="178" name="Journal Entry"/>
         <value id="179" name="Purchase Order"/>
         <value id="177" name="Invoice"/>
         <value id="180" name="Transaction"/>
       </type>
       <accounts name="Account"/>
       <levels name="Plan"/>
       <dimension id="4" name="Product">
         <value id="48" name="B-2"/>
         <value id="47" name="B-1"/>
         <value id="14" name="A"/>
         <value id="15" name="B-Ste"/>
       </dimension>
       <text-selector id="4" name="Flavor">
         <value id="123" name="Chocolate"/>
         <value id="122" name="Vanilla"/>
       </text-selector>
       <text name="Description"/>
       <number name="Sales Tax"/>
       <date name="Due Date"/>
       <amount name="Transaction Amount"/>
     </fields>
   </transaction>
</output>
</response>

Ciascuno dei campi di una transazione è definito da uno dei seguenti elementi:

data di pubblicazione (una)

tipo (uno)

conti (uno)

livelli (uno)

dimensione (zero o più)

text-selector (zero o più)

testo (zero o più)

numero (zero o più)

data (zero o più)

importo (uno)

elemento transazione
Nome tag		transazione
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Un elemento campi

elemento campi
Nome tag		campi
Descrizione		Contenitore per tutti i campi obbligatori e facoltativi.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Un elemento per ogni campo che deve avere ogni transazione.

elemento data di pubblicazione
Nome tag		data di pubblicazione
Descrizione		La data obbligatoria in cui è stata registrata la transazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	Data di contabilizzazione
Contenuto dell'elemento
(nessuno)

tipo di elemento
Nome tag		type
Descrizione		Il tipo di transazione obbligatorio
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	Tipo di transazione
Contenuto dell'elemento
Uno o più elementi valore.

elemento conti
Nome tag		conti
Descrizione		Il conto a cui appartiene la transazione. I metadati del conto, inclusa la struttura gerarchica, possono essere ottenuti chiamando exportAccounts.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	Account
Contenuto dell'elemento
(nessuno)

elemento livelli
Nome tag		livelli
Descrizione		Il livello a cui appartiene la transazione. I metadati del livello, inclusa la struttura gerarchica, possono essere ottenuti tramite una chiamata a exportLevels.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	level
Contenuto dell'elemento
(nessuno)

elemento dimensione
Nome tag		dimensione
Descrizione		Una dimensione assegnabile a una transazione. 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 la dimensione.	42
nome	S	Intestazione stampata di questo campo.	Prodotto
Contenuto dell'elemento
Uno o più elementi valore.

elemento text-selector
Nome tag		selettore di testo
Descrizione		Elenco personalizzato di valori definiti per contrassegnare le transazioni.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il selettore di testo.	42
nome	S	Intestazione stampata di questo campo.	Flavor
Contenuto dell'elemento
Uno o più elementi valore.

elemento valore
Nome tag		valore
Descrizione		Uno dei valori definiti per il tipo di inclusione, la dimensione o il selettore di testo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Identificatore numerico interno per il valore.	42
nome	S	Rappresentazione stampata del valore.	Fattura
Contenuto dell'elemento
(nessuno)

elemento di testo
Nome tag		testo
Descrizione		Testo generico corrispondente a una transazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	Descrizione
Contenuto dell'elemento
(nessuno)

elemento numerico
Nome tag		numero
Descrizione		Un numero generico assegnato a una transazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo	Imposta sulle vendite
Contenuto dell'elemento
(nessuno)

elemento data
Nome tag		date
Descrizione		Una data generica assegnata a una transazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	Scadenza
Contenuto dell'elemento
(nessuno)

elemento importo
Nome tag		importo
Descrizione		L'importo monetario richiesto per una transazione.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Intestazione stampata di questo campo.	Importo transazione
Contenuto dell'elemento
(nessuno)