exportSheetDefinition

Anforderungsformat für modelliertes Tabellenblatt


 <?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <modeled-sheet id="3"/>
   </call>

Das Element aufrufen enthält ein Element credentials sowie ein einzelnes modelliertes Tabellenblatt.

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen verfügen, um die Aktion in Reihenfolge für die API auszuführen -Aufruf erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich ?	Wert	Beispiel
anmelden	J	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)

Element „Modelliertes Tabellenblatt“.
Tag-Name		modelliertes Tabellenblatt
Beschreibung		Identifiziert ein einzelnes modelliertes Tabellenblatt, das über einen API-Aufruf exportSheetDefinition angefordert wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für das Tabellenblatt.	234
displayNameEnabled Nur in API v31 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	displayNameEnabled=true gibt an, dass exportSheetDefinition die Eigenschaften des Anzeigenamens von berücksichtigen soll code , displayNameType , und description wenn Enable Anzeige Name für die Instanz EIN ist. displayNameEnabled=false gibt an, dass die exportSheetDefinition-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die exportSheetDefinition-API ignoriert die Eigenschaften code , displayNameType und description . Der Standardwert für displayNameEnabled ist "false".	false
Inhalt des Elements
(Keine)

Antwortformat für modelliertes Tabellenblatt


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <output>
       <modeled-sheet id="11" prefix="Personnel" name="Personnel" description="Personnel Sheet"
                              available-in-actuals="false" allow-splits="true" split-column-title="Is Split Child Row" strataId="51">
           <columns>
               <levels code="Plan" name="Plan" read-only="false" splittable="false" required="true">
                   <level id="1" />
                   <level id="7" />
               </levels>
               <text code="LastName" name="Last Name" read-only="false" splittable="false" required="false" />
               <text code="FirstName" name="First Name" read-only="false" splittable="false" required="false" />
               <text code="ID" name="ID" read-only="false" splittable="false" required="false" />
               <dimension code="JobCode" name="JobCode" read-only="false" splittable="false" required="false" id="9">
                   <value id="19" name="E1" />
                   <value id="20" name="E2" />
                   <value id="21" name="E3" />
               </dimension>
               <text-selector code="BenefitsSelector" name="Benefits" read-only="false" splittable="false" required="true" id="27">
                   <value id="208" name="No" />
                   <value id="209" name="Yes" />
               </text-selector>
               <date code="StartDate" name="Start" read-only="false" splittable="false" required="false" />
               <date code="EndDate" name="End" read-only="false" splittable="false" required="false" />
               <number code="HoursPerWeek" name="Hr/Week" read-only="false" splittable="false" required="false" />
               <text-selector code="per" name="per" read-only="false" splittable="false" required="true" id="28">
                   <value id="210" name="Yr" />
                   <value id="211" name="Hr" />
               </text-selector>
               <initial-balance code="PayRate" name="Pay Rate" read-only="false" splittable="false" required="false" id="143" />
               <display code="PayRate" name="Pay Rate Display Column" read-only="true" splittable="false" required="false" id="7" />
               <level-currency code="" name="Currency" read-only="true" splittable="false" required="false" id="8" />
           </columns>
       </modeled-sheet>
   </output>
</response>

Das Element des modellierten Tabellenblatts enthält eine einzelne Spalte, die eine oder mehrere der untergeordneten Spalten in der für das Tabellenblatt definierten Reihenfolge enthalten:

Ebene(n)

Dimension

Textauswahl

Text

Nummer

date

ausgangssaldo

Ebenenwährung

Zeitspanne

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
veraltet	N	Wenn dieses Attribut im Antwort-Tag vorhanden und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet ist und von offiziell als veraltet markiert wird Adaptive Planning . 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.

