Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2023-06-23
Definizione foglio cubo

Definizione foglio cubo

URL Endpoint

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/cube/definition
Versione: v1
Categoria
Inoltro dei dati
Descrizione
Modifica dei metadati
Autorizzazioni necessarie per il richiamo
Gestione dei modelli
Il modello include: fogli, conti, dimensioni e formule
Parametri obbligatori su richiesta
nome

VERBI HTTP supportati

Verbo HTTP
Risorsa singola
Descrizione
PATCH
Supportato
Inserire o aggiornare una definizione di foglio cubo
DELETE
Supportato
Eliminare una definizione di foglio cubo
OPZIONI
Supportato
Restituisce l'elenco dei verbi HTTP supportati per questa risorsa di raccolta.

PATCH

URI della richiesta
/sheet/cube/definition
Aggiornare la definizione del foglio cubo corrispondente al parametro di query specificato.
Se non esiste un foglio con il nome corrispondente, verrà creato un nuovo foglio cubo con le proprietà specificate.
Richiesta di esempio per nome
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
Intestazione richiesta di esempio
Accept-Language: en
Esempio di corpo richiesta
Consultare la sezione Corpo della richiesta
Parametri query
Nome
Descrizione
Obbligatorio
instanceCode
instanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.
N
nome
Il nome del foglio.
N
reorderColumns
Se si imposta questo parametro di query su true, l'ordine dell'elenco delle colonne verrà modificato in modo da riflettere l'ordine delle colonne specificato nel corpo della richiesta dell'API. Per impostazione predefinita, è impostato su false. Consultare Riferimenti: Riordinare le colonne per le API JSON modellate e con definizione foglio cubo.
N
Corpo richiesta
Esempio di corpo richiesta
Lo stesso formato di definizione del foglio cubo viene utilizzato come payload JSON per entrambi gli endpoint.
Formato richiesta
 
{
   "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
   }
}
Esempio di richiesta:
Esempio di richiesta di creazione foglio
 
