メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2023-06-23
Time

Time

URL エンドポイント

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
バージョン: v1
カテゴリ
メタデータの変更
説明
Planning の時間構造を更新する
呼び出すために必要な権限
カレンダーの設定
リクエストに必要なパラメータ
該当なし

サポートされている HTTP 動詞

HTTP 動詞
説明
POST
操作パラメータに基づいて、Planning の時間構造を再ロード/更新/追加します。操作パラメータが指定されていない場合、デフォルトは追加操作になります。

POST

リクエスト
/updateTime: 時間構造を更新します。
クエリー パラメータとして指定された操作 (再ロード/更新/追加) に基づいて、Planning の時間構造を更新します (操作が指定されていない場合は、デフォルトで追加)。
  • 再ロード: 時間構造全体を再ロードします。既存のデータはすべてクリアされます。再ロードを通じてデフォルト層を設定することもできます。
  • 更新: 既存の時間層のラベルの変更、新しい層の追加など、既存の時間構造を更新します。更新を通じてデフォルトの層を設定することもできます。
  • 追加: 時間構造に新しい期間を追加します。追加する場合、期間の変更、期間の新しい粒度レベルの追加、期間の削除は行えません。
リクエスト URI の例:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
リクエスト ヘッダーの例
認証: 基本ベースまたはトークンベース
コンテンツ タイプ: application/json
リクエスト本文
リクエスト本文の例 
{
   "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"
       }
   ]
}
クエリー パラメータ
名前
説明
必須
操作
実行する時間構造のインポート操作。再ロード、更新、または追加のいずれかである必要があります。操作が指定されていない場合は、デフォルトで追加が実行されます。
なし
proceedWithWarnings
警告メッセージを却下するために使用される任意のクエリー パラメータ。true に設定しない場合、呼び出しが実行される前に潜在能力に関する警告が返されます。URL でこのパラメータを true に指定することにより、それらを却下します。
なし
skipAwaitCacheRefresh
任意のクエリー パラメータ。true に設定した場合、キャッシュのリフレッシュを待つことなく、準備が整ったらすぐにレスポンスを返します。
なし
ペイロード パラメータ
時間構造オブジェクト
名前
説明
必須
カレンダー
インポートするすべてのカレンダー オブジェクトのリスト。デフォルトのカレンダーが最初に配置される必要があります。更新と追加には、既存のすべてのカレンダーを含める必要があります。
なし
期間
カレンダー内のすべての期間オブジェクトのリストです。期間は、カレンダーごとに深さ優先探索の順序でリストする必要があります。デフォルト カレンダーの期間が最初になる必要があります。代替カレンダーの場合、分岐層またはそれ以下の層で期間をリストに並べ直すのは任意です。
なし
カレンダー オブジェクト
名前
説明
必須
名前
カレンダーの名前。
あり
層
カレンダー内の層オブジェクトのリストは、昇順で並べられている必要があります。最下位レベルは最も詳細な層になります。代替カレンダーの場合、分岐層の下に層を再リスト化することは任意です。
あり
code
カレンダーのコード。カレンダー コードが存在する場合にサポートされます。
なし
層オブジェクト
名前
説明
必須
code
時間層のコードは一意である必要があります。
あり
ラベル
時間層のラベルは一意である必要があります。代替カレンダーで再リストされた共有層の場合は不要です。
あり
shortName
時間層の短縮名は一意である必要があります。代替カレンダーで再リストされた共有層の場合は不要です。
なし
isDefaultStratum
時間層がデフォルト層であるかどうか。再ロードまたは更新操作では、デフォルト層の設定のみが許可されます。いずれの層にも isDefaultStratum が指定されていない場合は、最下位層が再ロード操作のデフォルトの層であり、既存のデフォルトの層が更新された操作で変更されていないことを前提とします。
なし
期間オブジェクト
名前
説明
必須
startDate
期間の開始日は、yyyy-MM-dd の形式である必要があります。
あり
endDate
期間の終了日は、yyyy-MM-dd の形式である必要があります。
あり
code
期間のコードは一意である必要があります。
あり
ラベル
期間のラベル。
あり
shortName
期間の短い名前。
なし
層
この期間が属する層のコード。
あり
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし

回答

204 コンテンツなし
正常な応答は空白で、ステータス コードは 204 です。
400 不良のリクエスト
リクエストをサーバーで理解できませんでした。
例: 
{
   "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 認証されていません
ユーザーが許可されていません。
例: 
{
   "message": "Invalid credential",
   "status": 401
}
401 禁止
ユーザーに必要な権限が不足しています。
例: 
{
   "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 内部サーバー エラー
内部サーバー エラーです。