Element „Modelliertes Tabellenblatt“.
Tag-Name		modelliertes Tabellenblatt
Beschreibung		Stellt ein einzelnes modelliertes Tabellenblatt dar, das in der Antwort auf einen export-Tabellenblatt-API-Aufruf zurückgegeben wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für das Tabellenblatt. Dies kann verwendet werden, um Tabellenblätter in anderen API-Aufrufen zu identifizieren, z. B. exportSheetDefinition.	234
prefix	J	Das Präfix des Tabellenblatts.	Kapital
Name	J	Der Name des Tabellenblatts.	Kapitalmodell
Verfügbar-in-Istzahlen	J	Kann wahr oder falsch sein. Gibt an, ob das modellierte Tabellenblatt in der Istzahlen-Version verfügbar ist oder nicht.	wahr
Beschreibung	N	Die textuelle Beschreibung des Tabellenblatts, falls vorhanden.	Dies ist das Kapitalmodell ...
Allow-Splits	J	„Wahr“ bedeutet, dass das modellierte Tabellenblatt Splits zulässt.	wahr
split-column-title	N	Der zusätzliche Spaltentitel für den Import, wenn „Splits zulassen“ aktiviert ist. Verwenden Sie eine lokalisierte Zeichenfolge, wenn in der Anforderung ein Gebietsschema angegeben ist. Dieses Attribut ist nur vorhanden, wenn "allow-splits" auf "true" gesetzt ist und mindestens eine Spalte splitbar ist.	Ist gesplittete untergeordnete Zeile
StrataId	J	Die Schicht-ID, die diesem modellierten Tabellenblatt zugeordnet ist	2
Inhalt des Elements
Ein einzelnes Spaltenelement.

Spaltenelement
Tag-Name		Spalten
Beschreibung		Container für ein oder mehrere Spaltenelemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Eines oder mehrere der folgenden Elemente in der Reihenfolge, wie sie im Tabellenblatt angezeigt werden: Ebene(n) Dimension Textauswahl Text Nummer date ausgangssaldo Ebenenwährung Anzeige Zeitspanne

Element „Ebenen“.
Tag-Name		Ebene(n)
Beschreibung		Stellt die Spalte „Ebene“ in einem modellierten Tabellenblatt dar. Container für ein oder mehrere Ebenenelemente.
Attribute des Elements
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	wahr
Inhalt des Elements
Ein oder mehrere Ebenenelemente.

Ebenenelement
Tag-Name		level
Beschreibung		Eine der Ebenen, die für dieses Unternehmen definiert sind, das sich in diesem Tabellenblatt befindet (oder auf dem dieses Tabellenblatt platziert wurde). Ebenenmetadaten, einschließlich der hierarchischen Struktur, können über einen Aufruf von exportLevels abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für die Ebene.	42
Inhalt des Elements
(Keine)

Textelement
Tag-Name		Text
Beschreibung		Stellt eine Spalte im Tabellenblatt dar, die vom Benutzer eingegebenen Text enthält.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
Inhalt des Elements
(Keine)

Dimensionselement
Tag-Name		Dimension
Beschreibung		Eine der für dieses Unternehmen definierten Dimensionen. Stellt eine Spalte im Tabellenblatt dar, die die Dimension enthält.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
Inhalt des Elements
Ein oder mehrere Wertelemente, von denen jedes ein gültiger auswählbarer Wert in der Dimension für dieses Tabellenblatt ist. Wenn ein Wert der Dimension hier nicht enthalten ist, kann dieser Wert nicht für Datenzeilen in diesem Tabellenblatt verwendet werden.

Wertelement
Tag-Name		Wert
Beschreibung		Einer der Werte, die für diese Dimension oder Textauswahl definiert sind. Vollständige Dimensionsmetadaten, einschließlich ihrer hierarchischen Struktur, können über einen separaten Aufruf von exportDimensions abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für den Wert.	42
-Code Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	Der Code für den Elementwert der Dimension, falls vorhanden, wie in Dimensionsverwaltung eingegeben.	Mexiko
Name	J	Gedruckte Darstellung des Werts.	Mexiko
displayName Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	Der Anzeigename des Elementwerts, wie aus displayNameType abgeleitet.	Mexiko
Inhalt des Elements
(Keine)

