Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2023-06-23
Tempo

Tempo

URL Endpoint

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
Versione: v1
Categoria
Modifica dei metadati
Descrizione
Aggiornare la struttura temporale nella pianificazione
Autorizzazioni necessarie per il richiamo
Configurare il calendario
Parametri obbligatori su richiesta
N/D

Verbi HTTP supportati

Verbo HTTP
Descrizione
POST
In base al parametro dell'operazione, ricaricare/aggiornare/aggiungere la struttura temporale nella pianificazione. Se il parametro dell'operazione non è specificato, il valore predefinito è l'operazione di aggiunta.

POST

Richiesta
/updateTime: aggiorna la struttura temporale
Aggiorna la struttura temporale nella pianificazione in base all'operazione (ricarica/aggiornamento/aggiunta) specificata come parametro di query (aggiunge per impostazione predefinita se l'operazione non è specificata):
  • Ricarica: consente di ricaricare l'intera struttura temporale. Tutti i dati esistenti verranno cancellati. È anche consentito impostare lo strato predefinito tramite i ricaricamenti.
  • Aggiorna: aggiorna la struttura temporale esistente, ad esempio modificando le etichette per gli strati temporali esistenti, aggiungendo nuovi strati e così via. È anche consentito impostare lo strato predefinito tramite gli aggiornamenti.
  • Aggiungi: consente di aggiungere nuovi periodi di tempo alla struttura temporale. Non è possibile modificare i periodi di tempo, aggiungere un nuovo livello di granularità per i periodi di tempo o eliminare i periodi di tempo quando si accodano.
