Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Cube-Tabellenblattdefinition

Cube-Tabellenblattdefinition

URL-Endpunkt

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/cube/definition
Version: v1
Kategorie
Datenübermittlung
Beschreibung
Metadatenänderung
Zum Aufrufen sind Berechtigungen erforderlich
Das Modellmanagement
„Modell beinhaltet“: Tabellenblätter, Konten, Dimensionen und Formeln
Auf Anforderung erforderliche Parameter
Name

Unterstützte HTTP-VERB(s)

HTTP Verb
Einzelressource
Beschreibung
PATCH
Unterstützt
Fügen Sie eine Cube-Tabellenblattdefinition ein oder aktualisieren Sie sie
DELETE
Unterstützt
Löschen Sie eine Cube-Tabellenblattdefinition
OPTIONEN
Unterstützt
Gibt die Liste der für diese Erfassungsressource unterstützten HTTP-Verben zurück.

PATCH

Anforderungs-URI
/sheet/cube/definition
Aktualisieren Sie die Cube-Tabellenblattdefinition, die mit dem angegebenen Abfrageparameter übereinstimmt.
Wenn ein Tabellenblatt mit dem übereinstimmenden Namen nicht vorhanden ist, wird ein neues Cube-Tabellenblatt mit den angegebenen Eigenschaften erstellt.
Beispielanforderung nach Name
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
Beispielanforderungs-Header
Accept-Language: en
Beispielanforderungstext
Siehe Abschnitt Anforderungstext
Abfrageparameter
Name
Beschreibung
Erforderlich
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
Name
Der Name des Tabellenblatts.
N
reorderColumns
Wenn Sie diesen Abfrageparameter auf „true“ setzen, wird die Reihenfolge der Spaltenliste geändert, sodass die Reihenfolge der Spalten im API-Anforderungstext wiedergegeben wird. Standardmäßig ist "false" festgelegt. Siehe: Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs.
N
Anforderungstext
Beispielanforderungstext
Für beide Endpunkte wird dasselbe Cube-Tabellenblattdefinitionsformat als JSON-Nutzlast verwendet.
Anforderungsformat
 
{
   "properties": {
       "description": "Expense Cube",
       "prefix": "Expense",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "ProductFurniture"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "availability":List<SheetAvaliabilityDTO>,
           "defaultAvailability": false
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode"
       }
   ],
   "accessibility": {
       "usernames": [ "test@greenco.com" ],
       "excludedFromWorkflow": true
   }
}
Beispielanforderung:
Beispielanforderung für Tabellenblatterstellung
 
