Definizione di foglio modellato

URL Endpoint

VERBI HTTP supportati

PATCH

URI della richiesta

/sheet/modeled/definition

Aggiornare la definizione del foglio modellato corrispondente al parametro di query specificato. Se non esiste un foglio con l'identificatore corrispondente, verrà creato un nuovo foglio modellato con le proprietà specificate.

Richiesta di esempio per nome

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

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
procedereWithWarnings	Indica se l'upsert deve ignorare eventuali convalide di avviso, in genere restituite quando una proprietà del foglio modificata potrebbe eliminare dati dal 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 modellato viene utilizzato come payload JSON per entrambi gli endpoint.

Formato richiesta

{ "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 } }

Oggetto definizione foglio

Nome	Descrizione	Obbligatorio
proprietà	Oggetto contenente proprietà generali del foglio	N
colonne	Elenco di oggetti colonna del foglio modellato Le nuove colonne verranno create alla fine della definizione del foglio e l'ordine relativo delle nuove colonne verrà rispettato. Le colonne esistenti verranno aggiornate solo sul posto; non verranno riordinati.	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
codice	Codice foglio utilizzato per anteporre i codici conto e un ID univoco secondario. Obbligatorio quando si crea un nuovo foglio.	N	stringa
prefisso	Prefisso foglio utilizzato per il codice conto. Obbligatorio quando si crea un nuovo foglio. Obsoleto a favore del codice.	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
salaryDetail	Se il foglio contiene dettagli sullo stipendio.	N	booleano	falso
frozenColumnCount		N	intero	0
allowSplits	Se il foglio consente la suddivisione delle righe.	N	booleano	falso
allowRollupModelEdits	Se il foglio consente modifiche durante la visualizzazione dei livelli di rollup.	N	booleano	falso
allowActuals	Se il foglio è disponibile nelle versioni importi effettivi.	N	booleano	falso
recalculateOnDemand	Se il ricalcolo su richiesta è abilitato per il foglio.	N	booleano	falso
timeStratumCode	Il codice dello strato temporale associato ai dati nel foglio.	N	stringa	Strato temporale CoGe

Oggetto colonna foglio

Nome	Descrizione	Obbligatorio	Tipo	Predefinita
proprietà	Oggetto contenente le proprietà della colonna del foglio.	S	oggetto
disponibilità	Elenco di oggetti disponibilità foglio per la colonna corrente. Consultare Disponibilità foglio per i dettagli sul formato elenco.	N	elenco
defaultAvailability	La disponibilità predefinita da applicare a tutti i valori, se non diversamente specificato nella disponibilità. Valido per le colonne livello e dimensione. Per le colonne dimensione, se non è specificata disponibilità o defaultAvailability, defaultAvailability verrà impostato su true per le nuove colonne. Per impostazione predefinita, questo valore è vuoto, il che significa che la disponibilità esistente viene mantenuta, a meno che non venga modificata in modo specifico tramite la disponibilità.	N	booleano
defaultActionIfDataIsPresent	L'azione predefinita se i dati sono presenti quando si elimina un valore, se non diversamente specificato nella disponibilità. Valido per le colonne dimensione. Obbligatorio quando l'opzione Disponibilità predefinita è false per le colonne esistenti.	N	stringa
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	booleano

Oggetto proprietà colonne foglio

Nome	Descrizione	Obbligatorio	Tipo	Predefinita
nome	Nome colonna	N	stringa
codice	Il codice della colonna Obbligatorio per tutte le colonne ad eccezione delle colonne livello e valuta livello.	S	stringa
type	Il tipo di colonna. Valori possibili: LEVEL, DIMENSION, LEVEL_ATTRIBUTE, DIMENSION_ATTRIBUTE, TIMESPAN, NUMBER, DATE, TEXT, TEXT_SELECTOR, LEVEL_CURRENCY, DISPLAY, INITIAL_BALANCE, CHECKBOX	S	stringa
sola lettura	Indica se la colonna corrente è di sola lettura o meno. Per le colonne degli attributi dimensione, impostare readOnly su false per utilizzare l'attributo come filtro nella dimensione. Deve essere true (e il valore predefinito è true) per gli attributi di livello e le colonne di visualizzazione.	N	booleano	falso
allowSplits	Se la colonna corrente è frazionabile. Valido solo per i fogli quando la proprietà generale allowSplits è true.	N	booleano	falso
showTotalsAtBottom	Se visualizzare i totali nella parte inferiore del foglio per questa colonna.	N	booleano	falso
allowHidden	Se questa colonna può essere nascosta al visualizzatore del foglio in Opzioni di visualizzazione. Valido per tutte le colonne ad eccezione del selettore di testo e delle colonne di intervallo di tempo.	N	booleano	true
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
obbligatorio	Se ogni riga deve avere un valore in questa colonna. Valido solo per le colonne dimensione in cui allowHidden è false.	N	booleano	falso
recalculateOnMatch	Se ricalcolare i valori alla corrispondenza. Solo colonne dimensione e testo valide per i fogli in cui recalculateOnDemand è vero.	N	booleano	falso
lookupTables	Elenco di oggetti LookupTable per definire le distribuzioni e le ricerche di valori. Valido solo per le colonne dimensione e del selettore di testo.	N	LookupTable	null
valori	Elenco di stringhe da aggiungere come valori del selettore di testo. Valido solo per le colonne del selettore di testo.	N	matrice di stringhe	null
rowKey	Se questa colonna può essere utilizzata come chiave riga. Valido solo per le colonne del driver di testo.	N	booleano	falso
displayAs	Il formato Visualizza come per la colonna. Valido solo per le colonne dei driver numerici. Valori possibili: NUMBER, PERCENT, CURRENCY	N	Visualizza come	falso
decimalPrecision	Precisione decimale da visualizzare. Valido solo per le colonne dei driver numerici. Valori possibili: da 0 a 9 o -1 per utilizzare la precisione della valuta quando viene visualizzata come VALUTA.	N	intero	0
showToggle	Se visualizzare una colonna casella di controllo come interruttore. Valido solo per le colonne delle caselle di controllo.	N	booleano	falso
showInEditMode	Se visualizzare la colonna nelle righe modificabili del foglio modellato. Valido solo per le colonne valuta del livello.	N	booleano	falso
referenceTimePeriod	Indica il periodo di tempo di riferimento per una colonna di visualizzazione. Valido solo per le colonne di visualizzazione dei conti. Valori possibili: FIRST_NON_ACTUALS_PERIOD, START_OF_PLAN	N	stringa	FIRST_NON_ACTUALS_PERIOD
startOfRollupRange	Indica da dove iniziare un intervallo di rollup di un periodo di tempo per una colonna di visualizzazione. Valido solo per le colonne di visualizzazione dei conti. Valori possibili: CONTAINING_REFERENCE_PERIOD, BEFORE_REFERENCE_PERIOD, AFTER_REFERENCE_PERIOD	N	stringa	CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange	Numero di periodi di tempo da includere nell'intervallo di rollup per una colonna di visualizzazione. Valido solo per le colonne di visualizzazione dei conti.	N	intero	1
startOfRollupRangeTimeStratumCode	Codice del periodo di tempo per determinare l'inizio dell'intervallo di rollup per una colonna di visualizzazione. Valido solo per le colonne di visualizzazione dei conti. I valori possibili includono strati temporali uguali o superiori allo strato temporale del foglio.	N	stringa	Strato temporale del foglio
accountCode	Codice del conto per determinare il conto modellato per una colonna di visualizzazione. Valido solo per le colonne di visualizzazione. Solo i valori validi sono conti nel foglio modellato specificato	N	stringa

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

Per ulteriori dettagli, consultare Riferimenti: Proprietà in Account JSON Import Payload

Nome	Descrizione	Obbligatorio
nome	Il nome del conto	S
codice	Il codice conto	S
padre	Il conto padre	N
descrizione	La descrizione del conto	N
isCumulative	Indica se il conto è cumulativo.	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
weightedAverageTranslationsEnabled	Indica se il conto è abilitato alle conversioni con media ponderata.	N
weightedAverageTranslationResetStratum	Lo strato residuo WAT per questo conto.	N
weightedAverageTranslationTransferAccount	Il conto di trasferimento WAT per questo 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
hasSalaryDetail	Indica se il conto contiene o meno dettagli sullo stipendio.	N
isBreakbackEligible	Indica se la ripartizione retroattiva è idonea per questo conto.	N
isSystemAccount	Indica se il conto è un conto di sistema o meno.	N
isIntercompany	Restituisce se si tratta o meno di un conto interaziendale.	N
isPrestazioni	Restituisce se il conto è un'ipotesi o meno.	N
isMetric	Indica se il conto è un conto metrica o meno.	N
modeledSheetSpreadCode	Il codice dello spread del foglio modellato per lo spread modello associato.	N
spreadTargetAccount	L'oggetto conto di destinazione del conto di distribuzione.	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 Excluded From 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

/sheet/modeled/definition

Eliminare la definizione del foglio modellato 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/modeled/definition?name=Capital Model

Intestazione richiesta di esempio

Accept-Language: en

Esempio di corpo richiesta

<None>

Parametri query

Nome	Descrizione	Obbligatorio
nome	Il nome del foglio modellato.	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 è vuota con codice di stato 204.

POST

URI della richiesta

/sheet/modeled/definition/validate

Convalidare una richiesta di definizione di foglio modellato.

Richiesta di esempio per nome

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

Intestazione richiesta di esempio

Accept-Language: en

Esempio di corpo richiesta

<Documentato di seguito>

Parametri query

Consultare l'endpoint relativo in fase di convalida (ad es. PATCH).

Corpo richiesta

Esempio di corpo richiesta

Lo stesso formato di definizione del foglio modellato viene utilizzato come payload JSON per l'endpoint da convalidare. Tuttavia, l'oggetto

validationOptions

è obbligatorio nel payload quando si invia una richiesta di convalida.

Formato richiesta

{

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

...

Oggetto opzioni di convalida

Nome	Descrizione	Obbligatorio
httpMethod	Specifica quale endpoint API del foglio modellato viene convalidato. Attualmente supporta i seguenti endpoint: PATCH	S
dependDimensions	Elenco di nomi dimensione da presumere esistenti per la convalida. Le dimensioni non vengono mantenute come risultato della richiesta di convalida. Si presume che tutte le dimensioni personalizzate dipendenti siano piatte.	N
dependAttributes	Elenco di oggetti attributo dipendenti. Gli attributi non vengono mantenuti come risultato della richiesta di convalida.	N

Oggetto attributo dipendente

Nome	Descrizione	Obbligatorio
attributeName	Nome dell'attributo dipendente.	S
attributeType	Tipo dell'attributo dipendente. I tipi supportati sono: LEVEL_ATTRIBUTE DIMENSION_ATTRIBUTE	S
dimensionName	Nome della dimensione per l'attributo dipendente. Si applica ed è obbligatorio solo per gli attributi dimensione. Non consentito per gli attributi di livello.	N