Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2024-09-20
importStandardData

importStandardData

Aktualisiert in API v40 (13. September 2024)
Kategorie
Datenübermittlung
Beschreibung
Fügt Daten in Standardkonten ein oder ersetzt sie.
Zum Aufrufen sind Berechtigungen erforderlich
In alle Speicherorte importieren
Daten löschen (API v36 + zur Unterstützung des Modus „REPLACE“)
Auf Anforderung erforderliche Parameter
Credentials, ImportDataOptions, Version, RowData
includeDescendants
Die Anforderung dieser Methode enthält die Parameter, mit denen bestimmt wird, welche Version die bereitgestellten Datenzeilen erhält. Daten können in jedes Standardkonto (Hauptbuch-Konto, benutzerdefiniertes Konto, Annahme oder Wechselkurs) importiert werden, unabhängig davon, ob das Konto in einem Tabellenblatt platziert wurde.
importStandardData kann nicht in Konten importieren, die
Dateneingabe
 für
Einstellung für Überschreibungsformel
verwenden.

Anforderungsformat


<?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>
Jeder Aufruf dieses API-Aufrufs muss genau ein Element von jeder der aufgeführten Arten enthalten:
  • -Zugangsdaten
  • importDataOptions
  • Version
  • rowData
  • -Header
  • Zeilen
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.
Bei API v36 und höher muss, wenn das Modus-Attribut importDataOptions REPLACE lautet, auch ein Bereichselement angegeben werden:
Beispiel: Anforderung für Modus "Ersetzen".
Nur in API v36 und höher verfügbar
 

<?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>
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).Zeitperiodennamen und 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)
importDataOptions element
Tag-Name
importDataOptions
Beschreibung
Gibt die Optionen an, die beim Ausführen des Imports verwendet werden sollen.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
planOrActuals
J
Legen Sie eines von "Plan" oder "Istzahlen“, um die Art der zu importierenden Daten anzugeben. Wenn diese Einstellung in Konflikt mit der in angegebenen Version stehtVersions-TagDer Wert des Versions-Tags hat Vorrang und diese Einstellung wird ignoriert.
Plan
moveBPtr
N
Wird nur verwendet, wenn dieAttribut planOrActuals ist auf gesetztIst. WennmoveBPtr ist auf gesetztwahr ist, verschiebt der Import den Istzahlen-Verfügbarkeitszeiger in der Istzahlen-Version in die letzte Zeitperiode, die in den importierten Daten gefunden wurde. Wenn aktiviertfalsch: Der Import hat keine Auswirkungen darauf, welche Zeitperioden in welcher Version Istzahlen anzeigen. Dieses Attribut muss auf "false" gesetzt werden, wennplanOrActuals ist auf gesetztPlanen.
false
allowParallel
J
Wird nur verwendet, wenn dieAttribut planOrActuals ist auf gesetztIst. 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 v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
displayNameEnabled=true gibt an, dass importStandardData erwarten sollte
Account Code
,
Level Code
,
Dimension Code
und
Dimension Name Column
 in der Nutzlast, wenn Anzeigename aktivieren für die Instanz auf EIN gesetzt ist.