{
   "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"
       }
   ]
}
Oggetto definizione foglio
Nome
Descrizione
Obbligatorio
proprietà
Oggetto contenente proprietà generali del foglio
N
colonne
Elenco di oggetti colonna del foglio cubo.
N
conti
Elenco di oggetti conto
N
accessibilità
Oggetto contenente la definizione dell'accessibilità ai fogli assegnati dall'utente.
N
Oggetto proprietà foglio
Nome
Descrizione
Obbligatorio
Tipo
Predefinita
descrizione
Descrizione foglio
N
stringa
Stringa vuota
prefisso
Prefisso foglio utilizzato per il codice conto.
N
stringa
userAssigned
Se il foglio è un foglio assegnato a un utente o (per impostazione predefinita) un foglio assegnato a un livello.
N
booleano
falso
timeStratumCode
Il codice dello strato temporale associato ai dati nel foglio.
N
stringa
Strato temporale CoGe
recalculateOnDemand
Se il ricalcolo su richiesta è abilitato per il foglio.
N
booleano
falso
riorganizzareGLAndCustomAccounts
Se gli utenti sono autorizzati a riorganizzare i conti inseriti nel cubo con altri conti cubo. Questa opzione può essere abilitata solo quando nella richiesta esistono o vengono creati conti standard cubo.
N
booleano
falso
hideRollupTotals
Se nascondere i totali di rollup per migliorare le performance del foglio.
N
booleano
falso
horizontalAxis
Oggetto di riferimento colonna che identifica la colonna sull'asse orizzontale.
N
oggetto colonna
Tempo
verticalAxis
Elenco di oggetti di riferimento colonna che identificano le colonne sull'asse verticale. Se specificato, l'asse verticale sovrascriverà le selezioni precedenti.
N
matrice di oggetti colonna
Account
maxColumnWidth
Larghezza massima in pixel per ogni colonna. Deve essere compreso tra 10 e 1000 o 0 se non viene specificata la larghezza.
N
intero
0
suppressZeroRows
Se vengono eliminate zero righe.
N
booleano
falso
Oggetto di riferimento colonna foglio
Nome
Descrizione
Obbligatorio
Nome
Nome colonna Obbligatorio per dimensioni e attributi personalizzati.
S
type
Tipo di colonna
S
Oggetto colonna foglio
Nome
Descrizione
Obbligatorio
proprietà
Oggetto contenente le proprietà della colonna del foglio.
S
disponibilità
Elenco di oggetti disponibilità foglio per la colonna corrente. Consultare Disponibilità foglio per i dettagli sul formato elenco.
N
defaultAvailability
La disponibilità predefinita da applicare a tutti i valori, se non diversamente specificato nella disponibilità. Valido per le colonne livello e dimensione.
N
eliminare
Richiedere di eliminare una colonna dal foglio specificato. Non valido per le colonne dipendenti da colonne esistenti che non sono contrassegnate per l'eliminazione (ad esempio gli attributi dimensione).
N
Oggetto proprietà colonne foglio
Nome
Descrizione
Obbligatorio
Tipo
Predefinita
nome
Nome colonna Per le colonne dimensione personalizzata e attributo, il nome corrisponderà al nome della rispettiva dimensione personalizzata o attributo.
S
stringa
type
Il tipo di colonna.
Valori possibili: LEVEL, ACCOUNT, TIME, DIMENSION, LEVEL_ATTRIBUTE, ACCOUNT_ATTRIBUTE, DIMENSION_ATTRIBUTE
S
stringa
initialBalance
Se il saldo di partenza sarà visibile nel foglio. Valido solo per le colonne temporali.
N
booleano
true
visibleTimeStratumCodes
Definisce l'elenco degli strati temporali visibili nel foglio. Valido solo per le colonne temporali.
N
matrice di stringhe
Tutti gli strati temporali
editableOnSheet
Se è possibile aggiungere nuovi valori alla colonna dimensione dal foglio. Valido solo per le colonne dimensione e del selettore di testo.
N
booleano
falso
newValueBehavior
Definisce se abilitare o disabilitare nuovi valori quando vengono aggiunti alla dimensione sottostante. Valido solo per le colonne dimensione. Valori supportati: AVAILABLE, UNAVAILABLE o PARENT
N
stringa
DISPONIBILE
Oggetto tabella di ricerca colonna foglio
Nome
Descrizione
Obbligatorio
Tipo
Predefinita
nome
Nome della tabella di ricerca
S
stringa
displayAs
Il formato Visualizza come per questa tabella di ricerca. Valori possibili: NUMBER e PERCENT. Valido solo per le tabelle di ricerca valori.
N
stringa
NUMBER
decimalPrecision
Precisione decimale per i valori in questa tabella di ricerca. Valori possibili: da 0 a 9.
N
intero
0
type
Il tipo di tabella di ricerca. Valori possibili: VALUE, SPREAD.
S
stringa
Oggetto conto foglio
Nome
Descrizione
Obbligatorio
nome
Il nome del conto
S
codice
Il codice conto
S
padre
Il conto padre
N
Tipo
Il tipo di conto
S
descrizione
La descrizione del conto
N
shortName
Il nome abbreviato del conto
N
isCumulative
Indica se il conto è cumulativo.
N
isPlanByDelta
Indica se il conto è pianificato per delta.
N
isActualsByDelta
Restituisce se l'importo corrisponde agli importi effettivi in base al delta.
N
isLink
Indica se il conto è collegato o meno.
N
timeRollupType
Il tipo di rollup da eseguire per i rollup temporali.
N
timeWeightAccount
Il conto di ponderazione utilizzato per i rollup temporali.
N
levelDimRollupType
Il tipo di rollup da eseguire per i rollup di livello/dimensione personalizzata.
N
levelDimWeightAccount
Il conto di ponderazione utilizzato per i rollup di dimensioni personalizzate/livelli.
N
levelDimRollupText
Il valore del testo di rollup utilizzato nei rollup di livello/dimensione personalizzata.
N
actualsOverlay
L'impostazione di sovrapposizione degli importi effettivi per il conto.
N
attributeValues
Elenco di oggetti valore attributo conto per questo conto.
N
displayAs
Visualizza come impostazione per il conto.
N
formula
La formula del conto
N
decimalPrecision
La precisione decimale predefinita per il conto.
N
exchangeRateType
Il tipo di tasso di cambio per questo conto.
N
suppressZeros
Indica se le righe zero devono essere eliminate per il conto nei fogli.
N
startExpanded
Indica se il conto inizia espanso nel foglio.
N
dataEntryType
L'impostazione del tipo di immissione dati per questo conto.
N
dataPrivacy
L'impostazione di privacy dei dati per questo account.
N
linkedAccountMappings
Elenco di LinkedAccountMapping
N
Oggetto di accessibilità del foglio
Nome
Descrizione
Obbligatorio
Tipo
Predefinita
nomi utente
Elenco di nomi utente da aggiungere al foglio.
Deve presentarsi sotto forma di indirizzi e-mail validi.
N
matrice di stringhe
excludedFromWorkflow
Aggiorna la casella di controllo "Escluso da workflow" nelle impostazioni di accessibilità del foglio.
N
booleano
falso
Risposta di esempio
204
La risposta riuscita è vuota con codice di stato 204.

DELETE

URI della richiesta
/foglio/cubo/definizione
Eliminare la definizione del foglio cubo corrispondente al parametro di query specificato. Se non esiste un foglio con l'identificatore corrispondente, si verificherà l'errore Not Found.
Richiesta di esempio per nome
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
Intestazione richiesta di esempio
Accept-Language: en
Esempio di corpo richiesta
<None>
Parametri query
Nome
Descrizione
Obbligatorio
nome
Il nome del foglio cubo.
N
instanceCode
instanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.
N
Risposta di esempio
204
La risposta corretta è blane con codice di stato 204.