exportDimensions
Diese API unterstützt nur Benutzer Konzept: Zugriffsregeln in API v22 und höher.
Kategorie
| Abrufen von Metadaten |
Beschreibung
| Gibt Metadaten für die vollständige Liste aller Dimensionen im System zurück. |
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 den vollständigen Satz der benutzerdefinierten Dimensionen im System beschreibt, einschließlich aller ihrer Elementwerte. Diese Methode gibt keine der erforderlichen Systemdimensionen wie Version, Zeit oder Konten zurück, die jeweils in einem eigenen Metadaten-API-Aufruf verfügbar sind. Elementwerte innerhalb einer Dimension werden in Baumform zurückgegeben, wobei übergeordnete Elemente ihre untergeordneten Elemente enthalten.
Sie können Dimensions-IDs mithilfe von suchen
exportDimensions
-Anforderung ohne Dimension-IDs-Element. Dadurch wird eine Liste aller Dimensionen und deren IDs erstellt. Prüfen Sie die Antwort, um die benötigten Dimensions-IDs zu finden. Dimensions-IDs sind in nicht verfügbar Adaptive Planning
Webbenutzeroberfläche.Anforderungsformat
<?xml version='1.0' encoding='UTF-8'?> <call method="exportDimensions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include versionName="Budget 2004" dimensionIDs="1,2,4,5" dimensionValues="true"/> </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 |
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 einschließen
| |||
Tag-Name
| einschließen | ||
Beschreibung
| Stellt einen Satz von Kennzeichen dar, die angeben, welche Aspekte der Informationen zu "Dimensionswerten" in die Antwort aufgenommen oder daraus ausgeschlossen werden sollen. Dieses Element ist optional: Wenn es nicht vorhanden ist, ist der Standardwert für versionName/versionID leer (oder alle Versionen). | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
versionName Aktualisiert in API v18 | N | Gibt an, ob die Antwort Dimensionswerte ausschließen soll, die für den angeforderten Versionsnamen nicht verfügbar sind. Wenn das Element oder sein Attribut nicht vorhanden ist, werden standardmäßig alle Dimensionen und Werte zurückgegeben. Wenn ein Versionsname angegeben wird, werden keine Dimensionswerte zurückgegeben, die für die angegebene Version nicht verfügbar sind. Wenn der angegebene Versionsname nicht gefunden wird, gibt diese API einen Fehler zurück. Wenn sowohl das Attribut versionName als auch versionID übergeben werden, wird die versionID ignoriert. <?xml version='1.0' ending 0" listDimension="0" behältSorted="0" useOnLevels="1" SEQNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" kurzName=""> <dimensionValue id=" 52" name="QA" description="Quality Assurance" kurzName="" /> <dimensionValue id="53" name="Dev" description="Deentwicklung" kurzName="" /></dimensionValue> ="dimension> <dimension id="7" name="Education" ShortName="" automatischeCreate="0" listDimension="1" behältSorted="0" useOnLevels="0" SEqNo="21"> <dimensionValue id="32" Name = Graduate > <dimensionValue id="33" name="Masters" description="Master-Abschluss" ShortName=""> <attributes> <attribute AttributeId="21" name="Ausbildungsart" valueId="196" value="Management" /> ="attributup tes> ="dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" ShortName="" /> ://dimension> ="dimensions> ="output> ="response> Wenn Sie eine Version angeben, ist der Aufruf nur dann erfolgreich, wenn der Benutzer Zugriff auf die Version hat. | Budget 2004 |
versionID Wird unterstützt in API v17 + Aktualisiert in API v18 | N | Identisch mit versionName (oben), außer dass eine Versions-ID-Nummer als Parameter verwendet wird. Gibt an, ob die Antwort Dimensionswerte ausschließen soll, die für die angeforderte Version nicht verfügbar sind. Wenn das Element oder sein Attribut nicht vorhanden ist, werden standardmäßig alle Dimensionen und Werte zurückgegeben. Wenn eine Versions-ID angegeben wird, werden keine Dimensionswerte zurückgegeben, die für die angegebene Version nicht verfügbar sind. Wenn die angegebene Versions-ID nicht gefunden wird, gibt diese API einen Fehler zurück. Wenn sowohl das Attribut versionName als auch versionID übergeben werden, wird die versionID ignoriert. Wenn Sie eine Version angeben, ist der Aufruf nur dann erfolgreich, wenn der Benutzer Zugriff auf die Version hat. | 3 |
dimensionIDs Wird unterstützt in API v17 + | N | Eine Liste der IDs, die in der API-Antwort angezeigt werden. Dadurch wird nach einer Dimension gefiltert, aber nicht nach einem Dimensionswert. | "1,2,3,14" |
Attribute | N | Gibt an, ob die Antwort die Attribute in der Antwort für jede flache Dimension enthalten soll. | false |
in AccessibleValues Wird unterstützt in API v18 + | N | Gibt an, ob die Antwort Werte enthalten soll, auf die der aktuelle Benutzer nicht zugreifen kann. Der Standardwert ist „false“. Nur Benutzer mit den Berechtigungen "Modellierung" oder "In alle Ebenen importieren" können diese Option auf "true" setzen. | 1 |
dimensionValues Wird unterstützt in API v22 und höher | N | Gibt an, ob die Antwort Dimensionswerte für jede Dimension enthalten soll. Der Standardwert ist „true“. Bei „false“ werden nur gefilterte Dimensionen und nicht die Dimensionswerte zurückgegeben. Wenn dimensionValues nicht Teil des Elements include ist, werden alle Dimensionen und deren Werte zurückgegeben. Wenn das Element „Include“ nicht Teil der Anforderung ist, werden alle Dimensionen und deren Werte zurückgegeben. | false |
displayNameEnabled
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | displayNameEnabled=true gibt an, dass exportDimensions die Eigenschaften des Anzeigenamens von berücksichtigen sollten code , displayNameType , und description wenn Enable Anzeige Name für die Instanz EIN ist.displayNameEnabled = false gibt an, dass die exportDimensions API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die exportDimensions-API ignoriert die Eigenschaften des Anzeigenamens code , displayNameType und description .Der Standardwert für displayNameEnabled ist "false". | wahr |
Inhalt des Elements
| |||
(Keine) | |||
Antwortformat
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""/> <dimensionValue id="52" name="QA" description="Quality Assurance" shortName=""/> <dimensionValue id="53" name="Dev" description="Development" shortName=""/> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue> <dimensionValue id="33" name="Masters" description="Masters degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> </attributes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName=""/> </dimension> <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" seqNo="14" property1="Latitude" property2="Longitude"> <dimensionValue id="521" name="United States" description="USA" shortName=""> <dimensionValue id="555" name="Alabama" description="1" shortName=""> <dimensionValue id="579" name="205" description="1" shortName=""> <dimensionValue id="4718" name="35004" description="1" shortName=""> <properties> <property name="Latitude" value="33.606" /> <property name="Longitude" value="-86.502" /> </properties> </dimensionValue> <dimensionValue id="4719" name="35005" description="" shortName=""> <properties> <property name="Latitude" value="33.593" /> <property name="Longitude" value="-86.96" /> </properties> </dimensionValue> <dimensionValue id="5073" name="35006" description="" shortName="" /> <dimensionValue id="5074" name="35007" description="" shortName="" /> </dimensionValue> </dimensionValue> <properties> <property name="Latitude" value="37.0902" /> <property name="Longitude" value="95.7129" /> </properties> </dimensionValue> </dimension> </dimensions> </output> </response>
Dimensionen werden nach Name sortiert.
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 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 „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
| Stellt eine einzelne benutzerdefinierte Dimension dar, die in der Antwort auf einen exportDimensions-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
id | J | Die interne System-ID-Nummer für die Dimension. Dies kann verwendet werden, um Dimensionen in anderen API-Aufrufen zu identifizieren, z. B. exportDimensionFamilies. | 16 |
Name | J | Der Name der Dimension, wie er in Berichten und Tabellenblättern angezeigt wird. | Customer |
-Code
Nur in API v39 und höher verfügbar. | N | Der Name der Dimension, wie er in Berichten und Tabellenblättern angezeigt wird. Wird nur mit API v39 und höher angezeigt | Customer |
displayNameType
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | Die interne Darstellung des ausgewählten Formats des Anzeigenamens für Werte auf den Seiten zur Dimensionsverwaltung.
| NAME |
shortName | N | Der Kurzname für die Dimension, falls vorhanden, wie in der Dimensionsverwaltung eingegeben. | Kunde |
autoCreate | J | „1“, wenn für die ausgewählte Dimension der Feldsatz „Datenimport erstellt automatisch Dimensionswerte“ festgelegt ist, andernfalls „0“. | 0 |
listDimension | J | 1, wenn die ausgewählte Dimension eine Listendimension ist, andernfalls 0. | 1 |
keepSorted | J | 1, wenn die ausgewählte Dimension sortiert bleibt, andernfalls 0. | 1 |
useOnLevels | J | 1, wenn die ausgewählte Dimension auf Ebenen verwendet werden kann, andernfalls 0. | 1 |
Sequenznr Hinzugefügt in API v17, aber für zukünftige Verwendung reserviert. | |||
Beschreibung
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | Die Beschreibung, wie sie in der Dimensionsverwaltung eingegeben wurde. | |
Inhalt des Elements
| |||
Null oder mehr dimensionValue-Elemente. Jedes eingeschlossene Element dimensionValue stellt einen Root-Dimensionswert in der Dimension dar, einen Wert ohne übergeordneten Wert. | |||
Element dimensionValue
| |||
Tag-Name
| dimensionValue | ||
Beschreibung
| Stellt einen einzelnen Elementwert einer benutzerdefinierten Dimension dar, der in der Antwort auf einen exportDimensions-API-Aufruf zurückgegeben wird. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
id | J | Die interne System-ID-Nummer für diesen Elementwert der Dimension. | 34 |
-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. | Ein Unternehmen |
Name | J | Das Label für den Elementwert der Dimension, wie in Berichten angezeigt und in Formeln verwendet. | Ein Unternehmen |
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. | Ein Unternehmen |
shortName | N | Der Kurzname für den Dimensionswert, falls vorhanden, wie in Dimensionsverwaltung eingegeben | A |
Beschreibung | N | Die Beschreibung des Dimensionswerts, falls vorhanden, wie in Dimensionsverwaltung eingegeben | Ein Unternehmen |
Inhalt des Elements
| |||
Null oder mehr optionale dimensionValue-Elemente. Jedes eingeschlossene Element dimensionValue stellt einen „untergeordneten Dimensionswert“ dieses Dimensionswerts dar, dessen Elemente implizit ein Rollup zu diesem Wert durchführen. Ein optionales Eigenschaftenelement | |||
Properties-Element
| |||
Tag-Name
| -Eigenschaften | ||
Beschreibung
| Optionales Element, das Eigenschaftselemente enthält. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
(Keine) | |||
Inhalt des Elements
| |||
Bis zu fünf Eigenschaftselemente. | |||
Eigenschaftselement
| |||
Tag-Name
| -Eigenschaft | ||
Beschreibung
| Gibt eine benutzerdefinierte Eigenschaft an. Die Eigenschaftselementwerte enthalten nur numerische Zeichen. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Name | J | Der Name der Eigenschaft. | Breitengrad |
Wert | N | Der Wert der Eigenschaft. | 33.6015 |
Inhalt des Elements
| |||
(Keine) | |||
Element „Attribute“.
| |||
Tag-Name
| Attribute | ||
Beschreibung
| Container für ein oder mehrere Dimensionsattributelemente. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
(Keine) | |||
Inhalt des Elements
| |||
Ein oder mehrere Attributelemente. | |||
Attributelement
| |||
Tag-Name
| Attribut | ||
Beschreibung
| Container für ein Dimensionsattributelement. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
attributeID | J | Die ID des vom System generierten Dimensionsattributs. | 20 |
Name | J | Der Name des Dimensionsattributs | Art der Ausbildung |
valueID | J | Die eindeutige ID des vom System generierten Dimensionsattributwerts. | 170 |
Wert
Wird in API v34 unterstützt, wenn die Einstellung Gültiger Anzeigename auf EIN gesetzt ist. | J | Der Wert des Dimensionsattributs. | Tech1 |
valueCode
Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren. Wird in API v34 nicht unterstützt. | N | Der Code des Attributwerts für dieses Attribut.
Für API v32 und API v33 ist valueCode nur in folgenden Fällen sinnvoll:
| Tech1 |
valueName
Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren. Wird in API v34 nicht unterstützt. | N | Der Name des Attributwerts für dieses Attribut.
Für API v32 und API v33 ist valueName nur in folgenden Fällen sinnvoll:
| Tech1 |
valueDisplayName
Nur in API v32 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | J | Für API v32 und höher ist valueDisplayName nur in folgenden Fällen sinnvoll:
| Tech1 |
Inhalt des Elements
| |||
(Keine) | |||