Textauswahlelement
Tag-Name		Textauswahl
Beschreibung		Benutzerdefinierte Liste von Werten, die für dieses Tabellenblatt definiert sind. Stellt eine Textauswahlspalte in einem modellierten Tabellenblatt dar.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	wahr
id	J	Interne numerische ID.	42
Inhalt des Elements
Mindestens ein Wertelement.

Zahlenelement
Tag-Name		Nummer
Beschreibung		Stellt eine Spalte im Tabellenblatt dar, die eine vom Benutzer eingegebene Zahl enthält.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
Inhalt des Elements
(Keine)

Datumselement
Tag-Name		date
Beschreibung		Stellt eine Spalte im Tabellenblatt dar, die ein vom Benutzer eingegebenes Datum enthält.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
Inhalt des Elements
(Keine)

Element des Ausgangssaldos
Tag-Name		ausgangssaldo
Beschreibung		Stellt eine Spalte im Tabellenblatt dar, die einen vom Benutzer bereitgestellten Wert für den Ausgangssaldo eines Kontos mit einer Formel enthält, die die monatliche Änderung des Kontowerts bestimmt.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
id	J	Interne numerische ID des Kontos, das dieser Spalte zugeordnet ist.	42
Inhalt des Elements
(Keine)

Ebenenwährungselement
Tag-Name		Ebenenwährung
Beschreibung		Stellt eine Spalte im Tabellenblatt dar, die den Code für die Währung anzeigt, die jeder Zeile zugeordnet ist. Dies ist die Währung der Ebene, in der sich die Zeile befindet.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können. Für Elemente der Ebenenwährung ist dieser Wert immer „true“.	wahr
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
id	J	Interne numerische ID.	42
Inhalt des Elements
(Keine)

Anzeigeelement
Tag-Name		Anzeige
Beschreibung		Stellt eine Spalte im Tabellenblatt dar, die eine zeilenbasierte, schreibgeschützte Berechnung enthält.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
id	J	Interne numerische ID.	42
Inhalt des Elements
(Keine)

Element „Zeitspanne“.
Tag-Name		Zeitspanne
Beschreibung		Höchstens eine pro Blatt. Dies entspricht einem Satz von Spalten für die Zeitspanne, die auf der rechten Seite des Blattes angezeigt werden und periodische Daten enthalten können.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Eine Symbol-ID für die Spalte, die in Tabellenblattformeln und -Bezügen verwendet wird.	MyColumn
Name	J	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	Meine Spalte
schreibgeschützt	J	Wahr, wenn die Spalte im Tabellenblatt als schreibgeschützt markiert ist. Falsch, wenn Werte in die Spalte eingegeben werden können.	false
splitbar ist	J	Wahr, wenn Zeilen-Splits für diese Spalte unterschiedliche Werte haben können. Falsch, wenn Zeilen-Splits denselben Wert wie das übergeordnete Element haben müssen.	wahr
erforderlich	J	Wahr, wenn dieses Attribut ein Pflichtfeld ist.	false
id	J	Interne numerische ID des Kontos, das dieser Zeitspanne zugeordnet ist.	42
Inhalt des Elements
(Keine)

Anforderungsformat für Cube-Tabellenblatt


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheetDefinition" callerName="a string that identifies your client application">
     <credentials login="sampleuser@company.com" password="my_pwd"/>
     <cube-sheet id="4"/>
   </call>

Das Element aufrufen enthält ein Element credentials sowie ein einzelnes Cube-Tabellenblatt.

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen verfügen, um die Aktion in Reihenfolge für die API auszuführen -Aufruf erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
anmelden	J	Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über einen Berechtigungssatz verfügen, der die für die aufzurufende Methode erforderlichen Berechtigungen enthält.	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)

Cube-Tabellenblattelement
Tag-Name		Cube-Tabellenblatt
Beschreibung		Identifiziert ein einzelnes Cube-Tabellenblatt, das über einen API-Aufruf exportSheetDefinition angefordert wurde.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für das Tabellenblatt.	234
Inhalt des Elements
(Keine)

