exportData

Adaptive Planning

Was ist neu? (Workday 2025R2)

exportData

Kategorie	Datenabruf
Beschreibung	Gibt einen Datensatz aus der angeforderten Version in der Anforderungsinstanz zurück.
Zum Aufrufen sind Berechtigungen erforderlich	Keine (es müssen gültige Zugangsdaten für die Instanz sein)
Auf Anforderung erforderliche Parameter	Zugangsdaten, Version, Format, Filter

Die Anforderung dieser Methode enthält die Parameter, mit denen die Daten in der angegebenen Version durchsucht werden, und gibt Werte zurück, die den angeforderten Filtern und dem angeforderten Format entsprechen. Dies ist die grundlegende Methode zum Abrufen von Daten aus Adaptive Planning. Mit ihr können Werte aus beliebigen Konten abgerufen werden, einschließlich Standardkonten, Hauptbuch-Konten, modellierten Konten, Cube-Konten, benutzerdefinierten Konten, Metrikkonten, Annahmen und Wechselkursen.

Wenn Sie eine Planversion exportieren, schließt Ihr Export Istdaten für alle Istzahlen-Überlagerungsperioden ein. Sie sehen Ist- oder Plandaten wie in der Benutzeroberfläche des Tabellenblatts.

Die Werte einzelner Splits werden beim Export nach aggregiert

exportData.

Für API v16 und höher:

exportData

exportiert auch Daten für virtuelle Versionen.

Siehe: customReportValuesfür einen zielgerichteteren Ansatz für den Datenabruf.

Siehe: Referenz: exportData Performance erfahren Sie, wie Sie sicherstellen können, dass Ihre Anforderungen von den in 2024R1 für API v39 veröffentlichten Verbesserungen an Performance und Skalierbarkeit profitieren.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportData" callerName="a string that identifies your client application" stream="true">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<version name="Budget 2014" isDefault="false"/>
<format useInternalCodes="true" includeUnmappedItems="false" />
<filters>
<accounts>
<account code="A100" isAssumption="true" includeDescendants="false"/>
<account code="L100" isAssumption="false" includeDescendants="true"/>
</accounts>
<levels>
<level name="Development" isRollup="true" includeDescendants="true"/>
<level name="QA" isRollup="false" includeDescendants="false"/>
</levels>
<dimensionValues>
<dimensionValue dimName="Customer" name="A Corp" directChildren="true"/>
<dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/>
</dimensionValues>
<timeSpan start="11/2013" end="12/2014"/>
</filters>
<dimensions>
<dimension name="Product"/>
<dimension name="CountryRegion"/>
</dimensions>
<rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single">
<currency useCorporate="false" useLocal="false" override="AUD"/>
</rules>
</call>

Jeder Aufruf dieses API-Aufrufs muss genau ein Element von jeder der aufgeführten Arten enthalten:

anzurufen

-Zugangsdaten

Version

format

Eine Anforderung kann auch eines der folgenden Elemente enthalten:

Filter

Konten > Konto

Ebenen > Ebene

dimensionValues > dimensionValue

timeSpan

Dimensionen > Dimension

Regeln > Währung

-Aufruf-Element
Tag-Name		anzurufen
Beschreibung		Gibt an, welche API-Methode mithilfe ihres Methodenattributs aufgerufen wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Methode	J	Die Methode, die aufgerufen wird.	exportData
callerName	J	Eine Zeichenfolge, die Ihre Client-Anwendung identifiziert.	"Client-Beispielanwendung für Adaptive Planning"
stream Verfügbar in API v39 und höher	N	Ermöglicht exportData, Daten zurück zum Client zu starten, sobald sie verarbeitet werden. Standardmäßig ist „false“ festgelegt. Beachten Sie, dass für die Aktivierung von Stream in exportData Änderungen am Antwortformat erforderlich sind.	wahr
Inhalt des Elements
Genau ein Element von jeder der folgenden Arten: -Zugangsdaten Version format

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 zum Ausführen der Aktion verfügen, damit der API-Aufruf erfolgreich ist .. Die Berechtigung „Exportmöglichkeiten“ in der Planning-Benutzeroberfläche hat keine Auswirkungen auf exportData.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
login	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 Adaptive Planning hat, kann dieses Attribut 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)

