Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2023-06-23
Kubusbladdefinitie

Kubusbladdefinitie

URL-eindpunt

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

Ondersteunde HTTP-werkwoord(en)

HTTP-werkwoord
Eén resource
Omschrijving
PATCH
Ondersteund
Een kubusbladdefinitie invoegen of bijwerken
DELETE
Ondersteund
Een kubusbladdefinitie verwijderen
OPTIES
Ondersteund
Retourneert de lijst met HTTP-werkwoorden die worden ondersteund voor deze verzamelingsresource.

PATCH

Aanvraag-URI
/sheet/cube/definition
Werk de kubusbladdefinitie bij die overeenkomt met de opgegeven queryparameter.
Als er geen blad met de overeenkomende naam bestaat, wordt er een nieuw kubusblad met de opgegeven eigenschappen gemaakt.
Voorbeeldaanvraag op naam
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
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
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 kubusbladdefinitie wordt gebruikt als de JSON-payload voor beide eindpunten.
Aanvraagindeling
 
{
   "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
   }
}
Voorbeeldaanvraag:
Voorbeeldaanvraag voor het maken van bladen
 
{
   "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"
       }
   ]
}
Bladdefinitieobject
Naam
Omschrijving
Vereist
eigenschappen
Object met algemene bladeigenschappen
N
kolommen
Lijst met kolomobjecten voor kubusbladen.
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
voorvoegsel
Bladvoorvoegsel dat wordt gebruikt voor de rekeningcode.
N
tekenreeks
userAssigned
Of het blad een aan gebruikers toegewezen blad is of (standaard) een aan niveaus toegewezen blad.
N
Boole-waarde
false
timeStratumCode
De tijdstratumcode die is gekoppeld aan de gegevens in het blad.
N
tekenreeks
GB-tijdstratum
recalculateOnDemand
Of opnieuw berekenen op aanvraag is ingeschakeld voor het blad.
N
Boole-waarde
false
GLAndCustomAccounts opnieuw rangschikken
Of gebruikers aan een kubus toegevoegde rekeningen opnieuw mogen rangschikken met andere kubusrekeningen. Dit kan alleen worden ingeschakeld als er standaardkubusrekeningen bestaan of in de aanvraag worden gemaakt.
N
Boole-waarde
false
hideRollupTotals
Of totalisatietotalen moeten worden verborgen om de bladprestaties te verbeteren.
N
Boole-waarde
false
horizontalAxis
Kolomverwijzingsobject dat de kolom op de horizontale as identificeert.
N
kolomobject
Tijd
verticale as
Lijst met kolomverwijzingsobjecten die de kolommen op de verticale as identificeren. Als deze optie is opgegeven, worden eerdere selecties overschreven door de verticale as.
N
matrix objectkolom
Rekening
maxColumnWidth
De maximale breedte in pixels voor elke kolom. Moet tussen 10 en 1000 liggen, of 0 als breedte niet is opgegeven.
N
geheel getal
0
nulrijen onderdrukken
Of nul rijen worden onderdrukt.
N
Boole-waarde
false
Bladkolomverwijzingsobject
Naam
Omschrijving
Vereist
Naam
Kolomnaam. Vereist voor aangepaste dimensies en kenmerken.
J
type
Kolomtype.
J
Bladkolomobject
Naam
Omschrijving
Vereist
eigenschappen
Object met bladkolomeigenschappen.
J
beschikbaarheid
Lijst met bladbeschikbaarheidsobjecten voor de huidige kolom. Zie Sheet Availability voor meer informatie over de lijstindeling.
N
standaardbeschikbaarheid
De standaardbeschikbaarheid die moet worden toegepast op alle waarden, tenzij anders aangegeven in beschikbaarheid. Geldig voor niveau- en dimensiekolommen.
N
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
Eigenschappenobject bladkolommen
Naam
Omschrijving
Vereist
Type
Standaard
Naam
Kolomnaam. Voor aangepaste dimensie- en kenmerkkolommen komt de naam overeen met de naam van de respectieve aangepaste dimensie of het respectieve kenmerk.
J
tekenreeks
type
Het type kolom.
Mogelijke waarden: LEVEL, ACCOUNT, TIME, DIMENSION, LEVEL_ATTRIBUTE, ACCOUNT_ATTRIBUTE, DIMENSION_ATTRIBUTE
J
tekenreeks
initialBalance
Of het aanvangssaldo zichtbaar is op het blad. Alleen geldig voor tijdkolommen.
N
Boole-waarde
waar
visibleTimeStratumCodes
Hiermee wordt de lijst met zichtbare tijdstratums op het blad gedefinieerd. Alleen geldig voor tijdkolommen.
N
tekenreeksarray
Alle tijdstratum
editableOnSheet
Of nieuwe waarden vanuit het blad aan de dimensiekolom kunnen worden toegevoegd. Alleen geldig voor dimensie- en tekstselectiekolommen.
N
Boole-waarde
false
newValueBehavior
Hiermee wordt bepaald of nieuwe waarden moeten worden in- of uitgeschakeld wanneer ze aan de onderliggende dimensie worden toegevoegd. Alleen geldig voor dimensiekolommen. Ondersteunde waarden: BESCHIKBAAR, NIET BESCHIKBAAR of OUDER
N
tekenreeks
BESCHIKBAAR
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
Type
Het rekeningtype.
J
Omschrijving
De rekeningomschrijving.
N
shortName
De korte naam van de rekening.
N
isCumulative
Retourneert of de rekening cumulatief is.
N
isPlanByDelta
Retourneert of de rekening plan-op-delta 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
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
linkedAccountMappings
Lijst met LinkedAccountMapping.
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
Hiermee wordt het selectievakje Uitgesloten van werkstroom in de toegankelijkheidsinstellingen van het blad bijgewerkt.
N
Boole-waarde
false
Voorbeeldantwoord:
204
Geslaagd antwoord is leeg met statuscode 204.

DELETE

Aanvraag-URI
/sheet/cube/definition
Verwijder de kubusbladdefinitie 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/cube/definition?name=Sales Cube
Kop voorbeeldaanvraag
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
<None>
Query Parameters
Naam
Omschrijving
Vereist
Naam
De naam van het kubusblad.
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 blanco met statuscode 204.