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

Tijd

URL-eindpunt

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
Versie: v1
Categorie
Metadata Modification
Omschrijving
Tijdstructuur in planning bijwerken
Vereiste machtigingen voor aanroepen
Kalender configureren
Vereiste parameters voor aanvraag
N.v.t.

Ondersteunde HTTP-werkwoorden

HTTP-werkwoord
Omschrijving
POST
Op basis van de bewerkingsparameter kunt u de tijdstructuur opnieuw laden/bijwerken/toevoegen in de planning. Als de bewerkingsparameter niet is opgegeven, wordt standaard de toevoegbewerking ingesteld.

POST

Aanvraag:
/updateTime: hiermee wordt de tijdstructuur bijgewerkt
Hiermee wordt de tijdstructuur in planning bijgewerkt op basis van de bewerking (opnieuw laden/bijwerken/toevoegen) die is opgegeven als queryparameter (standaard toevoegen als bewerking niet is opgegeven):
  • Opnieuw laden: laad de hele tijdstructuur opnieuw. Alle bestaande gegevens worden gewist. We staan ook het instellen van het standaardstratum toe via herlaadbeurten.
  • Bijwerken: werk de bestaande tijdstructuur bij, bijvoorbeeld labels wijzigen voor bestaande tijdstrata, nieuwe strata toevoegen, enzovoort. Het instellen van het standaardstratum via updates is ook toegestaan.
  • Toevoegen: voeg nieuwe perioden toe aan de tijdstructuur. U kunt geen perioden wijzigen, een nieuw granulariteitsniveau voor perioden toevoegen of perioden verwijderen wanneer u iets toevoegt.
Voorbeeldaanvraag-URI:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
Kop voorbeeldaanvraag
Autorisatie: basis- of tokengebaseerd.
Type inhoud: application/json
Hoofdtekst van aanvraag
Hoofdtekst voorbeeldaanvraag 
{
   "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"
       }
   ]
}
Query Parameters
Naam
Omschrijving
Vereist
bewerking
De importbewerking voor de tijdstructuur die we willen uitvoeren. Deze moet opnieuw worden geladen, bijgewerkt of toegevoegd. Als er geen bewerking is opgegeven, wordt standaard het toevoegen uitgevoerd.
N
doorgaanWithWarnings
Een optionele queryparameter die wordt gebruikt om waarschuwingsberichten te negeren. Als dit niet is ingesteld op waar, worden mogelijke waarschuwingen geretourneerd voordat de aanroep wordt uitgevoerd. Sluit ze af door deze parameter in de URL op te geven op true.
N
skipAwaitCacheRefresh
Een optionele queryparameter. Als dit is ingesteld op waar, wordt het antwoord geretourneerd zodra het gereed is, zonder te wachten tot de cache is vernieuwd.
N
Payload Parameters
Tijdstructuurobject
Naam
Omschrijving
Vereist
kalenders
Lijst met alle kalenderobjecten die moeten worden geïmporteerd. De standaardkalender moet eerst worden weergegeven. Voor bijwerken en toevoegen moeten gebruikers alle bestaande kalenders opnemen.
N
perioden
Lijst met alle periodeobjecten in de kalenders. De perioden moeten voor elke kalender worden weergegeven in de zoekvolgorde van de diepte. De perioden van de standaardkalender moeten eerst komen. Voor alternatieve kalenders is het optioneel om de perioden opnieuw weer te geven in het vertakkingsstratum of daaronder.
N
Calendar Object
Naam
Omschrijving
Vereist
Naam
Naam van de kalender.
J
strata
Lijst met stratumobjecten in de kalender moet in oplopende volgorde van niveau staan, waarbij het laagste niveau het meest gedetailleerde stratum is. Voor alternatieve kalenders is het optioneel om de strata opnieuw weer te geven onder het vertakkingsstratum.
J
code
Code van de kalender. Ondersteund wanneer kalendercodes aanwezig zijn.
N
Stratumobject
Naam
Omschrijving
Vereist
code
De code van het tijdstratum moet uniek zijn.
J
label
Het label van het tijdstratum moet uniek zijn. Niet vereist voor gedeelde strata die opnieuw worden weergegeven onder een alternatieve kalender.
J
shortName
De korte naam van het tijdstratum moet uniek zijn. Niet vereist voor gedeelde strata die opnieuw worden weergegeven onder alternatieve kalenders.
N
isDefaultStratum
Of het tijdstratum het standaardstratum is. Het instellen van het standaardstratum is alleen toegestaan bij bewerkingen voor opnieuw laden of bijwerken. Als isDefaultStratum voor geen enkel stratum is opgegeven, gaan we ervan uit dat het stratum op het laagste niveau het standaardstratum is voor het opnieuw laden en dat het bestaande standaardstratum ongewijzigd blijft voor de bijgewerkte bewerking.
N
Periodeobject
Naam
Omschrijving
Vereist
startDate
Begindatum van de periode moet de notatie jjjj-MM-dd hebben.
J
endDate
De einddatum van de periode moet de notatie jjjj-MM-dd hebben.
J
code
De code van de periode moet uniek zijn.
J
label
Label van de periode.
J
shortName
Korte naam van de periode.
N
stratum
De code van het stratum waartoe deze periode behoort.
J
instanceCode
De instanceCode waaruit waarden moeten worden opgehaald. Bijvoorbeeld GLOBO. Als er geen instanceCode is opgegeven, wordt de standaardinstance van de gebruiker gebruikt.
N

Antwoord

204 Geen inhoud
Geslaagd antwoord is leeg met statuscode 204.
Ongeldige aanvraag 400
De aanvraag kan niet worden begrepen door de server.
Voorbeeld: 
{
   "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 Niet geautoriseerd
Gebruiker is niet geautoriseerd.
Voorbeeld: 
{
   "message": "Invalid credential",
   "status": 401
}
401 Forbidden
Gebruiker heeft onvoldoende machtigingen.
Voorbeeld: 
{
   "message": "This resource is only available when the JSON based time API feature and the alternate time roll-up feature are enabled.",
   "status": 403
}
Interne serverfout 500
Interne serverfout.