Cube-Tabellenblatt-Antwortformat


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
    <output>
        <cube-sheet id="24" prefix="SummaryCube" name="Summary Cube" isGlobal="0" description="" strataId="1" horizontalAxis="-3" verticalAxis="-2" maxColumnWidth="0" suppressZeroRows="0" rearrangeGLAndCustomAccounts="0" hideRollupTotals="0">
            <dimensions>
                <dimension id="3" uncategorized="false" rollup="false" name="Company" newValueBehavior="parent" editableOnSheet="false">
                    <value id="35" />
                </dimension>
                <dimension id="4" uncategorized="false" rollup="false" name="CountryRegion" newValueBehavior="parent" editableOnSheet="false">
                    <value id="144" />
                    <value id="133" uncategorized="true" />
                    <value id="133" rollup="true" />
                    <value id="122" rollup="true" />
                    <value id="143" />
                </dimension>
                <levels>
                    <level id="1" />
                    <level id="2" />
                    <level id="8" />
                    <level id="10" />
                    <level id="9" />
                    <level id="5" />
                    <level id="3" />
                    <level id="4" />
                    <level id="11" />
                    <level id="13" />
                    <level id="15" />
                    <level id="16" />
                </levels>
                <accounts>
                    <account id="455" code="" isAssumption="false" />
                    <account id="456" code="" isAssumption="false" />
                    <account id="457" code="SummaryCube.Input" isAssumption="false" />
                    <account id="458" code="SummaryCube.CubeMetric" isAssumption="false" />
                </accounts>
                <time initialBalance="true" visibleTimeStratumCodes="month" />
            </dimensions>
        </cube-sheet>
    </output>
</response>

Das Cube-Tabellenblattelement enthält eine einzelne Dimension, die diese in der für das Tabellenblatt definierten Reihenfolge enthält:

Dimension (eine oder mehrere)

Attribut (null oder mehr)

Ebenen (eine)

Konten (eines)

time (eins)

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
veraltet	N	Wenn dieses Attribut im Antwort-Tag vorhanden und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet ist und von offiziell als veraltet markiert wird Adaptive Planning . 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.

Ausgabeelement
Tag-Name		Ausgabe
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein einzelnes erforderliches Cube-Tabellenblattelement. Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein.

Cube-Tabellenblattelement
Tag-Name		Cube-Tabellenblatt
Beschreibung		Stellt ein einzelnes Cube-Tabellenblatt dar, das in der Antwort auf einen exportSheet-API-Aufruf zurückgegeben wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id		Die interne System-ID-Nummer für das Tabellenblatt. Dies kann verwendet werden, um Tabellenblätter in anderen API-Aufrufen zu identifizieren, z. B. exportSheetDefinition.	34
prefix		Das Präfix des Tabellenblatts.	ExpenseCube
Name		Der Name des Tabellenblatts.	Spesen Cube
Beschreibung		Die textuelle Beschreibung des Tabellenblatts, falls vorhanden.
StrataId	J	Die Schicht-ID des Tabellenblatts.	5
horizontalAxis	J	Die ID der Dimension, die standardmäßig auf der horizontalen Achse angezeigt werden soll.	-3
Vertikale Achse	J	Die Liste der Dimensions-IDs, die standardmäßig auf der vertikalen Achse angezeigt werden sollen.	-2
maxColumnWidth	J	Die maximale Breite in Pixel für Spalten (null, wenn nicht angegeben).	20
suppressZeroRows	J	"1", wenn null Zeilen unterdrückt werden, "0", wenn dies nicht der Fall ist.	suppressZeroRows="0"
rearrangeGLAndCustomAccounts	J	"1", wenn das Cube-Tabellenblatt die Behandlung "Hauptbuch-Konto" verwenden soll, "0", wenn dies nicht der Fall ist.	rearrangeGLAndCustomAccounts="0"
hideRollupTotals	J	"1", wenn Rollup-Summen ausgeblendet werden sollen, "0", wenn dies nicht der Fall ist.	hideRollupTotals="0"
Inhalt des Elements
(Keine)