URI richiesta di esempio:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
Intestazione richiesta di esempio
Autorizzazione: di base o basata su token.
Content-Type: application/json
Corpo richiesta
Esempio di corpo richiesta 
{
   "calendars": [
       {
           "name": "DefaultHierarchy",
           "strata": [
               {
                   "code": "month",
                   "label": "Month",
                   "shortName": "Mon"
               },
               {
                   "code": "qtr",
                   "label": "Quarter",
                   "shortName": "Qtr"
               },
               {
                   "code": "year",
                   "label": "Year",
                   "shortName": "Yr"
               }
           ]
       },
       {
           "name": "AltHierarchy",
           "strata": [
               {
                   "code": "month"
               },
               {
                   "code": "altQtr",
                   "label": "AltQuarter",
                   "shortName": "AltQtr"
               },
               {
                   "code": "altYear",
                   "label": "AltYear",
                   "shortName": "AltYr"
               }
           ]
       }
   ],
   "periods": [
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "2022",
           "label": "FY2022",
           "shortName": "2022",
           "stratum": "year"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-04-01",
           "code": "Q1-2022",
           "label": "Q1-FY2022",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-02-01",
           "code": "01/2022",
           "label": "Jan-2022",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2022-02-01",
           "endDate": "2022-03-01",
           "code": "02/2022",
           "label": "Feb-2022",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2022-03-01",
           "endDate": "2022-04-01",
           "code": "03/2022",
           "label": "Mar-2022",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-07-01",
           "code": "Q2-2022",
           "label": "Q2-FY2022",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-05-01",
           "code": "04/2022",
           "label": "April-2022",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-06-01",
           "code": "05/2022",
           "label": "May-2022",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2022-06-01",
           "endDate": "2022-07-01",
           "code": "06/2022",
           "label": "June-2022",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-10-01",
           "code": "Q3-2022",
           "label": "Q3-FY2022",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-08-01",
           "code": "07/2022",
           "label": "July-2022",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2022-08-01",
           "endDate": "2022-09-01",
           "code": "08/2022",
           "label": "Aug-2022",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2022-10-01",
           "code": "09/2022",
           "label": "Sept-2022",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2023-01-01",
           "code": "Q4-2022",
           "label": "Q4-FY2022",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2022-11-01",
           "code": "10/2022",
           "label": "Oct-2022",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2022-11-01",
           "endDate": "2022-12-01",
           "code": "11/2022",
           "label": "Nov-2022",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2022-12-01",
           "endDate": "2023-01-01",
           "code": "12/2022",
           "label": "Dec-2022",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "2023",
           "label": "FY2023",
           "shortName": "2023",
           "stratum": "year"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-04-01",
           "code": "Q1-2023",
           "label": "Q1-FY2023",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-02-01",
           "code": "01/2023",
           "label": "Jan-2023",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2023-02-01",
           "endDate": "2023-03-01",
           "code": "02/2023",
           "label": "Feb-2023",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2023-03-01",
           "endDate": "2023-04-01",
           "code": "03/2023",
           "label": "Mar-2023",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-07-01",
           "code": "Q2-2023",
           "label": "Q2-FY2023",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-05-01",
           "code": "04/2023",
           "label": "April-2023",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-06-01",
           "code": "05/2023",
           "label": "May-2023",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2023-06-01",
           "endDate": "2023-07-01",
           "code": "06/2023",
           "label": "June-2023",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-10-01",
           "code": "Q3-2023",
           "label": "Q3-FY2023",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-08-01",
           "code": "07/2023",
           "label": "July-2023",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2023-08-01",
           "endDate": "2023-09-01",
           "code": "08/2023",
           "label": "Aug-2023",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2023-10-01",
           "code": "09/2023",
           "label": "Sept-2023",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2024-01-01",
           "code": "Q4-2023",
           "label": "Q4-FY2023",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2023-11-01",
           "code": "10/2023",
           "label": "Oct-2023",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2023-11-01",
           "endDate": "2023-12-01",
           "code": "11/2023",
           "label": "Nov-2023",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2023-12-01",
           "endDate": "2024-01-01",
           "code": "12/2023",
           "label": "Dec-2023",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "alt2022",
           "label": "Alt FY2022",
           "shortName": "Alt2022",
           "stratum": "altYear"    
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-05-01",
           "code": "altQ1-2022",
           "label": "Alt Q1-FY2022",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-07-01",
           "code": "altQ2-2022",
           "label": "Alt Q2-FY2022",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-09-01",
           "code": "altQ3-2022",
           "label": "Alt Q3-FY2022",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2023-01-01",
           "code": "altQ4-2022",
           "label": "Alt Q4-FY2022",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "alt2023",
           "label": "Alt FY2023",
           "shortName": "Alt2023",
           "stratum": "altYear"    
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-05-01",
           "code": "altQ1-2023",
           "label": "Alt Q1-FY2023",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-07-01",
           "code": "altQ2-2023",
           "label": "Alt Q2-FY2023",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-09-01",
           "code": "altQ3-2023",
           "label": "Alt Q3-FY2023",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2024-01-01",
           "code": "altQ4-2023",
           "label": "Alt Q4-FY2023",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       }
   ]
}
Parametri query
Nome
Descrizione
Obbligatorio
operazione
L'operazione di importazione della struttura temporale che si desidera eseguire. Deve essere ricaricato, aggiornato o aggiunto. Se non viene specificata alcuna operazione, verrà eseguita l'accodamento per impostazione predefinita.
N
procedereWithWarnings
Un parametro di query facoltativo utilizzato per ignorare i messaggi di avviso. Se non è impostato su true, i potenziali avvisi verranno restituiti prima dell'esecuzione della chiamata. Ignorali specificando questo parametro su true nell'URL.
N
skipAwaitCacheRefresh
Un parametro di query facoltativo. Se impostato su true, la risposta verrà restituita non appena è pronta, senza attendere l'aggiornamento della cache.
N
Parametri del carico utile
Oggetto struttura temporale
Nome
Descrizione
Obbligatorio
calendari
Elenco di tutti gli oggetti calendario da importare. Il calendario predefinito deve venire prima. Per l'aggiornamento e l'aggiunta, gli utenti devono includere tutti i calendari esistenti.
N
periodi
Elenco di tutti gli oggetti periodo di tempo nei calendari. I periodi di tempo devono essere elencati in ordine di profondità per ogni calendario. I periodi di tempo del calendario predefinito devono venire prima. Per i calendari alternativi, è facoltativo elencare nuovamente i periodi di tempo nello strato del fork o in un livello inferiore.
N
Oggetto calendario
Nome
Descrizione
Obbligatorio
nome
Nome del calendario.
S
strata
L'elenco degli oggetti strato nel calendario deve essere in ordine crescente, con il livello più basso come strato più granulare. Per i calendari alternativi, è facoltativo elencare nuovamente gli strati sotto lo strato del fork.
S
codice
Codice del calendario Supportato quando sono presenti codici calendario.
N
Oggetto strato
Nome
Descrizione
Obbligatorio
codice
Il codice dello strato temporale deve essere univoco.
S
etichetta
L'etichetta dello strato temporale deve essere univoca. Non obbligatorio per gli strati condivisi che vengono nuovamente elencati in un calendario alternativo.
S
shortName
Il nome abbreviato dello strato temporale deve essere univoco. Non obbligatorio per gli strati condivisi che vengono nuovamente elencati in calendari alternativi.
N
isDefaultStratum
Se lo strato temporale è lo strato predefinito. È consentito impostare lo strato predefinito solo nelle operazioni di ricaricamento o aggiornamento. Se isDefaultStratum non è specificato per nessuno strato, si presume che lo strato foglia sia lo strato predefinito per l'operazione di ricaricamento e che lo strato predefinito esistente rimanga invariato per l'operazione aggiornata.
N
Oggetto periodo
Nome
Descrizione
Obbligatorio
startDate
La data di inizio del periodo di tempo deve essere nel formato aaaa-MM-gg.
S
endDate
La data di fine del periodo di tempo deve essere nel formato aaaa-MM-gg.
S
codice
Il codice del periodo di tempo deve essere univoco.
S
etichetta
Etichetta del periodo di tempo
S
shortName
Nome abbreviato del periodo di tempo.
N
strato
Codice dello strato a cui appartiene questo periodo di tempo.
S
instanceCode
instanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.
N

Risposta

204 Nessun contenuto
La risposta corretta è vuota con codice di stato 204.
400 Richiesta non valida
Impossibile interpretare la richiesta dal server.
Esempio: 
{
   "message": "Include only one of these valid operation parameters in the request: reload, update, or append.",
   "status": 400
}
{
   "error": "Errors occurred while processing the request.",
   "errors": [
       {
           "error": "Stratum code is required. Specify a code.",
           "field": "calendars[0].strata[2].code",
           "code": "PLN310002"
       }
   ]
}
{
   "error": "Errors occurred while processing the request",
   "errors": [
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (Q4-2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       },
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       }
   ]
}
401 Non autorizzato
L'utente non è autorizzato.
Esempio: 
{
   "message": "Invalid credential",
   "status": 401
}
401 Forbidden
L'utente non dispone di autorizzazioni sufficienti.
Esempio: 
{
   "message": "This resource is only available when the JSON based time API feature and the alternate time roll-up feature are enabled.",
   "status": 403
}
500 Errore interno del server
Errore interno del server.