{
   "properties": {
       "description": "Test description",
       "prefix": "TestPrefix",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "Base Pay"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "type": "Account"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Level"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Time"
           }
       },
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "defaultAvailability": true
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode",
           "type": "Standard"
       }
   ]
}
Tabellenblatt-Definitionsobjekt
Name
Beschreibung
Erforderlich
-Eigenschaften
Objekt, das allgemeine Tabellenblatt-Eigenschaften enthält
N
Spalten
Liste der Objekte für Cube-Tabellenblattspalten.
N
Konten
Liste der Kontoobjekte
N
Barrierefreiheit
Objekt, das den Tabellenblattzugriff mit Benutzerzuweisung enthält.
N
Tabellenblatt-Eigenschaften-Objekt
Name
Beschreibung
Erforderlich
Art
Standard
Beschreibung
Tabellenblattbeschreibung
N
Zeichenfolge
Leere Zeichenfolge
prefix
Tabellenblattpräfix, das für den Kontocode verwendet wird.
N
Zeichenfolge
benutzerZugewiesen
Ob es sich bei dem Tabellenblatt um ein Tabellenblatt mit Benutzerzuweisung oder (standardmäßig) mit Ebenenzuweisung handelt.
N
Boolesch
false
timeStratumCode
Der Zeitschichtcode, der mit den Daten im Tabellenblatt verknüpft ist.
N
Zeichenfolge
Hauptbuch-Zeitschicht
recalculateOnDemand
Ob die Neuberechnung auf Anforderung für das Tabellenblatt aktiviert ist.
N
Boolesch
false
rearrangeGLAndCustomAccounts
Ob Benutzer Konten mit Cube-Eingabe mit anderen Cube-Konten neu anordnen können. Dieser Bereich kann nur aktiviert werden, wenn Cube-Standardkonten vorhanden sind oder in der Anforderung erstellt werden.
N
Boolesch
false
hideRollupTotals
Ob Rollup-Summen ausgeblendet werden sollen, um die Tabellenblatt-Performance zu verbessern.
N
Boolesch
false
horizontalAxis
Spaltenreferenzobjekt, das die Spalte auf der horizontalen Achse identifiziert.
N
Spaltenobjekt
Zeit
Vertikale Achse
Liste der Spaltenreferenzobjekte, die die Spalten auf der vertikalen Achse identifizieren. Wenn angegeben, überschreibt die Vertikalachse alle vorherigen Auswahlwerte.
N
Spalten-Objekt-Array
Konto
maxColumnWidth
Maximale Breite in Pixel für jede Spalte. Muss zwischen 10 und 1000 liegen, oder 0, wenn keine Breite angegeben wird.
N
Ganzzahl
0
suppressZeroRows
Ob Zeilen mit Nullen unterdrückt werden.
N
Boolesch
false
Tabellenblattspalten-Referenzobjekt
Name
Beschreibung
Erforderlich
Name
Spaltenname. Erforderlich für benutzerdefinierte Dimensionen und Attribute.
J
type
Spaltenart.
J
Tabellenblattspalten-Objekt
Name
Beschreibung
Erforderlich
-Eigenschaften
Objekt, das Tabellenblattspalten-Eigenschaften enthält.
J
Verfügbarkeit
Liste der Tabellenblattverfügbarkeitsobjekte für die aktuelle Spalte. Siehe: Sheet Availability finden Sie Details zum Listenformat.
N
Standardverfügbarkeit
Die auf alle Werte anzuwendende Standardverfügbarkeit, sofern bei der Verfügbarkeit nicht anders angegeben. Gültig für Ebenen- und Dimensionsspalten.
N
löschen
Anforderung zum Löschen einer Spalte aus dem angegebenen Tabellenblatt. Nicht gültig für Spalten, die von vorhandenen Spalten abhängig sind, die nicht zum Löschen markiert sind (z. B. Dimensionsattribute).
N
Objekt der Tabellenblattspalten-Eigenschaften
Name
Beschreibung
Erforderlich
Art
Standard
Name
Spaltenname. Bei benutzerdefinierten Dimensions- und Attributspalten stimmt der Name mit dem Namen der jeweiligen benutzerdefinierten Dimension oder des jeweiligen Attributs überein.
J
Zeichenfolge
type
Die Art der Spalte.
Mögliche Werte: Ebenen, ACCOUNT, TIME, DIMENSION, LEorganisation_ATTRIBUTE, ACCOUNT_ATTRIBUTE, DIMENSION_ATTRIBUTE
J
Zeichenfolge
initialBalance
Ob der Ausgangssaldo im Tabellenblatt sichtbar sein wird Nur gültig für Spalten "Zeit".
N
Boolesch
wahr
visibleTimeStratumCodes
Definiert die Liste der sichtbaren Zeitschichten im Tabellenblatt. Nur gültig für Spalten "Zeit".
N
Zeichenfolgen-Array
Alle Zeitschichten
editableOnSheet
Ob neue Werte aus dem Tabellenblatt zur Dimensionsspalte hinzugefügt werden können. Nur gültig für Dimensions- und Textauswahlspalten.
N
Boolesch
false
newValueBehavior
Definiert, ob neue Werte aktiviert oder deaktiviert werden sollen, wenn sie zur zugrunde liegenden Dimension hinzugefügt werden. Nur gültig für Dimensionsspalten. Unterstützte Werte: Available, UNVerfügbare oder Parentent
N
Zeichenfolge
VERFÜGBAR
Tabellenblattspalten-Lookup-Tabellenobjekt
Name
Beschreibung
Erforderlich
Art
Standard
Name
Name der Lookup-Tabelle
J
Zeichenfolge
displayAs
Das Format Anzeigen als für diese Lookup-Tabelle. Mögliche Werte: NUMBER und PROCENT. Nur gültig für Werte-Lookup-Tabellen.
N
Zeichenfolge
NUMBER
decimalPrecision
Die Dezimalgenauigkeit für Werte in dieser Lookup-Tabelle. Mögliche Werte: 0 bis 9.
N
Ganzzahl
0
type
Die Art der Lookup-Tabelle. Mögliche Werte: VALUE, Spreader.
J
Zeichenfolge
Tabellenblatt-Kontoobjekt
Name
Beschreibung
Erforderlich
Name
Kontoname
J
-Code
Kontocode
J
Übergeordnetes Element
Das übergeordnete Konto
N
Art
Kontoart
J
Beschreibung
Die Kontobeschreibung
N
shortName
Der Kurzname des Kontos.
N
isCumulative
Gibt zurück, ob das Konto kumulativ ist.
N
isPlanByDelta
Gibt zurück, ob das Konto eine Planung nach Delta ist.
N
isActualsByDelta
Gibt zurück, ob es sich bei dem Konto um Istzahlen nach Delta handelt.
N
isLink
Gibt zurück, ob das Konto ein verknüpftes Konto ist oder nicht.
N
timeRollupType
Die Art des Rollups, die für Zeit-Rollups ausgeführt werden soll.
N
timeWeightAccount
Das für Zeit-Rollups verwendete Gewichtungskonto.
N
levelDimRollupType
Die Art des Rollups, die für Ebenen-/benutzerdefinierte Dimensions-Rollups ausgeführt werden soll.
N
levelDimWeightAccount
Das Gewichtungskonto, das für Rollups von Ebenen/benutzerdefinierten Dimensionen verwendet wird.
N
levelDimRollupText
Der Rollup-Textwert, der in Ebenen-/benutzerdefinierten Dimensions-Rollups verwendet wird.
N
actualsOverlay
Die Einstellung „Istzahlen-Überlagerung“ für das Konto.
N
AttributWerte
Liste der Kontoattributwertobjekte für dieses Konto.
N
displayAs
Die Einstellung „Anzeigen als“ für das Konto.
N
formula
Die Kontoformel.
N
decimalPrecision
Die Standardgenauigkeit für das Konto.
N
exchangeRateType
Die Wechselkursart für dieses Konto.
N
suppressZeros
Gibt zurück, ob die Nullzeilen für das Konto in Tabellenblättern unterdrückt werden sollen.
N
startExpanded
Gibt zurück, ob das Konto im Tabellenblatt eingeblendet wird.
N
dataEntryType
Die Einstellung der Dateneingabeart für dieses Konto.
N
dataPrivacy
Die Datenschutzeinstellung für dieses Konto.
N
linkedAccountMappings
Liste der verknüpften KontenMappings.
N
Objekt für Tabellenblattzugriff
Name
Beschreibung
Erforderlich
Art
Standard
Benutzernamen
Liste der Benutzernamen, die zum Tabellenblatt hinzugefügt werden sollen.
Sie müssen in Form von gültigen E-Mail-Adressen vorliegen.
N
Zeichenfolgen-Array
excludedFromWorkflow
Aktualisiert das Kontrollkästchen „Vom Workflow ausgeschlossen“ in den Einstellungen für den Tabellenblattzugriff.
N
Boolesch
false
Beispielantwort
204
Erfolgreiche Antwort ist leer mit Statuscode 204.

DELETE

Anforderungs-URI
/sheet/cube/definition
Löschen Sie die Cube-Tabellenblattdefinition, die mit dem angegebenen Abfrageparameter übereinstimmt. Wenn ein Tabellenblatt mit der übereinstimmenden ID nicht vorhanden ist, tritt der Fehler „Nicht gefunden“ auf.
Beispielanforderung nach Name
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
Beispielanforderungs-Header
Accept-Language: en
Beispielanforderungstext
<None>
Abfrageparameter
Name
Beschreibung
Erforderlich
Name
Der Name des Cube-Tabellenblatts.
N
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
Beispielantwort
204
Erfolgreiche Antwort ist leer mit Statuscode 204.