Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2024-09-20
Definitie gemodelleerd blad

Definitie gemodelleerd blad

URL-eindpunt

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/modeled/definition
Versie: v1
Categorie
Gegevensverzending
Omschrijving
Metadata Modification
Vereiste machtigingen voor aanroepen
Toegangsmodel voor modelbeheer
omvat: bladen, rekeningen, dimensies en formules
Vereiste parameters voor aanvraag
Naam

Ondersteunde HTTP-werkwoord(en)

HTTP-werkwoord
Eén resource
Inningsresource
Omschrijving
PATCH
Ondersteund
Niet ondersteund
Een gemodelleerde bladdefinitie invoegen of bijwerken
DELETE
Ondersteund
Niet ondersteund
Definitie gemodelleerd blad verwijderen
POST
Ondersteund
Niet ondersteund
Validatiemodus voor gemodelleerde bladdefinitie upsert.
OPTIES
Ondersteund
Niet ondersteund
Retourneert de lijst met HTTP-werkwoorden die worden ondersteund voor deze verzamelingsresource.

PATCH

Aanvraag-URI
/sheet/modeled/definition
Werk de gemodelleerde bladdefinitie bij die overeenkomt met de opgegeven queryparameter.
Als er geen blad met de overeenkomende ID bestaat, wordt er een nieuw gemodelleerd blad met de opgegeven eigenschappen gemaakt.
Voorbeeldaanvraag op naam
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
Kop voorbeeldaanvraag
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
Zie de sectie Hoofdtekst van aanvraag
Query Parameters
Naam
Omschrijving
Vereist
instanceCode
De instanceCode waaruit waarden moeten worden opgehaald. Bijvoorbeeld GLOBO. Als er geen instanceCode is opgegeven, wordt de standaardinstance van de gebruiker gebruikt.
N
Naam
De naam van het blad.
N
doorgaanWithWarnings
Of de upsert een waarschuwingsvalidatie moet negeren, meestal geretourneerd wanneer een gewijzigde bladeigenschap gegevens uit het blad kan verwijderen.
N
opnieuw ordenenKolommen
Als u deze queryparameter instelt op true, wordt de volgorde van de kolomlijst aangepast aan de volgorde van de kolommen in de hoofdtekst van de API-aanvraag. Deze is standaard ingesteld op 'false'. Zie Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs.
N
Hoofdtekst van aanvraag
Hoofdtekst voorbeeldaanvraag
Dezelfde indeling voor de gemodelleerde bladdefinitie wordt gebruikt als de JSON-payload voor beide eindpunten.
Aanvraagindeling
 
