Definition des modellierten Tabellenblatts

URL-Endpunkt

Unterstützte HTTP-VERB(s)

PATCH

Anforderungs-URI

/sheet/modeled/definition

Aktualisieren Sie die Definition des modellierten Tabellenblatts, die mit dem angegebenen Abfrageparameter übereinstimmt. Wenn kein Tabellenblatt mit der übereinstimmenden ID vorhanden ist, wird ein neues modelliertes Tabellenblatt mit den angegebenen Eigenschaften erstellt.

Beispielanforderung nach Name

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model

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
proceedWithWarnings	Ob beim Upsert eine Validierung mit Warnung ignoriert werden soll, wird die in der Regel zurückgegeben, wenn eine geänderte Tabellenblatt-Eigenschaft Daten aus dem Tabellenblatt löschen könnte.	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 Definitionsformat für modellierte Tabellenblätter als JSON-Nutzlast verwendet.

Anforderungsformat

{ "properties": { "description": "Capital Model", "prefix": "Capital" }, "columns": [ { "properties": { "code": "Base Pay", "name": "Base Pay", "type": "TEXT_SELECTOR", "values": ["value1", "value2"], "lookupTables": [ { "name": "valueLookup1", "type": "VALUE", "decimalPrecision": 1, "displayAs": "CURRENCY" }, { "name": "spreadLookup1", "type": "SPREAD", "decimalPrecision": 0, "displayAs": "NUMBER" } ] }, "availability": [ { "name": "100k", "code": "100k", "available": true } ], "defaultAvailability": false, "defaultActionIfDataIsPresent": "delete" }, { "properties": { "code": "Label", "name": "Label", "type": "TEXT" }, "delete": true } ], "accounts": [ { "name": "AccountName", "code": "AccountCode" } ], "accessibility": { "usernames": [ "test@greenco.com" ], "excludedFromWorkflow": true } }

Tabellenblatt-Definitionsobjekt

Name	Beschreibung	Erforderlich
-Eigenschaften	Objekt, das allgemeine Tabellenblatt-Eigenschaften enthält	N
Spalten	Liste der Spaltenobjekte für modellierte Tabellenblätter. Neue Spalten werden am Ende der Tabellenblattdefinition erstellt, und die relative Reihenfolge der neuen Spalten wird berücksichtigt. Vorhandene Spalten werden nur direkt aktualisiert. sie werden nicht neu angeordnet.	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
-Code	Tabellenblattcode, der Kontocodes und eine sekundäre eindeutige ID voranstellt. Erforderlich für das Erstellen eines neuen Tabellenblatts.	N	Zeichenfolge
prefix	Tabellenblattpräfix, das für den Kontocode verwendet wird. Erforderlich für das Erstellen eines neuen Tabellenblatts. Zugunsten von Code veraltet.	N	Zeichenfolge
benutzerZugewiesen	Ob es sich bei dem Tabellenblatt um ein Tabellenblatt mit Benutzerzuweisung oder (standardmäßig) mit Ebenenzuweisung handelt.	N	Boolesch	false
salaryDetail	Ob das Tabellenblatt Gehaltsdetails enthält	N	Boolesch	false
frozenColumnCount		N	Ganzzahl	0
Splits zulassen	Ob für das Tabellenblatt gesplittete Zeilen zulässig sind	N	Boolesch	false
allowRollupModelEdits	Ob für das Tabellenblatt Bearbeitungen beim Anzeigen von Rollup-Ebenen zulässig sind.	N	Boolesch	false
allowActuals	Ob das Tabellenblatt in Istzahlen-Versionen verfügbar ist.	N	Boolesch	false
recalculateOnDemand	Ob die Neuberechnung auf Anforderung für das Tabellenblatt aktiviert ist.	N	Boolesch	false
timeStratumCode	Der Zeitschichtcode, der mit den Daten im Tabellenblatt verknüpft ist.	N	Zeichenfolge	Hauptbuch-Zeitschicht

Tabellenblattspalten-Objekt

Name	Beschreibung	Erforderlich	Art	Standard
-Eigenschaften	Objekt, das Tabellenblattspalten-Eigenschaften enthält.	J	-Objekt
Verfügbarkeit	Liste der Tabellenblattverfügbarkeitsobjekte für die aktuelle Spalte. Siehe: Sheet Availability finden Sie Details zum Listenformat.	N	-Liste
Standardverfügbarkeit	Die auf alle Werte anzuwendende Standardverfügbarkeit, sofern bei der Verfügbarkeit nicht anders angegeben. Gültig für Ebenen- und Dimensionsspalten. Wenn für Dimensionsspalten keine Verfügbarkeit oder Standardverfügbarkeit angegeben wird, wird Standardverfügbarkeit für neue Spalten auf „Wahr“ gesetzt. Standardmäßig ist dieser Wert leer, was bedeutet, dass die vorhandene Verfügbarkeit beibehalten wird, es sei denn, sie wird speziell über die Verfügbarkeit geändert.	N	Boolesch
defaultActionIfDataIsPresent	Die Standardaktion, wenn beim Löschen eines Werts Daten vorhanden sind, sofern bei der Verfügbarkeit nicht anders angegeben. Gültig für Dimensionsspalten. Dies ist erforderlich, wenn die Standardverfügbarkeit für vorhandene Spalten falsch ist.	N	Zeichenfolge
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	Boolesch