displayNameEnabled=false gibt an, dass die importStandardData-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die importStandardData-API ignoriert die Eigenschaften des Anzeigenamens
Account Code
,
Level Code
,
Dimension Code
, und
Dimension Name Column
.
Der Standardwert für displayNameEnabled ist "false".
false
splitsToUnsplit
Nur in API v40 und höher verfügbar
N
splitsToUnsplit = true ermöglicht den Import von Splits in einen Speicherort ohne Split mit vorhandenen Daten. Der Standardwert für dieses Attribut ist "false".
false
-Modus
Nur in API v36 und höher verfügbar
N
Gibt den Importmodus an, der entweder Append oder ERSETZEN ist.
Anhängen
Vorhandene Fakten werden aktualisiert oder neue Fakten hinzugefügt. Es werden keine Fakten gelöscht.
Ersetzen
Die Anforderung muss ein Bereichselement enthalten, das die Koordinaten des Hypercube darstellt, in dem Daten durch die in der Nutzlast bereitgestellten Daten ersetzt werden. Alle vorhandenen Daten innerhalb des Bereichs, die keine übereinstimmende Koordinate in der Nutzlast haben, werden gelöscht.
Dieses Modus-Attribut wird von API v36 und späteren Versionen unterstützt. Das Aufrufen einer früheren Version der API mit mode="REPLACE" ist ein Fehler.
Der Standardwert für "modus" ist Append, wenn nicht angegeben.
ANBIETEN
Inhalt des Elements
(Keine)
-Versionselement
Tag-Name
Version
Beschreibung
Gibt an, welche Version zum Empfangen der angeforderten Daten verwendet werden soll. Für jeden Aufruf muss eine Version angegeben werden.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Namen
N
Der Name der Version, die zum Empfangen der Daten verwendet werden soll. Mit einem einzigen API-Aufruf kann nur auf eine Version zugegriffen werden. Wenn kein Name angegeben wird, geschieht diesDas Kennzeichen isDefault muss für dieses Element auf "true" gesetzt werden.
Um eine Liste der umgerechneten Währungsversionen und deren Namen zu erhalten, stellen Sie eineexportVersions- Anforderung mit currencyVersions=true im Element include.
Budget 2014
isDefault
N
Wenn der Aufrufer unabhängig von ihrem Namen auf die aktuelle Standardversion der Instanz zugreifen möchte, kann dieses Attribut auf „true“ gesetzt werden. In diesem Fall wird das Attribut „name“ des Tags (falls vorhanden) ignoriert. Andernfalls, wenn dieser Wert falsch ist oder dieses Attribut nicht vorhanden ist, muss eine Version mit dem angegebenen Namen vorhanden und für den Benutzer zugänglich sein, damit dieser Aufruf erfolgreich ist.
false
Inhalt des Elements
(Keine)
Bereichselement
Tag-Name
-Bereich
Nur verfügbar in API-Version 36+
Beschreibung
Gibt den Bereich für diesen Import an.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
eraseCellNotes
N
Gibt an, ob Zellnotizen im Bereich gelöscht werden sollen oder nicht. Muss einer von drei Aufzählungswerten sein:
KEINE
 – Zellnotizen nicht löschen.
ALLE
 : Löscht alle Zellnotizen innerhalb des Bereichs.
modifizierte Version
 : Löscht die Zellnotizen für Zellen im Bereich, die durch den Import geändert wurden. Dazu gehören zuvor leere Zellen, in die Fakten importiert wurden, und Zellen, deren Fakten gelöscht wurden.
Wenn „eraseCellNotes“ nicht angegeben ist, wird standardmäßig NONE verwendet.
KEINE
Inhalt des Elements
Ein
Zeitelement
 , ein
Kontenelement
 und ein
Ebenenelement
 , die alle obligatorisch sind.
Kontenelement
Tag-Name
Konten
Nur verfügbar in API-Version 36+
Beschreibung
Gibt die Konten für den Importbereich an. Wenn ein angegebenes Konto vorhanden ist, aber die Importdaten keine Daten für dieses Konto enthalten, werden Daten in diesem Konto für den Zeitbereich und die restlichen Koordinaten des Bereichs entfernt.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt den Modus für den Kontobereich an. Muss eine der folgenden drei Optionen sein.
EXPlicIT
 : Wenn dieser Modus angegeben ist, werden ein oder mehrere Kontounterelemente erwartet, die den Kontobereich für den Import bestimmen.
INPUT
 : Wenn dieser Modus angegeben ist, wird der Kontobereich durch den eindeutigen Satz von Konten festgelegt, die in den Importdaten vorhanden sind.