{
  "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
  }
}
Bladdefinitieobject
Naam
Omschrijving
Vereist
eigenschappen
Object met algemene bladeigenschappen
N
kolommen
Lijst met gemodelleerde bladkolomobjecten.
Nieuwe kolommen worden aan het einde van de bladdefinitie gemaakt en de relatieve volgorde van nieuwe kolommen wordt gerespecteerd.
Bestaande kolommen worden alleen ter plaatse bijgewerkt. ze worden niet opnieuw gerangschikt.
N
rekeningen
Lijst met rekeningobjecten
N
toegankelijkheid
Object met gedefinieerde toegankelijkheid voor aan gebruikers toegewezen bladen.
N
Bladeigenschappenobject
Naam
Omschrijving
Vereist
Type
Standaard
Omschrijving
Bladomschrijving.
N
tekenreeks
Lege tekenreeks
code
Bladcode die wordt gebruikt als voorvoegsel voor rekeningcodes en een secundaire unieke ID. Vereist bij het maken van een nieuw blad.
N
tekenreeks
voorvoegsel
Bladvoorvoegsel dat wordt gebruikt voor de rekeningcode. Vereist bij het maken van een nieuw blad. Verouderd ten gunste van code.
N
tekenreeks
userAssigned
Of het blad een aan gebruikers toegewezen blad is of (standaard) een aan niveaus toegewezen blad.
N
Boole-waarde
false
salaryDetail
Of het blad salarisdetails bevat.
N
Boole-waarde
false
frozenColumnCount
N
geheel getal
0
allowSplits
Of het blad gesplitste rijen toestaat.
N
Boole-waarde
false
allowRollupModelEdits
Of het blad bewerkingen toestaat tijdens het weergeven van totalisatieniveaus.
N
Boole-waarde
false
toestaanWerkelijke waarden
Of het blad beschikbaar is in versies met werkelijke waarden.
N
Boole-waarde
false
recalculateOnDemand
Of opnieuw berekenen op aanvraag is ingeschakeld voor het blad.
N
Boole-waarde
false
timeStratumCode
De tijdstratumcode die is gekoppeld aan de gegevens in het blad.
N
tekenreeks
GB-tijdstratum
Bladkolomobject
Naam
Omschrijving
Vereist
Type
Standaard
eigenschappen
Object met bladkolomeigenschappen.
J
object
beschikbaarheid
Lijst met bladbeschikbaarheidsobjecten voor de huidige kolom. Zie Sheet Availability voor meer informatie over de lijstindeling.
N
lijst
standaardbeschikbaarheid
De standaardbeschikbaarheid die moet worden toegepast op alle waarden, tenzij anders aangegeven in beschikbaarheid. Geldig voor niveau- en dimensiekolommen.
Als voor dimensiekolommen geen beschikbaarheid of standaardbeschikbaarheid is opgegeven, wordt standaardbeschikbaarheid ingesteld op waar voor nieuwe kolommen.
Deze waarde is standaard leeg, wat betekent dat de bestaande beschikbaarheid behouden blijft, tenzij deze specifiek via beschikbaarheid wordt gewijzigd.
N
Boole-waarde
defaultActionIfDataIsPresent
De standaardactie als er gegevens aanwezig zijn bij het verwijderen van een waarde, tenzij anders aangegeven in beschikbaarheid. Geldig voor dimensiekolommen.
Vereist wanneer Standaardbeschikbaarheid onwaar is voor bestaande kolommen.
N
tekenreeks
verwijderen
Aanvraag om kolom uit het opgegeven blad te verwijderen. Niet geldig voor kolommen die afhankelijk zijn van bestaande kolommen die niet zijn gemarkeerd voor verwijdering (zoals dimensiekenmerken).
N
Boole-waarde
Eigenschappenobject bladkolommen
Naam
Omschrijving
Vereist
Type
Standaard
Naam
Kolomnaam.
N
tekenreeks
code
De kolomcode. Vereist voor alle kolommen behalve niveau- en niveauvalutakolommen.
J
tekenreeks
type
Het type kolom.
Mogelijke waarden: LEVEL, DIMENSION, LEVEL_ATTRIBUTE, DIMENSION_ATTRIBUTE, TIMESPAN, NUMBER, DATE, TEXT, TEXT_SELECTOR, LEVEL_CURRENCY, DISPLAY, INITIAL_BALANCE, CHECKBOX
J
tekenreeks
readOnly
Of de huidige kolom alleen-lezen is of niet. Voor dimensiekenmerkkolommen stelt u alleen-lezen in op false om het kenmerk als filter voor de dimensie te gebruiken.
Vereist waar (en is standaard ingesteld op true) voor niveaukenmerken en weergavekolommen.
N
Boole-waarde
false
allowSplits
Of de huidige kolom kan worden gesplitst. Alleen geldig voor bladen wanneer de algemene eigenschap allowSplits waar is.
N
Boole-waarde
false
showTotalsAtBottom
Of totalen voor deze kolom onder aan het blad moeten worden weergegeven.
N
Boole-waarde
false
toestaanVerborgen
Of deze kolom kan worden verborgen in de bladlezer in Weergaveopties. Geldig voor alle kolommen behalve tekstselectie- en tijdspannekolommen.
N
Boole-waarde
waar
editableOnSheet
Of nieuwe waarden vanuit het blad aan de dimensiekolom kunnen worden toegevoegd. Alleen geldig voor dimensie- en tekstselectiekolommen.
N
Boole-waarde
false
vereist
Of elke rij een waarde in deze kolom moet hebben. Alleen geldig voor dimensiekolommen waarvoor allowHidden onwaar is.
N
Boole-waarde
false
recalculateOnMatch
Of waarden bij match opnieuw moeten worden berekend. Alleen geldige dimensie- en tekstselectiekolommen voor bladen waarvoor herberekenenOp aanvraag waar is.
N
Boole-waarde
false
lookupTables
Lijst met LookupTable-objecten om spreidings- en waardeopzoektabellen te definiëren. Alleen geldig voor dimensie- en tekstselectiekolommen.
N
LookupTable
null
waarden
Lijst met tekenreeksen die als tekstselectiewaarden moeten worden toegevoegd. Alleen geldig voor tekstselectiekolommen.
N
tekenreeksarray
null
rowKey
Of deze kolom als rijsleutel kan worden gebruikt. Alleen geldig voor kolommen met tekststuurprogramma's.
N
Boole-waarde
false
displayAs
De notatie Weergeven als voor de kolom. Alleen geldig voor kolommen met numerieke stuurprogramma's.
Mogelijke waarden: NUMBER, PERCENT, CURRENCY
N
DisplayAs
false
decimalPrecision
De decimale precisie die moet worden weergegeven. Alleen geldig voor kolommen met numerieke stuurprogramma's.
Mogelijke waarden: 0 tot en met 9, of -1 om de valutaprecisie te gebruiken bij weergave als VALUTA.
N
geheel getal
0
showToggle
Of een kolom met selectievakjes als schakeloptie moet worden weergegeven. Alleen geldig voor kolommen met selectievakjes.
N
Boole-waarde
false
showInEditMode
Of de kolom moet worden weergegeven in bewerkbare rijen van het gemodelleerde blad. Alleen geldig voor niveauvalutakolommen.
N
Boole-waarde
false
referenceTimePeriod
Hiermee wordt de referentieperiode voor een weergavekolom aangegeven. Alleen geldig voor rekeningweergavekolommen.
Mogelijke waarden: FIRST_NON_ACTUALS_PERIOD, START_OF_PLAN
N
tekenreeks
FIRST_NON_ACTUALS_PERIOD
startOfRollupRange
Hiermee wordt aangegeven waar een periodetotalisatiebereik voor een weergavekolom moet beginnen. Alleen geldig voor rekeningweergavekolommen.
Mogelijke waarden: CONTAINING_REFERENCE_PERIOD, BEFORE_REFERENCE_PERIOD, AFTER_REFERENCE_PERIOD
N
tekenreeks
CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange
Aantal perioden dat moet worden opgenomen in het totalisatiebereik voor een weergavekolom. Alleen geldig voor rekeningweergavekolommen.
N
geheel getal
1
startOfRollupRangeTimeStratumCode
Code van de tijdsperiode om het begin van het totalisatiebereik voor een weergavekolom te bepalen. Alleen geldig voor rekeningweergavekolommen. Mogelijke waarden zijn onder meer tijdstrata die gelijk zijn aan of hoger zijn dan het tijdstratum van het blad.
N
tekenreeks
Tijdstratum blad
accountCode
Code van de rekening om de gemodelleerde rekening voor een weergavekolom te bepalen. Alleen geldig voor weergavekolommen. Alleen geldige waarden zijn rekeningen op het opgegeven gemodelleerde blad
N
tekenreeks
Bladkolomopzoektabelobject
Naam
Omschrijving
Vereist
Type
Standaard
Naam
Naam opzoektabel.
J
tekenreeks
displayAs
De notatie Weergeven als voor deze opzoektabel. Mogelijke waarden: NUMBER en PERCENT. Alleen geldig voor waardeopzoektabellen.
N
tekenreeks
NUMBER
decimalPrecision
De decimale precisie voor waarden in deze opzoektabel. Mogelijke waarden: 0 t/m 9.
N
geheel getal
0
type
Het type opzoektabel. Mogelijke waarden: VALUE, SPREAD.
J
tekenreeks
Bladrekeningobject
Naam
Omschrijving
Vereist
Naam
De rekeningnaam.
J
code
De rekeningcode.
J
bovenliggend
De bovenliggende rekening.
N
Omschrijving
De rekeningomschrijving.
N
isCumulative
Retourneert of de rekening cumulatief is.
N
isActualsByDelta
Retourneert of de rekening werkelijke waarden is op basis van delta.
N
isLink
Retourneert of de rekening een gekoppelde rekening is of niet.
N
timeRollupType
Het type totalisatie dat moet worden uitgevoerd voor tijdtotalisaties.
N
timeWeightAccount
De wegingsrekening die wordt gebruikt voor tijdtotalisaties.
N
levelDimRollupType
Het type totalisatie dat moet worden uitgevoerd voor totalisaties van niveaus/aangepaste dimensies.
N
levelDimWeightAccount
De wegingsrekening die wordt gebruikt voor totalisaties van niveaus/aangepaste dimensies.
N
levelDimRollupText
De waarde van de totalisatietekst die wordt gebruikt in niveau-/aangepaste dimensietotalisaties.
N
actualsOverlay
De overlay-instelling voor werkelijke waarden voor de rekening.
N
attributeValues
Lijst met rekeningkenmerkwaarde-objecten voor deze rekening.
N
displayAs
De weergave als instelling voor de rekening.
N
formule
De rekeningformule.
N
weightedAverageTranslationsEnabled
Retourneert of omrekeningen van het gewogen gemiddelde voor de rekening zijn ingeschakeld.
N
weightedAverageTranslationResetStratum
Het WAT-reststratum voor deze rekening.
N
weightedAverageTranslationTransferAccount
De WBT-overdrachtsrekening voor deze rekening.
N
decimalPrecision
De standaarddecimaalprecisie voor de rekening.
N
exchangeRateType
Het wisselkoerstype voor deze rekening.
N
nullen onderdrukken
Retourneert of de nulrijen moeten worden onderdrukt voor de rekening op bladen.
N
startExpanded
Retourneert of de rekening uitgevouwen op het blad begint.
N
dataEntryType
De instelling voor het gegevensinvoertype voor deze rekening.
N
dataPrivacy
De instelling voor gegevensprivacy voor deze rekening.
N
hasSalaryDetail
Retourneert of de rekening salarisdetails bevat of niet.
N
isBreakbackEligible
Retourneert of verdeling in aanmerking komt voor deze rekening.
N
isSystemAccount
Retourneert of deze rekening een systeemrekening is of niet.
N
isIntercompany
Retourneert of dit een intercompany rekening is of niet.
N
isAanname
Retourneert of de rekening een aanname is of niet.
N
isMetric
Retourneert of de rekening een metriekrekening is of niet.
N
modeledSheetSpreadCode
De spreidingscode van het gemodelleerde blad voor de gekoppelde modelspreiding.
N
spreadTargetAccount
Het doelrekeningobject van de spreidingsrekening.
N
Toegankelijkheidsobject blad
Naam
Omschrijving
Vereist
Type
Standaard
gebruikersnamen
Lijst met gebruikersnamen die aan het blad moeten worden toegevoegd.
Moet de vorm hebben van geldige e-mailadressen.
N
tekenreeksarray
excludedFromWorkflow
werkt het selectievakje
Uitgesloten van werkstroom
 in de toegankelijkheidsinstellingen van het blad bij
