exportTransactionDefinition

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt die Definition (verfügbare Spalten) der Transaktionen in der Instanz zurück.
Zum Aufrufen sind Berechtigungen erforderlich	IMP (Daten importieren) oder Manage_TX (Transaktionsfeld-Definition verwalten)
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das die Definition einer Transaktion in der Instanz beschreibt.

Anforderungsformat


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

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen verfügen, um die Aktion in Reihenfolge für die API auszuführen -Aufruf erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
anmelden	J
Kennwort	J	Das Kennwort des Benutzers, der die API-Methode aufruft.	my_password
Gebietsschema	N	Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet.	fr_FR
instanceCode	N	Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

Antwortformat


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

Jedes Feld für eine Transaktion wird durch eines der folgenden Elemente definiert:

Buchungsdatum (eins)

Art (eins)

Konten (eines)

Ebenen (eine)

Dimension (null oder mehr)

Textauswahl (null oder mehr)

text (null oder mehr)

Zahl (null oder mehr)

Datum (null oder mehr)

Betrag (eins)

Transaktionselement
Tag-Name		Transaktion
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein Feldelement

Element „Felder“.
Tag-Name		Felder
Beschreibung		Container für alle erforderlichen und optionalen Felder
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein Element für jedes der Felder, die jede Transaktion haben sollte.

Element „posting-date“.
Tag-Name		Buchungsdatum
Beschreibung		Das erforderliche Datum, an dem die Transaktion gebucht wurde.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Buchungsdatum
Inhalt des Elements
(Keine)

Das Art-Element
Tag-Name		type
Beschreibung		Die erforderliche Art der Transaktion
Attribute des Elements
Attributname	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Transaktionsart
Inhalt des Elements
Mindestens ein Wertelement.

Kontenelement
Tag-Name		Konten
Beschreibung		Das Konto, zu dem diese Transaktion gehört. Kontometadaten, einschließlich der hierarchischen Struktur, können über einen Aufruf von exportAccounts abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Konto
Inhalt des Elements
(Keine)

Element „Ebenen“.
Tag-Name		Ebene(n)
Beschreibung		Die Ebene, zu der diese Transaktion gehört. Ebenenmetadaten, einschließlich der hierarchischen Struktur, können über einen Aufruf von exportLevels abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	level
Inhalt des Elements
(Keine)

Dimensionselement
Tag-Name		Dimension
Beschreibung		Eine Dimension, die einer Transaktion zuweisbar ist. Vollständige Dimensionsmetadaten, einschließlich ihrer hierarchischen Struktur, können über einen separaten Aufruf von exportDimensions abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für die Dimension.	42
Name	J	Gedruckter Header dieses Felds	Product
Inhalt des Elements
Mindestens ein Wertelement.

Textauswahlelement
Tag-Name		Textauswahl
Beschreibung		Benutzerdefinierte Liste von Werten, die zum Taggen von Transaktionen definiert sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische Kennung für die Textauswahl.	42
Name	J	Gedruckter Header dieses Felds	Konsistenz
Inhalt des Elements
Mindestens ein Wertelement.

Wertelement
Tag-Name		Wert
Beschreibung		Einer der Werte, die für die einschließende Art, Dimension oder Textauswahl definiert sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für den Wert.	42
Name	J	Gedruckte Darstellung des Werts.	Rechnung
Inhalt des Elements
(Keine)

Textelement
Tag-Name		Text
Beschreibung		Generischer Text, der einer Transaktion entspricht.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Beschreibung
Inhalt des Elements
(Keine)

Zahlenelement
Tag-Name		Nummer
Beschreibung		Eine generische Nummer, die einer Transaktion zugewiesen ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Verkaufsteuer
Inhalt des Elements
(Keine)

Datumselement
Tag-Name		date
Beschreibung		Ein generisches Datum, das einer Transaktion zugewiesen ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Fälligkeitsdatum
Inhalt des Elements
(Keine)

Das Betragselement
Tag-Name		Betrag
Beschreibung		Der erforderliche Geldbetrag für eine Transaktion.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Gedruckter Header dieses Felds	Transaktionsbetrag
Inhalt des Elements
(Keine)