-Versionselement
Tag-Name		Version
Beschreibung		Gibt an, welche Version zum Abrufen der angeforderten Daten verwendet werden soll. Für jeden Aufruf muss eine Version angegeben werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	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, muss das Kennzeichen isDefault für dieses Element auf „true“ gesetzt werden.	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)

-Formatelement
Tag-Name		format
Beschreibung		Gibt die Art der Formatierung an, die in den einzelnen Feldern der zurückzugebenden Daten verwendet werden soll.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
useInternalCodes	J	Auf "Wahr" setzen, damit Kontocodes und Ebenencodes mit den Codes ausgegeben werden, die für jeden in der Konto- und Ebenenverwaltung eingegeben wurden. Setzen Sie diese Option auf "false", damit die Codes in den Ausgabedaten mithilfe der Exportkonto-Mappings oder Exportebenen-Mappings auf dem Register Export gemappt werden.	wahr
useIds	N	Auf "true" setzen, damit die Konten, Ebenen und Dimensionen in Antworten in ihren IDs anstatt in ihren Codes wiedergegeben werden. Außerdem müssen die Konten, Ebenen und Dimensionen im Abschnitt „“, in ihren IDs wiedergegeben werden. Der Standardwert ist „false“, wenn er in der Anforderung nicht vorhanden ist.	wahr
includeUnmappedItems	N	Dieses Attribut gilt nur, wenn useInternalCodes auf „false“ gesetzt ist und Export-Mappings verwendet werden. Wenn nicht anders angegeben, werden Elemente, die auf dem Register "Export" kein Export-Mapping haben, nicht in der Ausgabe ausgegeben. Wenn includeUnmappedItems auf "true" gesetzt ist, werden Konten oder Ebenen ohne Export-Mapping ausgegeben. Dabei werden ihre internen Codes (die in der Konto- oder Ebenenverwaltung festgelegten Codes) als Codes verwendet, was eine Mischung aus gemappten und nicht gemappten Elementen in ergibt -Daten, aber ein vollständiger Datensatz. Wenn dieses Kennzeichen auf "false" gesetzt ist, werden einige angeforderte Elemente möglicherweise nicht ausgegeben, wenn diese Elemente kein Export-Mapping haben.	false
includeCodes	N	Diese Option ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens EIN ist. Auf "true" setzen, um die Spalte "Code" für "Ebene" in die API-Antwort aufzunehmen. Auf "false" setzen, um die Codespalte für die Ebene in der API-Antwort auszuschließen. Der Standardwert ist „false“.	false
includeNames Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	Diese Option ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens EIN ist. Setzen Sie "true", um die Namensspalte für die Ebene in die API-Antwort aufzunehmen. Setzen Sie "false", um die Namensspalte für die Ebene in der API-Antwort auszuschließen. Der Standardwert ist „false“.	false
includeDisplayNames Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	Diese Option ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens EIN ist. Setzen Sie "true", um die Spalte "Anzeigename" für die Ebene in die API-Antwort aufzunehmen. Setzen Sie "false", um die Spalte "Anzeigename" für "Ebene" in der API-Antwort auszuschließen. Der Standardwert ist „false“.	false
displayNameEnabled Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	displayNameEnabled=true gibt an, dass die exportData-API das Codeattribut in der Anforderung benötigt, um die Ebenen- und Dimensionsentitäten anzugeben, wenn Enable Anzeige Name für die Instanz auf EIN gesetzt ist. displayNameEnabled=false gibt an, dass die exportData-API weiterhin den API-Vertrag vor v30 befolgt, auch wenn für die Instanz die Einstellung "Anzeigenamen aktivieren" auf EIN gesetzt ist. Das Namensattribut wird anstelle des Code-Attributs verwendet. Für jede Ebene und Dimension müssen die Attributwerte "Name" und "Code" übereinstimmen. Der Standardwert für displayNameEnabled ist "false".	false
Inhalt des Elements
(Keine)

