Zum Hauptinhalt wechseln
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
exportConfigurableModelData

exportConfigurableModelData

Wird unterstützt in API v19 +
Aktualisiert in API v35 (18. November 2022).
Kategorie
Datenabruf
Beschreibung
Gibt eine Reihe von Zeilen aus dem angeforderten modellierten Tabellenblatt in der angeforderten Version und Instanz zurück.
Zum Aufrufen sind Berechtigungen erforderlich
Lesezugriff auf das angeforderte Tabellenblatt, die Version und die Instanz.
Auf Anforderung erforderliche Parameter
Zugangsdaten, Modelliertes Tabellenblatt, Version, Job
Sie können Daten aus exportConfigurableModelData streamen, um eine bessere Performance zu erzielen und weniger Einschränkungen bei der Anzahl der exportierbaren Zellen und Zeilen zu haben. Um Daten zu streamen, müssen Sie:
  • Verwenden Sie API v32 oder höher.
  • Setzt isGetAllRows=true.
Die Anforderung dieser Methode enthält die Parameter, mit denen bestimmt wird, welche modellierten Zeilen zurückgegeben werden. Der Benutzer muss Lesezugriff auf das Tabellenblatt, die Version und die Instanz haben, die das modellierte Tabellenblatt enthält.
Best Practice: Rufen Sie exportSheets auf, um den Namen und die ID des modellierten Tabellenblatts abzurufen, die für Ihre Anforderung exportConfigurableModelData benötigt werden.

Anforderungsformat

Streamen Sie den Aufruf, um alle Zeilen eines modellierten Tabellenblatts abzurufen:
<?xml version='1.0' encoding='UTF-8'?> <call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" isGetAllRows="true" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters> </call>
Paginierter Nicht-Streaming-Aufruf:
<?xml version='1.0' encoding='UTF-8'?> <call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <job jobNumber="0" pageNumber="1"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters> </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 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
Inhalt des Elements
(Keine)
-Versionselement
Tag-Name
Version
Beschreibung
Gibt an, aus welcher Version die modellierten Zeilen abgerufen werden sollen.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name der Version.
Budget 2
Inhalt des Elements
Enthält ein oder mehrere Ebenenelemente.
Element „Modelliertes Tabellenblatt“.
Tag-Name
modelliertes Tabellenblatt
Beschreibung
Gibt an, aus welchem modellierten Tabellenblatt die modellierten Zeilen abgerufen werden sollen. Verwendet die ID oder den Namen des Modelltabellenblatts als ID.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name des modellierten Tabellenblatts.
Arbeitsbudget
isGlobal
N
Gibt an, ob das Tabellenblatt ein Tabellenblatt mit Benutzerzuweisung oder ein Tabellenblatt mit Ebenenzuweisung ist. Wenn wahr, ist das Tabellenblatt ein Tabellenblatt mit Benutzerzuweisung. Bei falsch ist das Tabellenblatt ein Tabellenblatt mit Ebenenzuweisung.
false
isGetAllRows
Wird unterstützt in API v32 und höher
N
Gibt an, ob die Antwort alle Zeilen aus dem Tabellenblatt abruft. Bei wahr werden alle Zeilen ohne Paginierung zurückgegeben und das Element "<Levels>" wird optional und das Element "<Job>" wird in der Anforderung nicht unterstützt. Muss wahr sein, um Streamen von Daten zu unterstützen.
wahr
includeAllColumns
Wird unterstützt in API v22 und höher
N
Gibt an, ob alle Spalten in die Antwort aufgenommen werden sollen. Jeder andere Wert als "true" wird als "false" resultiert.
false
useNumericIDs
Wird unterstützt in API v22 und höher
N
Gibt an, ob die internen IDs in der Antwort ein numerisches Format haben sollen. Beispiel "
100
" vs "
S100
". Ist nicht vorhanden oder auf einen anderen Wert als "
true
" (ohne Berücksichtigung der Groß-/Kleinschreibung), führt dies zu:
false
.
Beispiel für Split-ID, wenn
true
:
  • 271
Beispiel für Split-ID, wenn
false
:
  • S271