Element „Dimensionen“.
Tag-Name		Dimensionen
Beschreibung		Container für die Dimensionen des Tabellenblatts.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Eine oder mehrere Ebenen, Dimensionen, Konten, Zeitelemente.

Dimensionselement
Tag-Name		Dimension
Beschreibung		Eine der Dimensionen, die für dieses Cube-Tabellenblatt definiert sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne numerische ID für die Dimension.	34
Ohne Kategorie	J	„Wahr“ bedeutet, dass das Element „Ohne Kategorie“ der Dimension selbst (das Root-Element „Ohne Kategorie“) im Cube-Tabellenblatt ausgewählt werden kann.	wahr
Rollup	J	„Wahr“ bedeutet, dass das Rollup-Element der Dimension selbst (das Rollup aller Elemente) im Cube-Tabellenblatt ausgewählt werden kann.	wahr
Name Verfügbar in API v22 und höher	J	Der Name dieser Dimension.	Produktposten
Inhalt des Elements
Ein oder mehrere Wertelemente, die angeben, welche Dimensionswerte im Tabellenblatt verfügbar sind.

Attributelement
Tag-Name		Attribut
Beschreibung		Eines der Attribute, die in diesem Cube-Tabellenblatt platziert werden. Attributmetadaten, einschließlich ihrer hierarchischen Struktur, können über einen Aufruf von exportAttributes abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne numerische ID für das Attribut.	34
Ohne Kategorie	J	„Wahr“ bedeutet, dass das Element „Ohne Kategorie“ des Attributs selbst (das Root-Element „Ohne Kategorie“) im Cube-Tabellenblatt ausgewählt werden kann.	wahr
Rollup	J	„Wahr“ bedeutet, dass das Rollup-Element des Attributs selbst (das Rollup aller Elemente) als Auswahl im Cube-Tabellenblatt verfügbar ist.	wahr
Name Verfügbar in API v22 +	J	Der Name des Attributs.	Filialart
newValueBehavior	J	Erwartetes Verhalten für die Verfügbarkeit neuer Dimensionswerte, entweder verfügbar, nicht verfügbar oder übergeordnet.	Übergeordnetes Element
Inhalt des Elements
Ein oder mehrere Wertelemente, die angeben, welche Werte des Attributs im Tabellenblatt verfügbar sind.

Wertelement
Tag-Name		Wert
Beschreibung		Einer der Werte für diese Dimension, der im Tabellenblatt als verfügbar markiert wurde. Dieselbe Wert-ID kann bis zu zweimal angezeigt werden: mit und ohne „Ohne Kategorie“ auf „true“ gesetzt. Dimensionsmetadaten, einschließlich ihrer hierarchischen Struktur, können über einen Aufruf von exportDimensions abgerufen werden.
Attribute des Elements
Attributname	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für den Dimensionswert.	34
Rollup	N	„true“ gibt das Rollup dieses Dimensionswerts an. Nur zulässig, wenn der Wert untergeordnete Werte in der Dimension hat. Wenn das Attribut fehlt, wird „false“ verwendet.	wahr
Ohne Kategorie	N	true gibt den Wert „Ohne Kategorie“ dieses Dimensionswerts an. Nur zulässig, wenn der Wert untergeordnete Werte in der Dimension hat. Wenn das Attribut fehlt, wird „false“ verwendet.	wahr
Inhalt des Elements
(Keine)

Element „Ebenen“.
Tag-Name		Ebene(n)
Beschreibung		Erzwungener Container für ein oder mehrere Ebenenelemente. Einzelne Ebenen werden zurückgegeben, auch wenn sie sich nur auf die Sichtbarkeit auswirken. Daten können in jede beliebige Ebene importiert werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Ebenenelemente.

Ebenenelement
Tag-Name		level
Beschreibung		Eine in diesem Tabellenblatt gefundene Ebene, in der dieses Tabellenblatt angezeigt wird. Ebenenmetadaten, einschließlich ihrer hierarchischen Struktur, können über einen Aufruf von exportLevels abgerufen werden.
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für die Ebene.	12
Inhalt des Elements
(Keine)