filtert Element
Tag-Name	Filter
Beschreibung	Enthält die Spezifikationen für die Filter, die bestimmen, welche Daten aus der angeforderten Version von der API abgerufen werden. Dieses Element gibt die Konten, Ebenen, Monate und Dimensionswerte an, die abgerufen werden sollen.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein einzelnes erforderliches Element „Konten“, ein einzelnes optionales Element „Ebenen“, ein einzelnes erforderliches Element „Zeitspanne“ und ein optionales einzelnes Element „DimensionValues“.

Kontenelement
Tag-Name	Konten
Beschreibung	Container für ein oder mehrere Kontoelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Einem oder mehreren Kontoelementen.

Kontoelement
Tag-Name		account
Beschreibung		Gibt ein Konto an, dessen Daten beim API-Aufruf exportData exportiert werden sollen. Wenn mehr als ein Kontoelement innerhalb des Kontoelements platziert wird, werden alle Konten exportiert, die mit einem der Kontoelemente übereinstimmen. Wenn ein bestimmtes Kontoelement zu keinen übereinstimmenden Konten führt, wird dieses Element ignoriert, während die anderen Elemente weiterhin gelten.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Der Code des zu exportierenden Kontos. Dieser Code wird in der Kontoverwaltung angegeben.	Current_Assets
isAssumption	J	Gibt an, ob der Code ein Annahme- oder ein Nicht-Annahmekonto angibt. Sie können einen einzigen Code sowohl für eine Annahme als auch für ein Konto verwenden. Verwenden Sie dieses Kennzeichen, um die Art des Kontos anzugeben.	false
includeDescendants	J	Gibt an, ob der Export alle Nachfolger des angegebenen Kontos einschließen soll oder nicht. Wenn auf „true“ gesetzt, werden alle untergeordneten Elemente dieses Kontos exportiert, ebenso wie ihre untergeordneten Konten usw. Bei "false" wird dieses Konto als einzelner Rollup-Kontowert exportiert.	wahr
Inhalt des Elements
(Keine)

Element „Ebenen“.
Tag-Name	Ebene(n)
Beschreibung	Container für ein oder mehrere Ebenenelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein oder mehrere Ebenenelemente. Wenn die Anforderung unzugängliche Ebenen enthält, gibt es nur ein Ebenenelement, das die oberste Ebene der Organisation darstellt.

Ebenenelement
Tag-Name		level
Beschreibung		Gibt eine Organisationsebene an, deren Daten beim API-Aufruf exportData exportiert werden sollen. Wenn mehr als ein Ebenenelement innerhalb des Ebenenelements platziert wird, werden alle angegebenen Ebenen exportiert. Wenn ein bestimmtes Ebenenelement keine übereinstimmenden Ebenen in der Instanz hat, wird dieses Element ignoriert, während die anderen Elemente weiterhin gelten. Wenn alle folgenden Bedingungen erfüllt sind, müssen Sie nach Code und nicht nach Name filtern: Die Instanz aktiviert doppelte Metadaten, indem sie Anzeigename aktiviert. API v30 oder höher wird aufgerufen. Die displayNameEnabled-Eigenschaft des Formatelements ist „true“.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	J Code und Name schließen sich immer gegenseitig aus. Wenn diese beiden Bedingungen zutreffen, sollten Sie nur Code verwenden: Die Einstellung "Anzeigename aktivieren" ist EIN displayNameEnabled="true" im Element „Format“. Andernfalls keinen Code einschließen.	Der Code der zu exportierenden Ebene. Dieser Code ist in der Organisationsverwaltung angegeben. Code wird nur unterstützt, wenn die Einstellung für die effektive Aktivierung des Anzeigenamens EIN ist.	Entwicklung
Name	J Der Name schließt sich mit dem Code immer gegenseitig aus. Wenn displayNameEnabled="false" im Element "Format" ist, sollten Sie nur den Namen verwenden. Dies ist die Standardvorgabe, wenn nicht angegeben.	Der Name der zu exportierenden Ebene. Dieser Name ist in der Organisationsverwaltung angegeben. Der Name wird nur für API-Anforderungen vor v30 unterstützt, wenn die effektive Einstellung für den Anzeigenamen AUS ist. Da die API Ebenen abruft, indem ihr Code-Attribut mit der in der Anforderung enthaltenen Namenszeichenfolge abgeglichen wird, wird das Namensattribut funktional als Code-Attribut behandelt. Um Ebenen erfolgreich nach Namen abzurufen, müssen ihre Namens- und Codeattribute übereinstimmen.	Entwicklung
isRollup	J	Wenn diese Ebene untergeordnete Ebenen hat, gibt isRollup="true" den Rollup-Wert für die Ebene (einschließlich der Werte aller untergeordneten Ebenen) aus und isRollup="false" gibt nur den Wert „Ohne Kategorie“ für die Ebene aus (die Werte, die unter „Bearbeiten“ eingegeben wurden den Daten für diese Ebene). Wenn diese Ebene keine untergeordneten Ebenen hat, muss isRollup auf „false“ gesetzt (oder im Tag ganz ausgelassen) werden.	false
includeDescendants	J	Gibt an, ob der Export alle Nachfolger der angegebenen Ebene einschließen soll oder nicht. Wenn auf „true“ gesetzt, werden auch alle untergeordneten Ebenen exportiert, ebenso wie ihre untergeordneten Ebenen usw. Bei "false" wird diese Ebene allein exportiert. Beachten Sie, dass sich dies von isRollup unterscheidet: isRollup beeinflusst, welcher Wert für diese Ebene ausgegeben wird, während include Descendants angibt, ob auch Nachfolger in den Export aufgenommen werden sollen. Wenn isRollup und includeDescendants auf „true“ gesetzt sind und die Ebene eine übergeordnete Ebene ist, enthält die Ausgabe Werte für Rollup-Ebenen und Nicht-Rollup-Ebenen (ohne Kategorie) für diese Ebene und alle ihre Nachfolger.	wahr
Inhalt des Elements
(Keine)