Hinweis: Kontenmodus = "ALLE" ist für den Standardimportbereich nicht zulässig.
EXPLIZIT
Inhalt des Elements
Wenn der Modus
"INPUT"
lautet, dürfen keine <account>-Unterelemente vorhanden sein.
Wenn "modus"
auf EXPlicIT gesetzt
ist, müssen ein oder mehrere <account>-Unterelemente vorhanden sein.
Wenn stellenweise
auf EXPlicIT gesetzt
ist und ein Kontocode in einem Unterelement <account> ungültig ist, wird das gesamte Element <accounts> und damit auch der <bereich> als ungültig angesehen. Die Antwort enthält für jeden ungültigen Code eine Fehlermeldung.
Kontoelement
Tag-Name
account
Nur verfügbar in API-Version 36+
Beschreibung
Gibt den Kontocode an, der in den Bereich für den Import aufgenommen werden soll.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
includeDescendants
N
Wenn das Konto ein Leaf-Konto ist, hat includeDescendants keine Auswirkungen.
Wenn das Konto ein übergeordnetes Konto ist und dieses Attribut als „Wahr“ angegeben wird, werden alle Leaf-Nachfolger dieses Kontos im Bereich eingeschlossen.
Wenn das Konto ein übergeordnetes Konto ist und includeDescendants auf "false" gesetzt ist, handelt es sich um einen Fehler. Wir können nur in Leaf-Konten importieren.
Dies ist ein optionales Attribut und der Standardwert wird als falsch betrachtet.
true
-Auswahl
N
Gibt die Inhaltsart des Kontoelements an:
  • Code. Der Inhalt des Kontoelements ist ein Kontocode. Beispiel:
    <account selector="code">30440</account>
    In diesem Beispiel ist 30440 ein Kontocode.
  • Art Der Inhalt des Kontoelements ist eine Kontoart. Beispiel:
    <account selector="type">GL</account>
    In diesem Beispiel umfasst die Kontoelementart alle Hauptbuch-Konten. Derzeit unterstützen wir nur "Hauptbuch" und "Benutzerdefiniert" als Kontoart für Standardimporte. Alle anderen Inhalte führen zu Fehlern.
Der Standardwert für die Auswahl ist „Code“.
Inhalt des Elements
Der Kontocode des Kontos, das als Teil des Importbereichs verwendet wird. Dabei wird zwischen Groß- und Kleinschreibung unterschieden. Beispiel: AccountsPayable. Der Code darf nicht leer sein und das dem Code entsprechende Konto muss vorhanden sein. Das Konto kann kein Systemkonto oder ein verknüpftes Konto sein. Wenn es sich bei dem Konto um ein berechnetes Konto handelt, muss für dieses Konto eine Überschreibung durch Dateneingabe vorhanden sein. Andernfalls wird es als ungültig betrachtet.
Wenn ein Kontocode ungültig ist, wird das gesamte Element <accounts> und damit auch der Bereich <bereich> als ungültig angesehen.
Element „Ebenen“.
Tag-Name
Ebene(n)
Nur verfügbar in API-Version 36+
Beschreibung
Gibt die Ebenencodes für den Importbereich an. Wenn hier ein Ebenencode angegeben ist, die Importdaten jedoch keine Daten für diese Ebene enthalten, werden Daten in dieser Ebene für den Zeitbereich und die restlichen Bereichkoordinaten entfernt.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt den Modus für den Ebenenbereich an. Muss eine der folgenden drei Optionen sein.
EXPlicIT
 : Wenn dieser Modus angegeben ist, werden ein oder mehrere Unterelemente der Art "<level>" erwartet, die den Ebenenbereich für den Import bestimmen.
INPUT
 : Wenn dieser Modus angegeben ist, wird der Ebenenbereich durch den eindeutigen Satz von Ebenen festgelegt, die in den Importdaten vorhanden sind.
ALLE
 : Wenn dieser Modus angegeben ist, umfasst der Ebenenbereich alle importierbaren Ebenen.