wahr
displayNameEnabled
Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
displayNameEnabled=true gibt an, dass bei exportConfigurableModelData die Eigenschaften des Anzeigenamens von berücksichtigt werden sollen
code
,
displayNameType
, und
description
wenn Enable Anzeige Name für die Instanz EIN ist.
displayNameEnabled=false gibt an, dass die exportConfigurableModelData-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die exportConfigurableModelData-API ignoriert die Eigenschaften
code
,
displayNameType
und
description
.
Der Standardwert für displayNameEnabled ist "false".
false
includeCodes
Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
Diese Option ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens EIN ist.
Auf "true" setzen, um die Codespalte für die Ebene und jede Dimension in die API-Antwort einzuschließen.
Auf "false" setzen, um die Codespalte für die Ebene und jede Dimension in der API-Antwort auszuschließen.
Der Standardwert ist „false“.
false
includeNames
Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
Diese Option ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens EIN ist.
Auf "true" setzen, um die Namensspalte für die Ebene und jede Dimension in die API-Antwort aufzunehmen.
Auf "false" setzen, um die Namensspalte für die Ebene und jede Dimension in der API-Antwort auszuschließen.
Der Standardwert ist „false“.
false
includeDisplayNames
Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
Diese Option ist nur sinnvoll, wenn die effektive Einstellung zum Aktivieren des Anzeigenamens EIN ist.
Auf "true" setzen, um die Spalte "Anzeigename" für die Ebene und jede Dimension in die API-Antwort einzuschließen.
Auf "false" setzen, um die Spalte "Anzeigename" für die Ebene und jede Dimension in der API-Antwort auszuschließen.
Der Standardwert ist „false“.
false
useAccountPrecision
Nur in API v33 und höher verfügbar
N
Diese Option ist nur sinnvoll, wenn isGetAllRows="true"
Auf "true" setzen, um Zahlenspalten mit der Genauigkeit des Kontos auszugeben.
Auf „false“ gesetzt, um Zahlenspalten mit der Standardgenauigkeit auszugeben, wenn isGetAllRows="true" ist, was einer Genauigkeit von 9 entspricht.
Der Standardwert ist „false“.
false
useActualValue
Nur in API v35 und höher verfügbar
N
Diese Option ist nur sinnvoll, wenn isGetAllRows = "true" ist.
  • Auf "true" setzen, um Zahlenspalten mit dem Istwert auszugeben.
    • Bei bearbeitbaren numerischen Spalten sind es die Rohdaten.
    • Bei berechneten numerischen Spalten ist dies der berechnete Wert mit einer Genauigkeit von bis zu 9.
  • Auf „false“ gesetzt, um Zahlenspalten mit der Standardgenauigkeit auszugeben, wenn isGetAllRows="true" ist, was einer Genauigkeit von 9 entspricht.
Der Standardwert ist „false“.
wahr
Inhalt des Elements
(Keine)
Element „Tätigkeit“.
Tag-Name
job
Beschreibung
Gibt die Seriennummer des API-Handlers für den API-Aufrufjob an. Dieses Element wird nicht unterstützt, wenn isGetAllRows „true“ ist.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
jobNumber
J
0 für den ersten Aufruf. In der Antwort wird eine Tätigkeitsnummer zurückgegeben. Verwenden Sie diese Tätigkeitsnummer für jeden nachfolgenden Antrag.
Der API-Handler erstellt dann ein Tabellenblattmodell, das das Tabellenblatt in den Arbeitsspeicher lädt. Das Tabellenblatt verbleibt im Speicher, bis das Timeout für die Anforderung erreicht wird, und wird im Datenspeicher erfasst. Die API gibt dann die erste Seite zusammen mit den anderen oben aufgeführten Parametern zurück.
2
pageSize
N
Überschreibt die Standardvorgabe pageSize, damit der API-Benutzer angeben kann, wie viele Zeilen pro Seite bei jedem Aufruf abgerufen werden. Sie wird nur beim ersten Aufruf wirksam, wenn jobNumber="0" ist.
Die pageSize wird ignoriert und in den folgenden Fällen werden alle Daten auf der ersten Seite zurückgegeben:
  • Wenn die angegebene pageSize größer ist als die Anzahl der Zeilen im Blatt.
  • Wenn die Anzahl der Zellen im Tabellenblatt kleiner oder gleich 20.000 ist.
  • Wenn die Anzahl der Zeilen im Tabellenblatt kleiner oder gleich 500 ist.
