Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Zeit

Zeit

URL-Endpunkt

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
Version: v1
Kategorie
Metadatenänderung
Beschreibung
Aktualisieren Sie die Zeitstruktur in Planning
Zum Aufrufen sind Berechtigungen erforderlich
Kalender konfigurieren
Auf Anforderung erforderliche Parameter
N/V

Unterstützte HTTP-Verben

HTTP-Verb
Beschreibung
POST
Basierend auf dem Vorgangsparameter können Sie die Zeitstruktur in Planning neu laden/aktualisieren/anhängen. Wenn der Vorgangsparameter nicht angegeben wird, wird standardmäßig der Vorgang "Anhängen" verwendet.

POST

Anfordern
/updateTime: Aktualisiert die Zeitstruktur
Aktualisiert die Zeitstruktur in Planning basierend auf dem Vorgang (neu laden/aktualisieren/anhängen), der als Abfrageparameter angegeben ist (standardmäßig anhängen, wenn kein Vorgang angegeben ist):
  • Neu laden: Lädt die gesamte Zeitstruktur neu. Alle vorhandenen Daten werden gelöscht. Wir lassen auch die Festlegung der Standardschicht durch Neuladen zu.
  • Aktualisieren: Aktualisieren Sie die vorhandene Zeitstruktur, z. B. ändern Sie Labels für vorhandene Zeitschichten, fügen Sie neue Schichten hinzu usw. Wir lassen auch die Festlegung der Standardschicht durch Aktualisierungen zu.
  • Anhängen: Fügen Sie neue Zeitperioden zur Zeitstruktur hinzu. Beim Anhängen können Sie keine Zeitperioden ändern, eine neue Granularitätsebene für Zeitperioden hinzufügen oder Zeitperioden löschen.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
Beispielanforderungs-Header
Autorisierung: Basic oder Token-basiert.
Inhaltsart: application/json
Anforderungstext
Beispielanforderungstext 
{
   "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"
       }
   ]
}
Abfrageparameter
Name
Beschreibung
Erforderlich
Vorgang
Der Importvorgang für die Zeitstruktur, den wir ausführen möchten. Er muss entweder neu geladen, aktualisiert oder angehängt werden. Wenn kein Vorgang angegeben ist, wird standardmäßig das Anhängen durchgeführt.
N
proceedWithWarnings
Ein optionaler Abfrageparameter, mit dem Warnmeldungen geschlossen werden. Ist diese Option nicht auf „true“ gesetzt, werden potenzielle Warnungen zurückgegeben, bevor der Aufruf ausgeführt wird. Verwerfen Sie sie, indem Sie diesen Parameter in der URL auf „true“ setzen.
N
skipAwaitCacheRefresh
Ein optionaler Abfrageparameter. Bei „true“ wird die Antwort zurückgegeben, sobald sie bereit ist, ohne auf die Aktualisierung des Caches zu warten.
N
Nutzlastparameter
Zeitstrukturobjekt
Name
Beschreibung
Erforderlich
-Kalender
Liste aller zu importierenden Kalenderobjekte. Der Standardkalender muss an erster Stelle stehen. Zum Aktualisieren und Anhängen müssen Benutzer alle vorhandenen Kalender einschließen.
N
Perioden
Liste aller Zeitperiodenobjekte in den Kalendern. Die Zeitperioden müssen für jeden Kalender in der Suchreihenfolge „Suche zuerst“ aufgelistet werden. Die Zeitperioden des Standardkalenders müssen an erster Stelle stehen. Für alternative Kalender ist es optional, die Zeitperioden in der Fork-Schicht oder darunter neu aufzulisten.
N
Kalenderobjekt
Name
Beschreibung
Erforderlich
Name
Name des Kalenders.
J
Schichten
Die Liste der Schichtobjekte im Kalender sollte in aufsteigender Reihenfolge erfolgen, wobei die niedrigste Ebene die detaillierteste Schicht ist. Bei alternativen Kalendern ist es optional, die Schichten unterhalb der Fork-Schicht erneut aufzulisten.
J
-Code
Code des Kalenders. Wird unterstützt, wenn Kalendercodes vorhanden sind.
N
Zeitschichtobjekt
Name
Beschreibung
Erforderlich
-Code
Der Code der Zeitschicht muss eindeutig sein.
J
Label
Das Label der Zeitschicht muss eindeutig sein. Nicht erforderlich für geteilte Schichten, die unter einem alternativen Kalender erneut aufgelistet werden.
J
shortName
Kurzname der Zeitschicht, muss eindeutig sein. Nicht erforderlich für geteilte Schichten, die unter einem alternativen Kalender erneut aufgelistet werden.
N
isDefaultStratum
Ob die Zeitschicht die Standardschicht ist. Das Festlegen der Standard-Zeitschicht ist nur beim erneuten Laden oder Aktualisieren zulässig. Wenn isDefaultStratum für keine Schichten angegeben ist, wird davon ausgegangen, dass die Leaf-Schicht die Standardschicht für den Vorgang zum erneuten Laden ist und die vorhandene Standardschicht für den aktualisierten Vorgang unverändert bleibt.
N
Periodenobjekt
Name
Beschreibung
Erforderlich
startDate
Das Startdatum der Zeitperiode muss das Format yyyy-MM-dd aufweisen.
J
Enddatum
Das Enddatum der Zeitperiode muss das Format yyyy-MM-dd aufweisen.
J
-Code
Der Code der Zeitperiode muss eindeutig sein.
J
Label
Label der Zeitperiode.
J
shortName
Kurzname der Zeitperiode.
N
stratum
Der Code der Zeitschicht, zu der diese Zeitperiode gehört.
J
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N

Antwort

204 Kein Inhalt
Erfolgreiche Antwort ist leer mit Statuscode 204.
400 Unzulässige Anforderung
Die Anforderung konnte vom Server nicht gelesen werden.
Beispiel: 
{
   "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: Nicht autorisiert
Benutzer ist nicht autorisiert.
Beispiel: 
{
   "message": "Invalid credential",
   "status": 401
}
401 Nicht zulässig
Benutzer hat unzureichende Berechtigungen.
Beispiel: 
{
   "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 Interner Serverfehler
Interner Serverfehler.