exportSheets

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt die vollständige Liste aller für die angegebene Instanz definierten Tabellenblätter zurück. Dazu gehören „unvollständige“ Tabellenblätter sowie Tabellenblätter mit Benutzerzuweisung.
Zum Aufrufen sind Berechtigungen erforderlich	IMP (Daten importieren) oder MK (Tabellenblätter erstellen, bearbeiten und löschen)
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das den vollständigen Satz aller in der Instanz des Benutzers gefundenen Tabellenblätter beschreibt.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSheets" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 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)

Antwortformat


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
    <sheets>
      <modeled-sheet id="1" name="Personnel" prefix="Personnel" description="Personnel Sheet" />
      <modeled-sheet id="2" name="Crossover Personnel" prefix="Crossovers" description="Personnel Sheet" />
      <modeled-sheet id="3" name="Sales" prefix="Sales" description="Sales Sheet" />
      ...
      <standard-sheet id="6" name="Model Summary" prefix="" description="Configurable Model Summary Sheet" />
      <standard-sheet id="8" name="Expenses" prefix="" description="" />
      <standard-sheet id="9" name="Balance" prefix="" description="" />
      <standard-sheet id="10" name="Assumptions" prefix="" description="" />
      ...
      <cube-sheet id="17" name="Expense Cube" prefix="ExpenseCube" description="" />
      <cube-sheet id="19" name="Sale Cube" prefix="SalesCube" description="" />
    </sheets>
  </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
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.

Tabellenblattelement
Tag-Name		Tabellenblatt
Beschreibung		Container für ein oder mehrere Elemente des Standardtabellenblatts, des modellierten Tabellenblatts und der Cube-Tabellenblätter.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Standardtabellenblatt-, modellierte Tabellenblatt- und Cube-Tabellenblattelemente.

Standardtabellenblattelement
Tag-Name		Standardtabellenblatt
Beschreibung		Stellt ein einzelnes Standardtabellenblatt dar, das in der Antwort auf einen exportSheet-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.	123
prefix	J	Das Präfix des Tabellenblatts. Bei Standardtabellenblättern ist dieses Feld immer leer. Andere Tabellenblattarten haben nicht leere Werte für dieses Attribut.
Name	J	Der Name des Tabellenblatts.	Rollup-Moden
Beschreibung	N	Die textuelle Beschreibung des Tabellenblatts, falls vorhanden.	Dies sind die Rollup-Moden ...
Inhalt des Elements
(Keine)

Element „Modelliertes Tabellenblatt“.
Tag-Name		modelliertes Tabellenblatt
Beschreibung		Stellt ein einzelnes modelliertes Tabellenblatt dar, das in der Antwort auf einen exportSheet-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 (API v38 und niedriger) Code (API v39 +)	J	API v38: Das Präfix des Tabellenblatts. API v39: Der Code des Tabellenblatts.	Kapital
Name	J	Der Name des Tabellenblatts.	Kapitalmodell
Beschreibung	N	Die textuelle Beschreibung des Tabellenblatts, falls vorhanden.	Dies ist das Kapitalmodell ...
Inhalt des Elements
(Keine)

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.

Inhalt des Elements

(Keine)