Element „Zeitspanne“.
Tag-Name		timeSpan
Beschreibung		Gibt an, welche Zeitperioden in der Antwort zurückgegeben werden sollen. Zeitperioden zwischen dem angegebenen Bereich (einschließlich) werden als separate Datenspalten in die Ausgabe aufgenommen. sie werden nicht aggregiert oder zusammengefasst.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Anfang	J	Der Code der ersten Zeitperiode im Zeitperiodenbereich, deren Daten exportiert werden sollen. Die Startzeitperiode muss eine Leaf-Zeitperiode sein.	01/2015
Ende	J	Der Code der letzten Zeitperiode im Zeitperiodenbereich, für die die Daten exportiert werden sollen. Die Endzeitperiode muss eine Leaf-Zeitperiode sein.	03/2015
stratum	N	Der Code der Zeitschicht für die exportierten Daten. Wenn angegeben, müssen die Start- und Endzeitperioden innerhalb der Zeitschicht liegen. Die Zeitschicht muss größer oder gleich dem Konto mit der höchsten Zeitschicht in der Anforderung sein. Siehe: Standardzeitschichten ändern. Standardzeitschichten für Cube- und modellierte Tabellen mit Daten ändern. Wenn Sie beispielsweise die Schicht „Quartal“ angeben, müssen alle Konten die Schicht „Quartal“, „Jahr“ oder größer haben.	month
Inhalt des Elements
(Keine)

Element dimensionValues
Tag-Name	dimensionValues
Beschreibung	Container für ein oder mehrere DimensionValue-Elemente. Dieses Element ist optional und sollte nicht angezeigt werden, wenn keine Filterung für Dimensionswerte erforderlich ist.
Attribute des Elements
(Keine)
Inhalt des Elements
Mindestens ein dimensionValue-Element

