exportDimensionFamilies

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt Metadaten zurück, die die Beziehungen zwischen Kontengruppen und Dimensionssätzen beschreiben.
Zum Aufrufen sind Berechtigungen erforderlich	Keine (es müssen gültige Zugangsdaten für die Instanz sein)
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 eine Reihe von Dimensionsfamilien beschreibt, die beschreiben, wie bestimmte Dimensionsgruppen mit bestimmten Kontengruppen verknüpft sind. Jede Familie besteht aus einer Gruppe von Konten und einer Gruppe von Dimensionen, was bedeutet, dass diese Dimensionen für diese Konten gelten, während andere Dimensionen dies nicht tun. Konten und Dimensionen können zu mehreren Familien gehören. Familien werden wie folgt definiert:

Konten in einem modellierten Tabellenblatt gehören zu einer Familie für dieses Tabellenblatt, die alle auf diesem Tabellenblatt platzierten Dimensionen und alle Organisationsdimensionen enthält.

Konten in einem Cube-Tabellenblatt gehören zu einer Familie für dieses Tabellenblatt, die alle auf diesem Tabellenblatt platzierten Dimensionen und alle Organisationsdimensionen enthält.

Konten in einem Standardtabellenblatt mit Dimensionen gehören zu einer Familie für dieses Tabellenblatt, die alle auf diesem Tabellenblatt platzierten Dimensionen und alle Organisationsdimensionen enthält.

Standardtabellenblättern, auf denen keine Dimensionen platziert sind, ist keine Dimensionsfamilie zugeordnet.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionFamilies" 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 nichts angegeben wird, 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>
   <families>
     <family name="Personal" id="381" accounts="734-739, 744" dimensions="9321,9422, 9455, 9458" />
     <family name="Capital" id="382" accounts="853" dimensions="4" />
     <family name="Sales" id="386" accounts="769, 4112" dimensions="" />
     <family name="Balance" id="255" accounts="545, 66" dimensions="6,7" />
   </families>
 </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 Warnmeldungen in ihrer Antwort enthalten.	wahr
veraltet	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.

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

Element „Familien“.
Tag-Name		Familien
Beschreibung		Container für ein oder mehrere Familienelemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Familienelemente.

Familienelement
Tag-Name		‑familie
Beschreibung		Beschreibt eine einzelne Dimensionsfamilie, die einem einzelnen modellierten oder Cube-Tabellenblatt zugeordnet ist. Eine einzelne Familie wird auch für alle nicht modellierten, nicht Cube-Annahmen und Wechselkurse ausgegeben. Diese Sammelfamilie hat id = 0.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name der Dimensionsfamilie. Die Familie, die aus allen Nicht-Cube-Annahmen und Wechselkurskonten (die keine Dimensionen haben) besteht, hat den Namen „*“. Die Dimensionsfamilie für ein Standardtabellenblatt hat denselben Namen wie das Standardtabellenblatt, während die Dimensionsfamilie für ein Cube- oder modelliertes Tabellenblatt das Präfix des Tabellenblatts als Familiennamen verwendet.	Kapital
id	J	Die ID der Dimensionsfamilie, die die ID des Tabellenblatts ist, durch das diese Familie beschrieben wird.	3
Konten	J	Die Gruppe von Konto-ID-Nummern, die zu dieser Familie gehört. IDs sind die internen System-IDs für die Konten, die im API-Aufruf exportAccounts angezeigt werden. IDs werden durch Kommas getrennt und können Bereiche mit Bindestrich enthalten, was bedeutet, dass alle IDs innerhalb des Bereichs enthalten sind.	734-739,744
Dimensionen	J	Der Satz von Dimensions-ID-Nummern, die zu dieser Familie gehören. IDs sind die internen System-IDs für die Dimensionen, die im API-Aufruf exportDimensions angezeigt werden. IDs werden durch Kommas getrennt und können Bereiche mit Bindestrich enthalten, was bedeutet, dass alle IDs innerhalb des Bereichs enthalten sind.	9321,9422,9455,9458
Inhalt des Elements
(Keine)