200
seitenzahl
J
Gibt die angeforderte Seitenzahl an, wenn mehr als eine Seite vorhanden ist. Der Seitenzahlenindex beginnt mit „1“.
Der API-Handler ist für denselben Benutzer, der nachfolgende Aufrufe mit derselben Anforderungs-API und Authentifizierung tätigt.
Die nachfolgende Anforderung muss innerhalb von 3 Minuten nach der letzten Antwortzeit erfolgen.
1
Inhalt des Elements
(Keine)
Element „Filter“.
Tag-Name
Filter
Beschreibung
Container für alle zugehörigen Filterelemente.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Die Elemente „Ebenen“ und „Spalten“.
Element „Ebenen“.
Tag-Name
Ebene(n)
Beschreibung
Container für ein Ebenenelement. Gibt die Ebene an, aus der Zeilen abgerufen werden sollen. Dieses Element ist optional, wenn isGetAllRows „true“ ist.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Elemente mit einer Ebene.
Ebenenelement
Tag-Name
level
Beschreibung
Gibt eine Ebene an, nach der die Anforderung gefiltert werden soll.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name der angeforderten Ebene.
Der Name wird nur für Anforderungen vor v30 unterstützt, wenn die effektiven Einstellungen für den Anzeigenamen AUS sind.
HQ
includeDescendants
N
Gibt an, ob der Export alle Nachfolger der angegebenen Ebene einschließen soll oder nicht. Wenn auf „true“ gesetzt, werden alle untergeordneten Ebenen dieser Ebene exportiert, ebenso ihre untergeordneten Ebenen und so weiter. Bei "false" wird diese Ebene allein exportiert.
Die Angabe von "false" ermöglicht den Export von Ebenen, die in der (ausschließlich) Ebene als Ebene angegeben sind
Adaptive Planning
Webbenutzeroberfläche.
wahr
-Code
Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Der Code der zu exportierenden Ebene. Dieser Code wird unter "Ebenenverwaltung" angegeben. Das Attribut „Code“ wurde in API v31 hinzugefügt.
Verwenden Sie das Namensattribut für die API-Anforderung vor v30 und wenn die effektive Einstellung für den Anzeigenamen AUS ist.
false
Inhalt des Elements
Name der Ebene
Spaltenelement
Tag-Name
Spalten
Beschreibung
Container für zwei Elemente: Modell und System. Die Model- und System-Tags haben wiederum untergeordnete Spaltenelemente, die den Namen der Spalte angeben.
Nur in API v33 und höher verfügbar
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Einem Modellelement
-Modellelement
Tag-Name
-Modell
Beschreibung
Gibt einen Satz von Spalten für modellierte Tabellenblätter an. Sie enthält untergeordnete Spaltenelemente.
Nur in API v33 und höher verfügbar
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Enthält untergeordnete „Spalten“-Elemente. Für Modellspalten wird bei der Angabe des Zeitspannenelements der Name „Zeitspanne“ verwendet.
Systemelement
Tag-Name
-System
Beschreibung
Gibt eine Gruppe von Systemspaltennamen an. Die zulässigen Optionen sind "InternalID", "ParentID" und "IsParent".
Nur in API v33 und höher verfügbar
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Enthält untergeordnete „Spalten“-Elemente.
Spaltenelement
Tag-Name
Spalte
Beschreibung
Gibt einen Spaltennamen für das modellierte Tabellenblatt an. Besondere Werte umfassen die oben aufgeführten Systemspaltennamen. Für die Modellspalten ist dies der Spaltenname "Zeitspanne".
Nur in API v33 und höher verfügbar
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Einem Modellelement
Beispiel Spalten
<columns> <model> <column>NumberCurrency</column> <column>Regional Code</column> <column>CountryRegion</column> <column>CalcAcctNum</column> <column>Level Currency</column> <column>Invalid Column Name</column> <column>InitialBalance</column> <column>Timespan</column> </model> <system> <column>InternalID</column> <column>Invalid System Column Name</column> <column>IsParent</column> <column>ParentID</column> </system> </columns
Element „Zeitspanne“.
Tag-Name
timeSpan
Beschreibung
Wenn das Modelltabellenblatt ein Element timeSpann enthält, geben Start und Ende den Zeitbereich der Daten an, die aus dem Tabellenblatt exportiert werden sollen. Wenn timeSpann nicht enthalten ist, werden Daten aus dem vollständigen Datumsbereich der Version exportiert. Verwenden Sie einen internen Zeitperiodencode (Siehe Kalenderstruktur ändern) oder ein lokalisiertes Zeitlabel aus der Tabellenblattansicht, um Start oder Ende einer Zeitspanne anzugeben.
Timespan dupliziert die Funktionalität der Einstellungen für Anzeigeoptionen > Zeit für die Leaf-Zeitauswahl in Start und Ende für ein modelliertes Tabellenblatt in
Adaptive Planning
Benutzeroberfläche
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Anfang
N
Der Zeitcode oder das lokalisierte Zeitlabel, der im Tabellenblatt der ersten Zeitperiode im Bereich für den Export angezeigt wird. Die Startzeitperiode muss eine Leaf-Zeitperiode sein. Wenn start nicht angegeben ist, wird der Start der Version verwendet.
Jan-2016
01/2016
Ende
N
Der Zeitcode oder das lokalisierte Zeitlabel der letzten Zeitperiode im Exportbereich. Die Endzeitperiode muss eine Leaf-Zeitperiode sein. Wenn end nicht angegeben ist, wird das Ende der Version verwendet.
Nov-2016
11/2016