Element dimensionValue
Tag-Name		dimensionValue
Beschreibung		Gibt an, dass die exportierten Daten nur Werte enthalten sollen, die mit dem angegebenen Wert für dimensionValue übereinstimmen. Mehrere Werte aus verschiedenen Dimensionen im Element dimensionValues verhalten sich, als wäre sie nach ihren Dimensionen gruppiert. Daten werden zurückgegeben, wenn mindestens einer der Dimensionswerte in jeder Dimension übereinstimmt. Bei Dimensionswerten innerhalb derselben Dimension können die Daten für jeden Dimensionswert übereinstimmen. Beispiel: Wenn für eine Anforderung die Dimensionswerte Region = Ost, Region = West und Produkt = Produkt_A angegeben sind, müssen die Daten entweder mit der Region Ost oder West übereinstimmen, aber auch mit dem Produkt Produkt_A, um exportiert zu werden. Wenn alle folgenden Bedingungen erfüllt sind, müssen Sie nach Code und nicht nach Name filtern: Die Instanz aktiviert doppelte Metadaten, indem sie Anzeigename aktiviert. API v30 oder höher wird aufgerufen. Die Eigenschaft displayNameEnabled des Elements format ist wahr.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
dimName	N	Der Name der Dimension, zu der der Dimensionswert gehört (siehe Namensattribut unten).	Region
-Code Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	Der Code des zu exportierenden Dimensionswerts. Das Attribut „Code“ ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens für die Instanz EIN ist.
Name	N	Der Name des zu exportierenden Dimensionswerts. Der Name wird nur für API-Anforderungen vor v30 unterstützt, wenn die effektive Einstellung für den Anzeigenamen AUS ist.	USA West
directChildren	N	Wenn auf „true“ gesetzt, führt dies dazu, dass die API Rollup-Daten für jedes der direkt untergeordneten Elemente dieses Dimensionswerts exportiert, aber kein Rollup für den Wert selbst. Mit anderen Worten, exportData exportiert die Werte, die sich im Dimensionsbaum aus dem angegebenen Wert „eine Ebene nach unten“ befinden. Wenn nicht angegeben, wird standardmäßig „false“ verwendet.	false
Ohne Kategorie	N	Wenn dieser Wert auf „true“ gesetzt ist, wird der Wert „ohne Kategorie“ des Dimensionswerts abgeglichen und nicht die Werte seiner Nachfolgerwerte (falls vorhanden). Hat keine Auswirkungen auf Dimensionswerte ohne untergeordnete Elemente. Wenn nicht angegeben, wird standardmäßig „false“ verwendet.	wahr
uncategorizedOfDimension	N	Geben Sie uncategorizedOfDimension anstelle der Attribute dimName/name an. Wenn angegeben, sollte der Wert des Attributs eine interne System-ID-Nummer einer Dimension (nicht ein Dimensionswert) sein und der Filter gibt an, dass Daten in dieser Dimension vollständig ohne Kategorie sein müssen, damit sie mit dem Filter übereinstimmen. Die Attribute "directChildren" und "uncategorized" werden ignoriert und als "false" bzw. "true" angenommen. Wird ignoriert, wenn dimName angegeben ist.	15
directChildrenOfDimension	N	Geben Sie direktChildrenOfDimension anstelle der Attribute dimName/name an. Wenn angegeben, sollte der Wert des Attributs eine interne System-ID-Nummer einer Dimension (nicht ein Dimensionswert) sein und der Filter gibt alle Dimensionswerte der ersten Ebene der Dimension an. Die Attribute "directChildren" und "uncategorized" werden ignoriert und als „true“ bzw. „false“ angenommen. Wird ignoriert, wenn dimName oder uncategorizedOfDimension angegeben ist.	12
id	N	Geben Sie die ID anstelle der Attribute dimName/name an. Die interne System-ID des zu exportierenden Dimensionswerts. Muss anstelle der Attribute dimName/name angegeben werden, um den Dimensionswert anzugeben. Informationen zu internen IDs finden Sie in der exportDimensions-API. Wird ignoriert, wenn dimName, uncategorizedOfDimension oder DirectChildrenOfDimension angegeben ist.	14
Inhalt des Elements
(Keine)

Element „Dimensionen“.
Tag-Name	Dimensionen
Beschreibung	Container für ein oder mehrere Dimensionselemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein oder mehrere Dimensionselemente.

Dimensionselement
Tag-Name		Dimension
Beschreibung		Gibt an, dass die exportierten Daten nach der angegebenen Dimension aufgegliedert oder in Slices aufgeteilt werden sollen. Beachten Sie, dass dieses Tag kein Teil des Filter-Tags ist und die Filterung nicht steuert. Stattdessen steuert es, wie viele Zeilen für jede Kombination aus Konto/Ebene exportiert werden. Für jede im Dimensions-Tag angegebene Dimension wird jede vorhandene Wertekombination als separate Datenzeile exportiert. Jede Dimension, die im Element „Dimensionen“ vorhanden ist, führt auch dazu, dass in der Ausgabe eine zusätzliche Spalte angezeigt wird, die mit dem Namen dieser Dimension gekennzeichnet ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Name der Dimension, nach der der Export segmentiert werden soll. Datenzeilen im Export, die nicht nach der Dimension segmentiert werden können, werden nur einmal angezeigt und zeigen den Dimensionsnamen selbst in der Spalte an, in der der Name des Dimensionswerts für diese Dimension angezeigt werden würde.	Customer
Inhalt des Elements
(Keine)

