Referenz für interne IDs
Sie können interne IDs in eine API-Anforderung aufnehmen, um Metadaten für die Methoden zum Erstellen, Aktualisieren und Lesen abzurufen. Wenn Sie diese Methoden anfordern, verwenden Sie die zugehörigen Export-API-Aufrufe, um die für Ihre Anforderung erforderlichen IDs abzurufen. Die Anforderungen für alle APIs in der folgenden Tabelle erfordern ein Element "Zugangsdaten".
Beispiel
Sie müssen die Dimensions-ID übergeben, um eine Dimension in der API-Anforderung updateDimensions zu aktualisieren. Sie können die Dimensions-ID "7" übergeben, um die Dimension "Ausbildung
" zu aktualisieren.
<dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> -------------------------- </dimension> </dimensions>
Dimensions-ID "7" für "Education" wird aus exportDimensions API-Antwort abgerufen.
<response success="true"> <output> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> -------------------------------------------- </dimension> </output> </response>
APIs und Antwort-IDs exportieren
API (Application Programming Interface) | Adaptive Planning Interne IDs in Antwort | Metadaten abgerufen |
|---|---|---|
Konto-ID und Kontoattribut-ID
Konto-IDs können verwendet werden, um Konten in anderen API-Aufrufen zu identifizieren, z. B. exportDimensionFamilies. Tabellenblattelement ist optional. Wenn Sie das Tabellenblattelement einschließen, müssen Sie die interne System-ID für das Tabellenblatt in Ihrer Anforderung übergeben. Siehe exportSheet. | Liste aller Konten, einschließlich aller Kontoarten: Annahmen, Cube-Konten, benutzerdefinierte Konten, Hauptbuch-Konten, Metrikkonten und modellierte Konten. | |
Währungs-ID Damit kann die Währung eindeutig identifiziert und in der customReportValues -API verwendet werden. | Liste aller Währungen, die im System konfiguriert wurden. | |
Dimensions-ID und ihre Element-ID dimensionValue Dies kann verwendet werden, um Dimensionen in anderen API-Aufrufen zu identifizieren, z. B. exportDimensionFamilies. | Liste aller Dimensionen im System. | |
Benutzergruppen-ID und Benutzer-ID, dem Eigentümer dieser Benutzergruppe (nur festgelegt bei isGlobal = "false"). | Liste aller Gruppen, die für die angegebene Instanz definiert sind. Dazu gehören die Gruppen, die für die gesamte Instanz global definiert sind, und die von Benutzern definierten Gruppen. | |
Verfügbar in API v25 und höher. | Berechtigungssatz-ID Hiermit wird der Berechtigungssatz identifiziert, der einem Benutzer im API-Aufruf exportUsers zugewiesen ist. | Liste aller Berechtigungssätze in der Instanz. |
Rollen-ID Hiermit wird die Rolle identifiziert, die einem Benutzer im API-Aufruf exportUsers zugewiesen ist. | Liste aller Rollen in der Instanz. | |
Tabellenblatt-ID (diese können Standard-, Cube- oder modellierte Tabellenblattelemente sein) Dies kann verwendet werden, um Tabellenblätter in anderen API-Aufrufen zu identifizieren, z. B. exportSheetDefinition. | Liste aller für die angegebene Instanz definierten Tabellenblätter. Dazu gehören „unvollständige“ Tabellenblätter sowie Tabellenblätter mit Benutzerzuweisung. | |
ID der Zeitperiode für Ausgangssaldo | Zeitmetadaten entweder für eine bestimmte Version oder für alle Versionen, wenn keine Version angegeben ist. | |
IDs für Dimension-, Textauswahl- und Wertelemente. | Definition (verfügbare Spalten) der Transaktionen in der Instanz. | |
-Benutzer-ID und die diesem Benutzer zugewiesene Rollen-ID | Liste aller Benutzer in der Instanz. | |
Versions- oder Ordner-ID Alle IDs sind in allen Versionen, Unterversionen und Ordnern eindeutig. | Ein XML-Dokument, das den Satz aller in der Instanz definierten Versionen beschreibt, die nach der Verifizierung für den anfordernden Benutzer nicht ausgeblendet werden. |