Zeitspannen-Beispiele

Anfang Januar 2016 bis Ende April 2016. „Jan-2016“ ist der interne Zeitperiodencode, der von der Benutzeroberfläche für die Zeitverwaltung angezeigt wird. „04/2016“ ist ein Tabellenblatt-Zeitlabel.
<timeSpan start="Jan-2016 end="04/2016"/>
Start Februar 2016 bis zum Enddatum der Version. „02/2016“ ist ein Tabellenblatt-Zeitlabel.
<timeSpan start="02/2016"/>
Sie beginnen mit dem Startdatum der Version und enden im November 2016. Nov-2016 ist der interne Zeitperiodencode, der von der Benutzeroberfläche der Zeitverwaltung angezeigt wird.
<timeSpan start="" end="Nov-2016"/>

Antwortformat

<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data jobNumber="3"> <![CDATA["InternalID","Plan","CapitalAssetClass","Label","Price","Currency","Mar-2016","Q1-FY16","Apr-2016","May-2016","Jun-2016","Q2-FY16","Jul-2016","Aug-2016","Sep-2016","Q3-FY16","Oct-2016","Nov-2016","Dec-2016","Q4-FY16","FY2016","Jan-2017","Feb-2017","Mar-2017","Q1-FY17","Apr-2017","May-2017","Jun-2017","Q2-FY17","Jul-2017","Aug-2017","Sep-2017","Q3-FY17","Oct-2017","Nov-2017","Dec-2017","Q4-FY17","FY2017" "S1325","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1326","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1327","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1328","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1323","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1324","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output> </response>
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
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.
Für die Streaming-Version der API (isGetAllRows = "true"): Wenn die API beim Streamen von Zeilen fehlschlägt, werden die XML-Tags geschlossen und eine Meldung hinzugefügt:
Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.
Element „Tätigkeit“.
Tag-Name
job
Beschreibung
Gibt die Job- und Daten-Paging-Informationen für die zurückgegebenen Daten an, sodass der Benutzer mit einer Reihe von Aufrufen alle Daten für das gefilterte Dataset aus dem Modelltabellenblatt extrahieren kann.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
jobNumber
N
Die dedizierte Seriennummer des API-Handlers, die vom Server dem API-Aufrufjob zugewiesen wurde. Wird in allen nachfolgenden Anforderungen verwendet.
2
numberOfPages
N
Die Gesamtanzahl der Seiten mit Daten, die für den Filtersatz verfügbar sind.
3
seitenzahl
N
Die Seitenzahl für das aktuelle Dataset, das zurückgegeben wird.
1
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.
Ausgabeelement
Tag-Name
Ausgabe
Beschreibung
Das Ausgabe-Tag hat ein untergeordnetes Element, das Daten-Tag.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Ebene
N
Der Name der Ebene, in der sich diese Zeile oder dieser Split/diese Zeile befindet. Dies wird unabhängig davon angezeigt, ob die angeforderte Ebene eine Rollup-Ebene ist oder nicht.
Engineering
Inhalt des Elements
Einzelnes Datenelement.
Tag-Name
Daten
Beschreibung
Die Antwort gibt einen CDATA-Block zurück, der einen CSV-formatierten Datendump der modellierten Zeilen enthält, die exportiert werden. Die erste Zeile des CDATA-Blocks ist die „Header-Zeile“ der CSV und alle folgenden Zeilen sind Datenzeilen. Wenn keine Zeilen mit der Filteranforderung übereinstimmen, wird nur die Header-Zeile ausgegeben.
Die Spalten der CSV beginnen mit bis zu fünf fest codierten Spalten mit internem Fokus. Diese Spalten können die Zeile und einige ihrer unveränderlichen Eigenschaften identifizieren. Die im Tabellenblatt vorhandenen Spalten folgen, unabhängig davon, ob Folgendes zutrifft:
  • Der einzelne Benutzer hat sie möglicherweise in seinen Anzeigeoptionen ausgeblendet
  • Die Spalten sind schreibgeschützt oder nicht.
Alle Spalten in der API-Antwort sind die sichtbaren/definierten Spalten für das Tabellenblatt, wobei der deklarierte Spalten-Header das Label in der Header-Zeile ist. Dazu gehören alle im Tabellenblatt platzierten Attributspalten. Für das Zeitspannenkonto sind die Spalten-Header die Monate der aktuellen Version im selben Format wie bei der exportData- API.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
totalRowCount
Verfügbar in API v35 und höher, wenn isGetAllRows=true ist.
N
Dieses Attribut wird zum Datenelement für die Stream-Version der API hinzugefügt. Gibt die Gesamtanzahl der Zeilen an, die das modellierte Tabellenblatt voraussichtlich exportieren wird.
"10"
Inhalt des Elements
Ein CDATA-Block, der Folgendes enthält:
  • Als gültige CSV formatierte Zeilen.
    • Zeichenfolgen werden in doppelte Anführungszeichen gesetzt.
    • Zahlen werden in
      kanonischer Form
      ausgegeben (nicht länderspezifisches Format). Kommas werden entfernt
    • Dimensionen und Textauswahlen geben den ausgewählten Wert aus. Wenn sie keinen Wert haben, geben sie eine leere Zeichenfolge aus.
  • Wenn Sie übergeordnete Zeilen ausgeben, werden alle splitbaren Spalten in der CSV als
    leer
    angezeigt (es wird nicht versucht, Rollups oder „verschiedene“ Werte anzuzeigen).
  • Wenn Sie untergeordnete Zeilen/Split-Zeilen ausgeben, werden alle
    nicht splitbaren
    Spalten so angezeigt, dass sie den Wert aus der übergeordneten Zeile enthalten. Dies ist identisch mit dem Verhalten von Tabellenblättern in der Webbenutzeroberfläche von Adaptive Planning.
Ein Statuselement
Tag-Name
status
Beschreibung
Nur verfügbar in API v35 + beim Daten-Streaming (isGetAllRows = "true").
Das Status-Tag wird sowohl für Erfolgs- als auch für Fehlerfälle der Stream-Version der API nach dem Ausgabe-Tag hinzugefügt.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Erfolg haben
J
Wenn alle Daten gestreamt wurden, wird Success = "true" zurückgegeben. Wenn ein Fehler aufgetreten ist (entweder aufgrund von Validierungen oder aufgrund von Fehlern, bevor alle Zeilen gestreamt wurden), wird Success = "false" zurückgegeben.
wahr
rowCountSent
N
Die Anzahl oder Zeilen, die gesendet wurden. Bei einer fehlgeschlagenen Antwort stimmt diese Zahl nicht mit dem im Element Datenelement festgelegten Gesamtwert überein.
1
Inhalt des Elements
(Keine)

Entfernen des „S“ aus „ParentId“, wenn useNumericIds = „true“ für die Stream-Version der API(isGetAllRows=true)

Ab Version 35 der API enthält übergeordnete ID nicht mehr das Präfix „S“ im Wert.

Die in-Werte für die Stream-Version der API werden maskiert (isGetAllRows = true).

Ab Version 35 der API wird jeder Spaltenwert, der ein „“ enthält, im CSV-Stilformat maskiert (also „wird durch „“ dargestellt).

Behandlung von Fehlerszenarien beim Streamen

Wenn die API während des Streamens der Zeilen fehlschlägt, werden die XML-Tags geschlossen und eine Fehlermeldung gesendet.
Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.
Beispielantwort
:
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data> <![CDATA["InternalID","Level","Plan","CapitalAssetClass","Label","Price","Currency","Jan-2010","Feb-2010","Mar-2010","Q1-FY10","Apr-2010","May-2010","Jun-2010","Q2-FY10","Jul-2010","Aug-2010","Sep-2010","Q3-FY10","Oct-2010","Nov-2010","Dec-2010","Q4-FY10","FY2010","Jan-2011","Feb-2011","Mar-2011","Q1-FY11","Apr-2011","May-2011","Jun-2011","Q2-FY11","Jul-2011","Aug-2011","Sep-2011","Q3-FY11","Oct-2011","Nov-2011","Dec-2011","Q4-FY11","FY2011","Jan-2012","Feb-2012","Mar-2012","Q1-FY12","Apr-2012","May-2012","Jun-2012","Q2-FY12","Jul-2012","Aug-2012","Sep-2012","Q3-FY12","Oct-2012","Nov-2012","Dec-2012","Q4-FY12","FY2012","Jan-2013","Feb-2013","Mar-2013","Q1-FY13","Apr-2013","May-2013","Jun-2013","Q2-FY13","Jul-2013","Aug-2013","Sep-2013","Q3-FY13","Oct-2013","Nov-2013","Dec-2013","Q4-FY13","FY2013","Jan-2014","Feb-2014","Mar-2014","Q1-FY14","Apr-2014","May-2014","Jun-2014","Q2-FY14","Jul-2014","Aug-2014","Sep-2014","Q3-FY14","Oct-2014","Nov-2014","Dec-2014","Q4-FY14","FY2014" "S289","HQ","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S290","HQ","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S291","HQ","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S292","HQ","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S287","HQ","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S288","HQ","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output> <messages> <message>Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.</message> </messages> </response>

Beispielantwort mit Status-API v35 mit Stream (isGetAllRows="true)

<?xml version="1.0" encoding="UTF-8"?> <response> <output> <data totalRowCount="6"> <![CDATA["InternalID","CapitalAssetClass","Price" "S289","Furniture","90" "S290","Furniture","200" "S291","Computers","2500" "S292","Computers","1000" "S287","Facility","" "S288","OtherEquipment",""]]> </data> </output> <status success="true" rowCountSent="6"></status> <messages> <message>System Column names [Invalid System Column Name] specified in the request weren't found and will be ignored.</message> <message>Model Column names [timespan,invalid column name] specified in the request weren't found and will be ignored.</message> </messages> </response>

Warnmeldung für ungültige Spaltennamen

Wenn in der Anforderung ein ungültiger Spaltenname angegeben wird, senden wir Nachrichten.
Beispielantwort
:
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data> <![CDATA["InternalID","CapitalAssetClass","Price" "S289","Furniture","90" "S290","Furniture","200" "S291","Computers","2500" "S292","Computers","1000" "S287","Facility","" "S288","OtherEquipment",""]]> </data> </output> <messages> <message>System Column names [Invalid System Column Name] specified in the request weren't found and will be ignored.</message> <message>Model Column names [timespan,invalid column name] specified in the request weren't found and will be ignored.</message> </messages> </response>