Objekt der Tabellenblattspalten-Eigenschaften

Name	Beschreibung	Erforderlich	Art	Standard
Name	Spaltenname.	N	Zeichenfolge
-Code	Spaltencode. Erforderlich für alle Spalten außer den Spalten "Ebene" und "Ebenenwährung".	J	Zeichenfolge
type	Die Art der Spalte. Mögliche Werte: LEVE, DIMENSION, LEVE_ATTRIBUTE, DIMENSION_ATTRIBUTE, TIMESpan, NUMBER, DATE, TEXT, TEXT_SELECTOR, Level_CURRENCY, DISorganisation, INIT ID_BALANCE, Checkbox	J	Zeichenfolge
schreibgeschützt	Ob die aktuelle Spalte schreibgeschützt ist oder nicht. Setzen Sie für Dimensionsattributspalten den Wert gelesenNur auf „false“, um das Attribut als Filter für die Dimension zu verwenden. Er muss „true“ sein (und wird standardmäßig „true“) für Ebenenattribute und Anzeigespalten.	N	Boolesch	false
Splits zulassen	Ob die aktuelle Spalte splitbar ist. Nur gültig für Tabellenblätter, wenn die allgemeine Eigenschaft AllowSplits auf „true“ gesetzt ist.	N	Boolesch	false
ShowTotalsAtBottom	Ob Summen unten im Tabellenblatt für diese Spalte angezeigt werden sollen.	N	Boolesch	false
allowHidden	Ob diese Spalte in der Tabellenblattansicht unter Anzeigeoptionen ausgeblendet werden kann. Gültig für alle Spalten außer Textauswahl und Zeitspanne.	N	Boolesch	wahr
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
erforderlich	Ob jede Zeile in dieser Spalte einen Wert haben muss Nur gültig für Dimensionsspalten, bei denen AllowHidden auf „false“ gesetzt ist.	N	Boolesch	false
recalculateOnMatch	Ob Werte bei Übereinstimmung neu berechnet werden sollen. Nur gültige Dimensions- und Textauswahlspalten für Tabellenblätter, bei denen recalculateOnDemand auf „true“ gesetzt ist.	N	Boolesch	false
lookupTables	Liste der LookupTable-Objekte zum Definieren von Verteilungs- und Werte-Lookups. Nur gültig für Dimensions- und Textauswahlspalten.	N	Lookup-Tabelle	0
-Werte	Liste der Zeichenfolgen, die als Textauswahlwerte hinzugefügt werden sollen. Nur gültig für Textauswahlspalten.	N	Zeichenfolgen-Array	0
rowKey	Ob diese Spalte als Zeilenschlüssel verwendet werden kann. Nur gültig für Text-Treiberspalten.	N	Boolesch	false
displayAs	Das Format Anzeigen als für die Spalte. Nur gültig für numerische Treiberspalten. Mögliche Werte: NUMBER, PROCENT, WÄHRUNG	N	Anzeigen als	false
decimalPrecision	Die anzuzeigende Dezimalgenauigkeit. Nur gültig für numerische Treiberspalten. Mögliche Werte: 0 bis 9 oder -1, um die Währungsgenauigkeit zu verwenden, wenn sie als WÄHRUNG angezeigt wird.	N	Ganzzahl	0
showToggle	Ob eine Kontrollkästchen-Spalte als Toggle angezeigt werden soll. Nur gültig für Kontrollkästchen-Spalten.	N	Boolesch	false
showInEditMode	Ob die Spalte in bearbeitbaren Zeilen des modellierten Tabellenblatts angezeigt werden soll. Nur gültig für Spalten für Ebenenwährungen.	N	Boolesch	false
referenceTimePeriod	Gibt die Referenzzeitperiode für eine Anzeigespalte an. Nur gültig für Anzeigespalten für Konten. Mögliche Werte: FIRST_NOn_ACTUALS_PERIOD, START_of_PLAN	N	Zeichenfolge	FIRST_NON_ACTUALS_PERIOD
startOfRollupRange	Gibt an, wo ein Zeitperioden-Rollup-Bereich für eine Anzeigespalte beginnen soll. Nur gültig für Anzeigespalten für Konten. Mögliche Werte: CONtainING_REFERENCE_PERIOD, BEFORE_REFERENCE_PERIOD, After_REFERENCE_PERIOD	N	Zeichenfolge	CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange	Anzahl der Zeitperioden, die in den Rollup-Bereich für eine Anzeigespalte aufgenommen werden sollen. Nur gültig für Anzeigespalten für Konten.	N	Ganzzahl	1
startOfRollupRangeTimeStratumCode	Code der Zeitperiode, um den Start des Rollup-Bereichs für eine Anzeigespalte zu bestimmen. Nur gültig für Anzeigespalten für Konten. Mögliche Werte sind Zeitschichten, die gleich oder höher sind als die Zeitschicht des Tabellenblatts.	N	Zeichenfolge	Zeitschicht in Tabellenblättern
accountCode	Code des Kontos, um das modellierte Konto für eine Anzeigespalte zu bestimmen. Nur für Anzeigespalten gültig. Nur gültige Werte sind Konten im angegebenen modellierten Tabellenblatt	N	Zeichenfolge

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