EXPLIZIT
Inhalt des Elements
Wenn der Modus "INPUT" oder "ALL" lautet, darf es keine Unterelemente der Art "<level>" geben.
Wenn "modus" auf EXPlicIT gesetzt ist, müssen ein oder mehrere Unterelemente der Art "<level>" vorhanden sein.
Wenn "modus" auf EXPlicIT gesetzt ist und ein Ebenencode in einem Unterelement "<level>" ungültig ist, wird das gesamte Element "<levels>" und damit auch "<Bereich>" als ungültig angesehen. Die Antwort enthält für jeden ungültigen Code eine Fehlermeldung.
Ebenenelement
Tag-Name
level
Nur verfügbar in API-Version 36+
Beschreibung
Gibt den Ebenencode an, der für den Import in den Bereich aufgenommen werden soll.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
includeDescendants
N
Wenn die Ebene eine übergeordnete Ebene ist und dieses Attribut als „true“ angegeben wird, werden alle Leaf-Nachfolger dieser Ebene, einschließlich sich selbst (der Knoten Only), in den Bereich eingeschlossen.
Dies ist ein optionales Attribut.
Wenn das Attribut nicht angegeben wird, ist der Standardwert falsch. Wenn das Attribut nicht oder als „false“ angegeben wird und die angegebene Ebene eine übergeordnete Ebene ist, würde dies bedeuten, dass für den Import der Knoten „Ausschließlich“ (Beispiel: „Nur Engineering“) für diese Ebene als Bereich berücksichtigt wird. Untergeordnete Ebenen werden nicht in den Bereich aufgenommen, es sei denn, dies wird explizit von anderen Ebenenelementen angegeben.
true
Inhalt des Elements
Gibt den zwischen Groß- und Kleinschreibung unterscheidenden Code der Ebene an. Beispiel: <level>Deployment: <level>.
Bei einem Problem mit dem Ebenencode, z. B. einer Ebene, auf der der Code nicht gefunden wird, werden die gesamten <Ebenen> und damit auch der <Bereich> als ungültig angesehen. Die Antwort enthält für jeden ungültigen Code eine Fehlermeldung.
Zeitelement
Tag-Name
time
Nur verfügbar in API-Version 36+
Beschreibung
Gibt einen oder mehrere Zeitbereiche an, die den Zeitbereich für den Import darstellen.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt den Modus für den Zeitbereich an. Dies muss eine der folgenden drei Optionen sein.
INPUT
 – Wenn dieser Modus angegeben ist, wird der Zeitbereich durch die Zeitcodes in bestimmt
<header>
 -Element. Wenn der Header zwei Monate enthält, sind diese zwei Monate der Bereich für den Import.
EXPlicIT
 : Wenn dieser Modus angegeben ist, werden ein oder mehrere timeRange-Unterelemente erwartet, die den Zeitbereich für den Import bestimmen.
VERSION
 : Wenn dieser Modus angegeben ist, entspricht der Zeitbereich dem Start und Ende der Version einschließlich aller Ausgangssaldoperioden.
Auf den Modus "INPUT" oder "VERSION" ist kein Unterelement "timeRange" zulässig. Wenn timeRange-Unterelemente vorhanden sind, wird dies als Fehler behandelt.
EINGABE
Inhalt des Elements
Ein oder mehrere timeRange-Elemente, es sei denn, „modus“ ist „INPUT“ oder „VERSION“.
timeRange-Element
Tag-Name
timeRange
Nur verfügbar in API-Version 36+
Beschreibung
Gibt einen einzelnen Zeitbereich für den Zeitbereich an.
Nur zulässig, wenn das Attribut "modus" des Elements "importDataOptions" "REPLACE" lautet.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Anfang
J
Die Startperiode für den Importzeitbereich.
07/2021
Ende
J
Die Endperiode für den Importzeitbereich.
08/2021
Inhalt des Elements
Ein oder mehrere timeRange-Elemente, es sei denn, „modus“ ist „INPUT“ oder „VERSION“.
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 Zeitperiodencodes ü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 Standardkontodaten.

Erfolgreiches Beispiel


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

Fehlgeschlagen (mit Kontext)


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

Fehlgeschlagen (kein Kontext)


<?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>
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
  1. Der Text der Nachricht. Dieser Text ist in der Sprache des in der Anforderung angegebenen Gebietsschemas (vorausgesetzt, das Gebietsschema wird unterstützt). Der Text kann auch variable Informationen enthalten, z. B. die Anzahl der verarbeiteten Zeilen oder die bestimmte Spalte oder den Wert, die einen Fehler verursacht haben.
  2. Ein optionales Kontextelement.
-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)