Element „Regeln“.
Tag-Name		Regeln
Beschreibung		Gibt einige zusätzliche Ausgaberegeln an, die steuern, welche Arten von Zeilen ausgegeben werden und wie einige Feldwerte gerendert werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
includeZeroRows	N	Auf "true" setzen, um Zeilen auszugeben, auch wenn sie nur Nullen oder Leerstellen enthalten. Auf „false“ setzen, um Zeilen ohne Daten aus der Ausgabe wegzulassen. Der Standardwert ist „false“. Diese Option ist in der Benutzeroberfläche der Anwendung für Exporte, die Dimensionen enthalten, nicht verfügbar. Bei API-Aufrufen wird „Wahr“ ignoriert, wenn Daten nach Dimension exportiert werden. Es werden nur Daten für Dimensionswerte ausgegeben, die Daten enthalten.	wahr
includeRollups Verfügbar in API v24 und früher. Nicht verfügbar in API v25 und höher.	N	Wenn auf „true“ gesetzt, werden Rollup-Werte für alle Konten und Ebenen im Filter-Tag zusätzlich zu den Werten für ihre Nachfolger eingeschlossen. Dieses Attribut hat keine Auswirkungen darauf, wie sich benutzerdefinierte Dimensionen verhalten, die in dimensionValue-Filtern oder im Dimensions-Tag angegeben sind. Der Standardwert ist „false“. Das Kennzeichen includeRollups wird nur angewendet, wenn keine explizite Filterung für Konten oder Ebenen angewendet wird. Wenn einzelne Konten in einem Filter enthalten sind, müssen Sie die einzelnen Rollup-Konten angeben, falls diese eingeschlossen werden sollen.	false
includeRollupAccounts Verfügbar in API v25 und höher.	N	Wenn auf „true“ gesetzt, werden Rollup-Werte für alle Konten im Filter-Tag zusätzlich zu den Werten für ihre Nachfolger eingeschlossen. Dieses Attribut hat keine Auswirkungen darauf, wie sich benutzerdefinierte Dimensionen verhalten, die in dimensionValue-Filtern oder im Dimensions-Tag angegeben sind. Der Standardwert ist „false“.	false
includeRollupLevels Verfügbar in API v25 und höher.	N	Wenn auf „true“ gesetzt, werden Rollup-Werte für alle Ebenen im Filter-Tag zusätzlich zu den Werten für ihre Nachfolger eingeschlossen. Dieses Attribut hat keine Auswirkungen darauf, wie sich benutzerdefinierte Dimensionen verhalten, die in dimensionValue-Filtern oder im Dimensions-Tag angegeben sind. Der Standardwert ist „false“.	false
markInvalidValues	N	Wenn dieser Wert auf „true“ gesetzt ist, fügt der Export den Buchstaben „I“ zu ungültigen Werten hinzu. Andernfalls wird „=NA()“ zu ungültigen Werten hinzugefügt, um sie mit Excel kompatibel zu machen. Der Standardwert ist „false“.	false
markBlanks Aktualisiert in API v24.	N	Wenn dieser Wert auf „true“ gesetzt ist, werden leere Werte als „B“ ausgegeben. Andernfalls werden leere Werte als Nullen ausgegeben. Der Standardwert ist „false“. Bei includeZeroRows=false werden Zeilen mit einer Kombination nur aus Leerstellen und Nullen in der Antwort nicht ausgegeben, auch wenn markBlanks = true gilt.	false
timeRollups	N	Hat drei mögliche Werte: „true“, „false“ und „Single“. Bei „true“ werden Quartals- und Jahres-Rollups innerhalb der exportierten Zeitspanne an der richtigen Stelle angezeigt. Quartals-Rollups werden unmittelbar nach dem letzten Monat ihres Quartals und Jahres-Rollups unmittelbar nach dem Quartals-Rollup des letzten Quartals angezeigt. Bei Einstellung auf „single“ werden keine einzelnen Monate, Quartale oder Jahre zurückgegeben, sondern nur ein einziges Zeit-Rollup aller im Zeitspannenelement abgedeckten Monate. Bei „false“ werden nur einzelne Monate ohne Zeit-Rollup-Spalten zurückgegeben. Der Standardwert ist „false“.	false
Inhalt des Elements
Ein optionales Währungselement, das angibt, welche Währung beim Export verwendet werden soll.