Kontenelement
Tag-Name		Konten
Beschreibung		Erzwungener Container für ein oder mehrere Kontoelemente. Es werden einzelne Konten zurückgegeben, auch wenn sie sich nur auf die Sichtbarkeit auswirken. Daten können in jedes Eingabekonto importiert werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Einem oder mehreren Kontoelementen. Verfügbare Kontoelemente und Reihenfolge, die durch die Option Behandlung für Hauptbuch-Konto verwenden in den Eigenschaften des Cube-Tabellenblatts bestimmt werden.

Kontoelement
Tag-Name		account
Beschreibung		Eines der Konten, die für dieses Cube-Tabellenblatt definiert sind. Kontometadaten, einschließlich ihrer hierarchischen Struktur, können über einen Aufruf von exportAccounts abgerufen werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Interne numerische ID für das Konto.	23
-Code Verfügbar in API v22 und höher	N	Der Kontocode für das Konto.	SalesCubeWithAttribute.Unit_Price
Inhalt des Elements
(Keine)

Zeitelement
Tag-Name		time
Beschreibung		Erzwungene Zeitdimension.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
initialBalance	J	Wahr, wenn die Zeitdimension einen Ausgangssaldowert hat.	"true"
visibleTimeStratumCodes	N	Liste der nach Zeitdimension ausgewählten Zeitschichtcodes.	"qtl,month,year"
(Keine)
Inhalt des Elements
(Keine)

Dimensionselement
Tag-Name		Dimension
Beschreibung		Eine der Dimensionen, die für dieses Cube-Tabellenblatt definiert sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne numerische ID für die Dimension.	34
Ohne Kategorie	J	„Wahr“ bedeutet, dass das Element ohne Kategorie der Dimension selbst als Auswahl im Cube-Tabellenblatt verfügbar ist.	wahr
Rollup	J	„Wahr“ bedeutet, dass das Rollup-Element der Dimension selbst (das Rollup aller Elemente) als Auswahl im Cube-Tabellenblatt verfügbar ist.	wahr
Name	J	Der Name dieser Dimension.	"Produktposten"
newValueBehavior	J	Erwartetes Verhalten für die Verfügbarkeit neuer Dimensionswerte, entweder verfügbar, nicht verfügbar oder übergeordnet.	Übergeordnetes Element
isEditableOnSheet	N	Kennzeichen, das angibt, ob diese Dimension im Tabellenblatt bearbeitbar ist.	wahr
(Keine)
Inhalt des Elements
Mindestens ein Wertelement.

Element „Benutzer“.
Tag-Name		Benutzer(n)
Beschreibung		Container für Tabellenblätter mit Benutzerzuweisung, der die Eigenschaften für Barrierefreiheit für ein Cube-Tabellenblatt angibt. Der aufrufende Benutzer benötigt die Berechtigung „Modell“, um dieses Element und alle untergeordneten Elemente dieses Elements anzuzeigen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
isExcludedFromWorkflow	J	Kennzeichen, das angibt, ob ein Tabellenblatt vom Workflow ausgeschlossen ist oder nicht.	wahr
Inhalt des Elements
Ein oder mehrere Benutzerelemente.

-Benutzerelement
Tag-Name		Benutzer
Beschreibung		Einer der Benutzer, die dem Tabellenblatt zugewiesen sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Ganzzahlwert, der die eindeutige ID eines zugewiesenen Benutzers angibt.	11
Inhalt des Elements
(Keine)

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt die Definition des angegebenen modellierten oder Cube-Tabellenblatts zurück.
Zum Aufrufen sind Berechtigungen erforderlich	IMP (Daten importieren) oder MK (Tabellenblätter erstellen, bearbeiten und löschen)
Auf Anforderung erforderliche Parameter	Zugangsdaten und eine Angabe, welches Tabellenblatt angefordert wird.