importTransactions
Kategorie
| Datenübermittlung |
Beschreibung
| Fügt neue Transaktionen ein. |
Zum Aufrufen sind Berechtigungen erforderlich
| Importieren |
Auf Anforderung erforderliche Parameter
| Credentials, ImportTransactionsOptions, RowData |
Diese Methode wird nur angewendet, wenn Sie Zugriff auf Transaktionen haben.
Sie können Transaktionen nur während des Imports löschen. Wenn Sie beim Import alle Transaktionen entfernen möchten, sollten Sie eine leere Zeile importieren und die verbleibenden Daten löschen.
Diese Methode kann verwendet werden, um vorhandene Transaktionszeilen zu löschen, die bestimmten Kriterien entsprechen, um neue Transaktionszeilen in das System einzufügen oder um beide Aktionen in einem Aufruf auszuführen (d. h. eine Gruppe von Transaktionszeilen durch eine andere Gruppe von Zeilen ersetzen).
Anforderungsformat
<?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>
Jeder Aufruf dieses API-Aufrufs muss genau ein Element von jeder der aufgeführten Arten enthalten:
- -Zugangsdaten
- importTransactionsOptions
- rowData
Eine Nichtübereinstimmung zwischen der Anzahl der senkrechten Striche (|) im Header und den Daten führt zu einem Fehler bei API v30 oder höher.
Element „Zugangsdaten“.
| |||
Tag-Name
| -Zugangsdaten | ||
Beschreibung
| Alle API-Aufrufe müssen eine einzelne enthaltenElement credentials, 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 zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
anmelden | J | Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen. | sampleuser@company.com |
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) | |||
importTransactionsOptions
element
| |||
Tag-Name
| importTransactionsOptions | ||
Beschreibung
| Gibt die Optionen an, die beim Ausführen des Imports verwendet werden sollen. Wenn mindestens eines vondeleteStartDate,deleteEndDate oderTransaktionsarten angegeben sind, versucht dieser Methodenaufruf, alle vorhandenen Transaktionen zu löschen, die diesen angegebenen Kriterien entsprechen. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
deleteStartDate | N | Wenn mit diesem Methodenaufruf einige vorhandene Transaktionen gelöscht werden sollen, gibt dieses Attribut das Startdatum der Gruppe von zu löschenden Transaktionen an (einschließlich). Wenn nicht angegeben, werden alle Transaktionen, die ein Datum am oder vor dem habendeleteEndDate (und welcher mit einer der angegebenen optionalen Daten übereinstimmtTransaktionsarten) werden gelöscht. | 11/01/2012 |
deleteEndDate | N | Wenn mit diesem Methodenaufruf einige vorhandene Transaktionen gelöscht werden sollen, gibt dieses Attribut das Enddatum der Gruppe von zu löschenden Transaktionen an (einschließlich). Wenn nicht angegeben, werden alle Transaktionen, die ein Datum am oder nach dem habendeleteStartDate (und die mit einer der angegebenen Optionen übereinstimmenTransaktionsarten) werden gelöscht. | 12/31/2012 |
Transaktionsarten | N | Eine Reihe von Transaktionsarten, die gelöscht werden, getrennt durch das Pipe-Symbol. Wenn nicht anders angegeben, alle Transaktionen zwischendeleteStartDate unddeleteEndDate wird gelöscht. Wenn neindeleteStartDate oderdeleteEndDate angegeben ist, werden alle Transaktionen der angegebenen Art gelöscht, unabhängig von ihrem Datum. | Bestellauftrag |
AllowParallel | J | Wenn aktiviertwahr, dann wird ein Import fortgesetzt, auch wenn für diese Instanz bereits ein anderer Istzahlen- oder Transaktionsimport in Bearbeitung ist. Wenn aktiviertfalsch: Ein Importversuch schlägt fehl, wenn für diese Instanz bereits ein Istzahlen- oder Transaktionsimport verarbeitet wird. | false |
useMappings | N | Gibt an, ob Import-Mappings für Konten, Pläne und Dimensionswerte innerhalb der Zeilenelemente verwendet werden sollen. Kommt in Fragestandardmäßig „true“ Wennfalse, dann sollten die internen IDs verwendet werden: Konten werden anhand von Code, Ebenen und Dimensionswerte anhand des Namens identifiziert. | false |
includeContext | N | Gibt an, ob Nachrichten den Kontextblock enthalten können. Werte sindfalsch (Kontext nie anzeigen) oderwahr (gegebenenfalls Kontext anzeigen). Falls nicht angegeben„true“ wird angenommen. | false |
displayNameEnabled
Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | displayNameEnabled=true gibt an, dass die API die Spalten "Kontocode", "Ebenencode", "Dimensionscode" und "Dimensionsname" in der Nutzlast erwarten soll, wenn für die Instanz die Einstellung "Anzeigenamen aktivieren" auf EIN gesetzt ist. displayNameEnabled=false gibt an, dass die API weiterhin den API-Vertrag vor v30 befolgen soll, auch wenn für die Instanz die Einstellung "Anzeigename aktivieren" auf EIN gesetzt ist. Der Standardwert für displayNameEnabled ist "false". | false |
Inhalt des Elements
| |||
(Keine) | |||
rowData-Element
| |||
Tag-Name
| rowData | ||
Beschreibung
| Container für die zu importierenden Datenzeilen. | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Genau eineHeader-Element und genau einsZeilenelement | |||
Header-Element
| |||
Tag-Name
| -Header | ||
Beschreibung
| Gibt die Namen und die Reihenfolge der Spalten der Daten in der entsprechenden anZeilenelement | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Eine Textzeile mit durch vertikale Balken getrennten Spaltennamen. Diese Spaltennamen müssen mit den Namen der Dimensionen oder Felder im Tabellenblatt oder mit Monaten übereinstimmen, die Daten enthalten können. Sie sind identisch mit den Spaltennamen in der Importvorlage für das Tabellenblatt, in das die Daten importiert werden, wobei die einzelnen Spalten-Header durch einen vertikalen Balken oder einen senkrechten Strich vom anderen getrennt sind.
Bei Instanzen, die Anzeigename aktivieren, wird der Header nicht unterstützt "<dimension>" in Kombination mit "<dimension> Name" oder "<dimension> Code" in API v30 oder höher für von Adaptive Planning unterstützte Gebietsschemas. | |||
Zeilenelement
| |||
Tag-Name
| Zeilen | ||
Beschreibung
| Container für einen oder mehrereZeilenelementen. | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Einen oder mehrereZeilenelementen. | |||
Zeilenelement
| |||
Tag-Name
| Zeile | ||
Beschreibung
| Daten für eine einzelne Zeile, die importiert wird. | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Daten für die Felder in einer einzelnen Zeile, die importiert werden, wobei der Wert jedes Felds durch einen vertikalen Balken oder einen senkrechten Strich getrennt ist. Die Datenfelder müssen in derselben Reihenfolge sein wie die Zeile im Header-Element. Wenn Zahlen in den Werten Tausendertrennzeichen verwenden, werden diese als Kommastrennzeichen im Gebietsschema verwendet, das in den Zugangsdaten der Anforderung angegeben wurde. | |||
Antwortformat
Dies sind Beispiele für Antworten nach erfolgreichem und nicht erfolgreichem Import von Transaktionsdaten.
Erfolgreiches Beispiel
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <messages> <message key="row-imported">1 row was imported.</message> </messages> </response>
Fehlgeschlagen (mit Kontext)
<?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>
Fehlgeschlagen (kein Kontext)
<?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>
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Beideswahr oderfalsch: Gibt an, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten. | true |
Inhalt des Elements
| |||
Einzelne optionaleNachrichtenelement | |||
Nachrichtenelement
| |||
Tag-Name
| -Nachrichten | ||
Beschreibung
| Container für einen oder mehrere-Nachrichtenelemente. | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Einen oder mehrere-Nachrichtenelemente. | |||
Nachrichtenelement
| |||
Tag-Name
| Nachricht | ||
Beschreibung
| Stellt eine Nachricht dar, die vom System an den Aufrufer zurückgesendet wird. Nachrichten werden für Fehlermeldungen verwendet, wenn Anforderungen nicht erfolgreich sind, als Warnmeldungen, wenn Anforderungen erfolgreich sind, und als Bestätigungsmeldungen bei Erfolgreich. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Schlüssel | N | Wenn ein Schlüssel angegeben wird, kann eine bestimmte Meldung oder eine bestimmte Meldungsart identifiziert werden. Dies ist für eine automatische Fehlerprotokollierung und Wiederherstellung in Client-Programmen hilfreich. Schlüssel ändern sich nicht unter verschiedenen Gebietsschemas von Anforderungen, auch wenn sich die Sprache der Nachricht ändert. Es ist auch fehlgeschlagen, dass sich Schlüssel in Zukunft aufgrund von Wording-Anpassungen oder Änderungen der Terminologie ändern. | invalid-attributevalueid |
Inhalt des Elements
| |||
| |||
-Kontextelement
| |||
Tag-Name
| context | ||
Beschreibung
| Container für ein oder mehrere Spaltenelemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Keine | |||
Inhalt des Elements
| |||
Ein oder mehrere Spaltenelemente | |||
Element col
| |||
Tag-Name
| col | ||
Beschreibung
| Stellt den Kontext für die Nachricht dar. Gibt ein Header/Wert-Paar an, damit die Zeile identifiziert werden kann, die die Meldung generiert. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Header | J | Der Header der Spalte. | "Konto" |
Wert | J | Der Wert in der Spalte. | "GL-29482-38233" |
Inhalt des Elements
| |||
(Keine) | |||