Währungselement
Tag-Name		Währung
Beschreibung		Gibt an, welche Währung in der Ausgabe verwendet werden soll, wenn die Werte von Währungskonten ausgegeben werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
useCorporate	N	Für ein Währungselement kann nur eines der drei Attribute festgelegt werden. Wenn useUnternehmen auf „true“ gesetzt ist, bedeutet dies, dass die „Unternehmenswährung“ (die Währung oben im Organisationsbaum) verwendet werden soll. Der Standardwert ist „false“.	false
useLocal	N	Für ein Währungselement kann nur eines der drei Attribute festgelegt werden. Wenn useLocal auf „true“ gesetzt ist, bedeutet dies, dass Währungswerte in der Währung der Organisationsebene ausgegeben werden sollen, auf der sie sich befinden. Jede Zeile der Ausgabe gibt eine Organisationsebene an und die Währungswerte in dieser Zeile werden in der Währung dieser Ebene angezeigt. Der Standardwert ist „false“.	false
-Überschreibung	N	Für ein Währungselement kann nur eines der drei Attribute festgelegt werden. Wenn eine Überschreibung vorhanden ist, muss sie den aus drei Buchstaben bestehenden Währungscode einer der für die Instanz konfigurierten Währungen angeben. Wenn diese Option angegeben wird, werden alle Währungsbeträge im Export in diese Währung umgerechnet.	AUD
Inhalt des Elements
(Keine)

Mit den folgenden Elementen können Benutzer (mit den entsprechenden Berechtigungen) Exporte für beliebige Zeit-Rollups anfordern. Diese Elemente erfordern Anforderungen mit API v40 oder höher.

Uhrzeit-Element
Tag-Name		time
Beschreibung		Enthält die Kalender-XML, die beim Exportieren von Daten zum Mapping von Zeitperioden verwendet werden soll. Dies sollte in einem reduzierten Format der Zeit-XML vorliegen, die in generiert wurde exportTime API Die in diesem Abschnitt enthaltenen Zeitperioden sollten mit dem Zeitspannenelement im Filter übereinstimmen. Dieses Element ist NUR bei Verwendung des arbiträren Rollup-Kalenders erforderlich. Nur in API v40 und höher verfügbar
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel

Inhalt des Elements
(Keine)

-Zeitschicht-Element
Tag-Name		stratum
Beschreibung		Stellt eine Zeitschicht des Kalenders dar. Nur in API v40 und höher verfügbar
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine eindeutige, benutzerdefinierte ID für die Zeitschicht.	Jahr
id	J	Die eindeutige, vom System generierte Ganzzahl-ID für die Zeitschicht.	7
Inhalt des Elements
(Keine)

Periode-Element
Tag-Name		Periode
Beschreibung		Stellt eine einzelne Kalenderzeitperiode dar. Nur in API v40 und höher verfügbar
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine eindeutige, benutzerdefinierte Kennung für die Zeitperiode.	Q1-2004
stratumId	J	Die ID der Zeitschicht, zu der die Zeitperiode gehört.	2
timeslot	J	Das Zeitfenster der Zeitperiode.	16
id	J	Die eindeutige, vom System generierte Ganzzahl-ID für die Zeitperiode.	16002
Anfang	J	Das Startdatum (einschließlich) der Zeitperiode im Format JJJJ-MM-TT.	2004-01-01
Ende	J	Das Enddatum (ausschließlich) der Zeitperiode im Format JJJJ-MM-TT.	2004-01-01
Inhalt des Elements
(Keine)

Beispielanforderung für ein arbiträres Zeit-Rollup
:


<call method="exportData" callerName="test caller api name">
<credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" />
<version name="Budget 2004" isDefault="true" />
<format useInternalCodes="true" includeUnmappedItems="false" useIds="false" />
<rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false">
   <currency useCorporate="false" useLocal="true" />
</rules>
<filters>
   <accounts>
       <account code="70310" isAssumption="false" includeDescendants="true" />
   </accounts>
   <timeSpan start="01/1999" end="06/1999" />
</filters>
<time isCustom="1">
   <stratum code="month" label="Month" shortName="Month" id="1" />
   <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" />
 <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" />
 <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" />
 <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" />
 <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" />
 <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" />
</time>
</call>

Antwortformat

Antwortformat für Nicht-Streaming


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
<message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message>
</messages>
<output><![CDATA[
Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014]
"Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05
"Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0
...
]]>
</output>
</response>

Antwortformat für Streamen


<?xml version="1.0" encoding="UTF-8"?>
<response>
<output>
<![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005
"Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0
"Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]>
</output>
<messages>
<message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message>
</messages>
<status success="false" rowCountSent="2"/>
</response>

Beachten Sie, dass sich die Struktur der Antwort für Stream- und Nicht-Streaming-Anforderungen ändert. Beispielsweise erfolgen Meldungselement und -status nach der Ausgabe.

Antwortelement
Tag-Name		-Antwort
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.	wahr
obsolete	N	Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet und offiziell veraltet ist. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden.	false
Inhalt des Elements
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement.

Nachrichtenelement
Tag-Name	-Nachrichten
Beschreibung	Container für ein oder mehrere Nachrichtenelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein 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
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.

Ausgabeelement
Tag-Name	Ausgabe
Beschreibung	Enthält die Ergebnisdaten des Exports in einem eingeschlossenen CDATA-Block.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein CDATA-Block, der die CSV-formatierten Daten des Exports enthält. Zeilen werden durch Zeilenumbruchzeichen getrennt. Die erste Zeile der zurückgegebenen Daten ist der Satz von „Spalten-Headern“, der das Format jeder der folgenden Zeilen beschreibt. Dimensionen und Filterelemente werden zuerst aufgelistet, gefolgt von der Reihe der angeforderten Zeitperiodenwerte. Zeitperiodencodes und vom System generierte Labels, wie das Suffix „(Rollup)“ in Rollup-Ebenen, werden nach Möglichkeit in das Gebietsschema der Anforderung übersetzt. Werte werden in normalisierter Form ohne Kommas und mit einem Punkt als Dezimaltrennzeichen ausgegeben.

Statuselement
Tag-Name		status
Beschreibung		Enthält Statusinformationen für die Anforderung und die Zeilenanzahl (Nur für Stream-Anforderungen).
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	„true“ oder „false“. Sie informiert, ob die Anforderung erfolgreich abgeschlossen wurde oder nicht. Auch erfolgreiche Anträge können Warnmeldungen enthalten. Dadurch wird das Attribut in der Antwort NUR bei Stream-Anforderungen ersetzt.	"true"
rowCountSent	J	r"\d+". Stellt den numerischen Wert der Anzahl der Zeilen in der Antwort dar.	"10"

War dies hilfreich?

Was erfordert unsere Aufmerksamkeit? Zutreffend Beantwortet meine Frage Leicht zu finden Leicht zu verstehen Hilft mir bei der Bearbeitung meiner Aufgabe Vollständig und mit Details

Was erfordert unsere Aufmerksamkeit? Nicht zutreffend Beantwortet nicht meine Frage Nicht leicht zu finden Nicht leicht zu verstehen Hilft mir nicht bei der Bearbeitung meiner Aufgabe Unvollständig oder ohne Details

Beschreiben Sie uns Ihre Aufgabe. Welche zusätzlichen Informationen könnten diesen Inhalt verbessern? Möchten Sie weitere Details teilen?

Vollständiger Name

E-Mail

Workday nutzt Ihren Namen und Ihre E-Mail-Adresse, um Ihnen Antworten zu Ihrem Feedback zu geben. Ihre Daten werden entsprechend unserer Datenschutzerklärung behandelt.

Vielen Dank für Ihr Feedback