Weitere Details finden Sie unter Reference: Properties in Account JSON Import Payload

Name	Beschreibung	Erforderlich
Name	Kontoname	J
-Code	Kontocode	J
Übergeordnetes Element	Das übergeordnete Konto	N
Beschreibung	Die Kontobeschreibung	N
isCumulative	Gibt zurück, ob das Konto kumulativ 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
weightedAverageTranslationsEnabled	Gibt zurück, ob für das Konto „Umrechnung mit gewichtetem Durchschnitt“ aktiviert ist.	N
weightedAverageTranslationResetStratum	Die WAT-Restschicht für dieses Konto.	N
weightedAverageTranslationTransferAccount	Das WAT-Transferkonto für dieses Konto.	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
hasSalaryDetail	Gibt zurück, ob das Konto Gehaltsdetails enthält oder nicht.	N
isBreakbackEligible	Gibt zurück, ob der Breakback für dieses Konto auswählbar ist.	N
isSystemAccount	Gibt zurück, ob dieses Konto ein Systemkonto ist oder nicht.	N
isIntercompany	Gibt zurück, ob es sich um ein Intercompany-Konto handelt oder nicht.	N
isAsoption	Gibt zurück, ob das Konto eine Annahme ist oder nicht.	N
isMetric	Gibt zurück, ob das Konto ein Metrikkonto ist oder nicht.	N
modeledSheetSpreadCode	Der Verteilungscode des modellierten Tabellenblatts für die zugehörige Modellverteilung.	N
spreadTargetAccount	Das Zielkontoobjekt des Verteilungskontos.	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/modeled/definition

Löschen Sie die Definition des modellierten Tabellenblatts, 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/modeled/definition?name=Capital Model

Beispielanforderungs-Header

Accept-Language: en

Beispielanforderungstext

<None>

Abfrageparameter

Name	Beschreibung	Erforderlich
Name	Der Name des modellierten 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.

POST

Anforderungs-URI

/sheet/modeled/definition/validate

Validieren Sie eine Definitionsanforderung für ein modelliertes Tabellenblatt.

Beispielanforderung nach Name

https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/modeled/definition/validate?name=My Sheet

Beispielanforderungs-Header

Accept-Language: en

Beispielanforderungstext

<Unten Dokumentiert>

Abfrageparameter

Validierung des relativen Endpunkts anzeigen (d. h. PATCH).

Anforderungstext

Beispielanforderungstext

Dasselbe Format für die Definition des modellierten Tabellenblatts wird als JSON-Nutzlast für den zu validierenden Endpunkt verwendet. Das Objekt

validationOptions

ist in der Nutzlast erforderlich, wenn eine Validierungsanforderung gesendet wird.

Anforderungsformat

{

  "validationOptions": {
      "httpMethod": "Patch",
      "dependentDimensions": [
          "MyTestDim1", "MyTestDim2"
      ],
      "dependentAttributes": [
          {
              "attributeName": "MyTestAttr1",
              "attributeType": "DIMENSION_ATTRIBUTE",
              "dimensionName": "MyTestDim2"
          },
          {
              "attributeName": "MyTestAttr2",
              "attributeType": "LEVEL_ATTRIBUTE"
          }
      ]
  },

  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",

...

Validierungsoptionen

Name	Beschreibung	Erforderlich
httpMethod	Gibt an, welcher API-Endpunkt für modellierte Tabellenblätter validiert wird. Unterstützt aktuell die folgenden Endpunkte: PATCH	J
dependentDimensions	Liste der Dimensionsnamen, die für die Validierung als vorhanden angenommen werden sollen. Dimensionen werden als Ergebnis der Validierungsanforderung nicht beibehalten. Es wird davon ausgegangen, dass alle abhängigen benutzerdefinierten Dimensionen flach sind.	N
abhängigeAttribute	Liste der abhängigen Attributobjekte. Attribute werden als Ergebnis der Validierungsanforderung nicht beibehalten.	N

Abhängiges Attributobjekt

Name	Beschreibung	Erforderlich
attributeName	Name des abhängigen Attributs.	J
attributeType	Art des abhängigen Attributs Unterstützte Arten sind: LEVEL_ATTRIBUTE DIMENSION_ATTRIBUTE	J
dimensionName	Name der Dimension für das abhängige Attribut. Gilt nur für Dimensionsattribute und ist erforderlich. Für Ebenenattribute nicht zulässig.	N