N
Boole-waarde
false
Voorbeeldantwoord:
204
Geslaagd antwoord is leeg met statuscode 204.

DELETE

Aanvraag-URI
/sheet/modeled/definition
Verwijder de gemodelleerde bladdefinitie die overeenkomt met de opgegeven queryparameter. Als een blad met de overeenkomende ID niet bestaat, treedt de fout Niet gevonden op.
Voorbeeldaanvraag op naam
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
Kop voorbeeldaanvraag
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
<None>
Query Parameters
Naam
Omschrijving
Vereist
Naam
De naam van het gemodelleerde blad.
N
instanceCode
De instanceCode waaruit waarden moeten worden opgehaald. Bijvoorbeeld GLOBO. Als er geen instanceCode is opgegeven, wordt de standaardinstance van de gebruiker gebruikt.
N
Voorbeeldantwoord:
204
Geslaagd antwoord is leeg met statuscode 204.

POST

Aanvraag-URI
/sheet/modeled/definition/validate
Een aanvraag voor een gemodelleerde bladdefinitie valideren.
Voorbeeldaanvraag op naam
https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/modeled/definition/validate?name=My Sheet
Kop voorbeeldaanvraag
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
<Hieronder gedocumenteerd>
Query Parameters
Zie het relatieve eindpunt dat wordt gevalideerd (bijv. PATCH).
Hoofdtekst van aanvraag
Hoofdtekst voorbeeldaanvraag
Dezelfde indeling voor de gemodelleerde bladdefinitie wordt gebruikt als de JSON-payload voor het eindpunt dat wordt gevalideerd. Het object
validationOptions
 is vereist in de payload bij het verzenden van een validatieaanvraag.
Aanvraagindeling
 
{

  "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",

...
Validatieoptieobject
Naam
Omschrijving
Vereist
httpMethod
Hiermee wordt aangegeven welk API-eindpunt van het gemodelleerde blad wordt gevalideerd. Ondersteunt momenteel de volgende eindpunten:
  • PATCH
J
dependentDimensions
Lijst met dimensienamen waarvan wordt aangenomen dat ze bestaan voor validatie. Dimensies worden niet bewaard als resultaat van de validatieaanvraag. Er wordt van uitgegaan dat alle afhankelijke aangepaste dimensies vlak zijn.
N
dependAttributes
Lijst met afhankelijke kenmerkobjecten. Kenmerken worden niet bewaard als resultaat van de validatieaanvraag.
N
Afhankelijk kenmerkobject
Naam
Omschrijving
Vereist
attributeName
Naam van het afhankelijke kenmerk.
J
attributeType
Type van het afhankelijke kenmerk. Ondersteunde typen zijn:
  • LEVEL_ATTRIBUTE
  • DIMENSION_ATTRIBUTE
J
dimensieName
Naam van de dimensie voor het afhankelijke kenmerk. Alleen van toepassing op en vereist voor dimensiekenmerken. Niet toegestaan voor niveaukenmerken.
N