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

Versions

URL エンドポイント

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
(POST のみ)
バージョン: v1
カテゴリ
メタデータの送信、変更、取得
説明
メタデータの変更
呼び出すために必要な権限
モデル管理
モデル
リクエストに必要なパラメータ
エンドポイントによって以下のように異なります。
PATCH、POST、DDelete: バージョン名
GET になし

サポートされている HTTP VERB

(注: バージョン フォルダは、以下のいずれのエンドポイントでもサポートされていません)
HTTP 動詞
単一リソース
回収リソース
説明
GET
サポートされていません
サポート済
テナントのすべてのバージョンを取得します。
DELETE
サポート済
サポートされていません
既存の削除可能バージョンを削除します。
PATCH
サポート済
サポートされていません
実績バージョンを作成/更新するか、計画バージョンを更新します。
POST
サポート済
サポートされていません
新しい計画バージョンを作成します。

GET

リクエスト URI
/api/REST/modeling/v1/{tenant}/versions:
テナントのすべてのバージョンを取得します
リスト内のテナントのすべてのバージョンを取得します。
特定のバージョンの UI に表示されないプロパティは、応答内の対応するバージョン オブジェクトに含まれません。たとえば、サブ実績バージョンの startOfVersion です。
"limit" パラメータと "offset" パラメータを使用してページングを使用することができます。
以下のバージョン プロパティは現在 GET でサポートされていない/表示されません。
ベース バージョン (仮想バージョンの場合)、固定通貨レポートを有効化 (仮想バージョンの場合)、
数式値、管理アクセス、ユーザー アクセス、編集可能なシート アクセス、実績の特権アクセス、グループ、グループ アクセス レベルを計算します。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1
リクエスト本文の例:
<空白のまま>
クエリー パラメータ:
名前
説明
必須
limit
単一の回答に含まれるオブジェクトの最大数
なし
オフテスト
回答コレクション内の最初のオブジェクトの 0 から始まるインデックス。デフォルトは 0 です。
limit パラメータで offset を使用して、回答一覧のページングを制御します。
なし
パス パラメータ:
名前
説明
必須
テナント
操作するテナント (GREENCO など)
あり
回答例
200 OK
注: 実績バージョンの "バージョンの開始" と計画バージョンの "表示開始月" は、両方とも startOfVersion プロパティ (ポインタ A) の下に表示されます。
同様に、実績バージョンの "バージョンの終了" と計画バージョンの "計画の終了" は、両方とも endOfVersion プロパティ (ポインタ D) の下に表示されます。
実績バージョンの "スクロールの開始場所" と計画バージョンの "計画の開始" は、両方とも StartingScrollLocation プロパティの下に表示されます (マウス C)。
正常に完了しました。
回答例
 
{
    "data": [
        {
            "name": "Test-Actuals-Version",
            "shortName": "Test-Actuals-Version-Shortname",
            "versionType": "ACTUALS",
            ...
            "lockLeadingCompletion": true
        },
        {
            "name": "JE Sub under Actuals",
            "shortName": "JE01",
            "parent": "Actuals",
            ...
            "journalEntryVersion": true,
            "journalEntryVersionProperties": {
                "journalEntryNumbering": "N",
                "startingNumber": 0
            },
            ...
        },
        ...
    ],
    "limit": 12,
    "offset": 4,
    "total": 12
}

DELETE

リクエスト
/api/REST/modeling/v1/{tenant}/versions:
既存のバージョンを削除
指定したバージョン名のバージョンを削除します。
ルート実績バージョンとデフォルト バージョンは削除できません。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}
リクエスト本文の例:
<空白のまま>
クエリー パラメータ
名前
説明
必須
versionName
削除する既存のバージョンの名前を指定します。
あり
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
パス パラメータ
名前
説明
必須
テナント
操作するテナント (GREENCO など)
あり
回答例
204 NO_CONTENT
成功した応答は空白で、ステータス コードは 204 です。

PATCH

リクエスト:
/api/REST/modeling/v1/{tenant}/versions:
実績バージョンの作成/更新、または計画バージョンの更新
指定したバージョン識別子が存在する場合は、既存の実績/計画バージョンを更新します。そうしない場合、その識別子を使用して新しい実績バージョンを作成します。
現在、クエリー パラメータでサポートされているバージョン識別子のセットは次の 2 つです。
- バージョン名
呼び出しごとに URL で指定する必要があるのは、上記のクエリー パラメータのうち 1 つのみです。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}
リクエスト本文
- 既存のバージョンに対して更新されるバージョン プロパティ、または作成される新しいバージョンに対して指定されるバージョン プロパティを含む JSON。
更新:
- 更新の場合、リクエスト本文に特定のプロパティは必要ありません (versionType を除く)。ただしリクエスト本文は必要です。
POST
 のリクエスト本文のセクションでは、さまざまなタイプの計画バージョンにおけるプロパティのリストを示します。
- インジケータのプロパティ (仕訳入力バージョンなど) は更新できません。ただし、変更されていない適切な値がある限り、リクエスト本文に含めることができます。
- 親の更新は現在サポートされていません。
- 最下位バージョン以外 (子を持つバージョン) を更新する場合、これらのバージョンのユーザー グループは、"FULL_ACCESS" または "HID済" のアクセス タイプのみを持つことができます。"FULL_ACCESS" は、UI 上で "VISIBLE" と等価に表示されます。
- グループ アクセスの詳細 (グループ ID とグループ アクセス レベル) は、更新コールのリクエスト本文で groupId=0 を指定することで削除できます。
以下を作成します。
- 作成の場合、次のプロパティをリクエスト本文の "指定" に指定できます。
プロパティ
説明
必須 (実績の場合)
必須 (仕訳入力の場合)
リクエスト本文のプロパティ名
値のタイプ
デフォルト値
短縮名
バージョンの短縮名
なし
なし
shortName
String
空の文字列
親
このバージョンの親です。
なし
なし
親
文字列 (バージョン名)
ルート実績バージョン
バージョン タイプ
バージョンのタイプ (実績または計画)
Y、実績
Y、実績
versionType
String
説明
説明
なし
なし
説明
String
空の文字列
管理者アクセス
バージョンの管理者のアクセス レベル
なし
なし
administratorsAccess
VersionAccessControl
親から継承
ユーザー アクセス
バージョンのアクセス レベル (ユーザーの場合)
なし
なし
userAccess
VersionAccessControl
親から継承
実績の特権アクセス
バージョンのアクセス レベル ("実績の特権アクセス" 権限を持つ人)
なし
なし
privilegedActualsAccess
VersionAccessControl
親から継承
グループ ID
特定のユーザー グループ ID
なし
なし
groupId
整数
親から継承
グループ アクセス レベル
指定したユーザー グループのバージョンのアクセス レベル
グループ ID が指定されている場合は "Y"。
グループ ID が指定されている場合は "Y"。
groupAccessLevel
VersionAccessControl
親から継承
変更履歴
変更履歴情報の保持/削除。
なし
なし
auditTrail
ブール値
false (仕訳入力バージョンの親から継承)
仕訳入力バージョン
作成するバージョンが仕訳入力であるかどうか。
なし
Y、真
journalEntryVersion
ブール値
returnId
true に設定されている場合は、バージョン ID を返します。操作によって新しいバージョンが作成された場合の新しいバージョン ID。それ以外の場合は、更新された既存のバージョンの ID を返します。
なし
なし
returnId
ブール値
false (false の場合は 204 No Content を返します。true の場合はバージョンとともに 200 OK を返します)
- VersionAccessControl 値タイプは、次の文字列値を取ることができます: "HIDDEN"、"LOCKED"、"LOCKED_EXCEPT_NOTES"、"IMPORT_AND_NOTES"、"FULL_ACCESS"
- グループ ID は、exportGroups 公開 API を介して取得できます。
- 仕訳入力バージョンは、連結が無効になっている会社ではサポートされていません。
仕訳入力バージョンのプロパティ:
次のプロパティは、journalEntryVersionProperties のネストされたオブジェクト (サンプル リクエスト本文を参照) の下に存在し、JE バージョンに対してのみ使用されます。
プロパティ
説明
必須 (実績の場合)
必須 (仕訳入力の場合)
リクエスト本文のプロパティ名
値のタイプ
デフォルト値
仕訳入力の番号付け
仕訳入力に番号を付ける方法を指定します。自動 (A)、手動 (M)、またはなし (N) のいずれかになります。
未使用
なし
journalEntryNumbering
String
non(N)
プレフィックス
JE 番号付けのプレフィックス
未使用
仕訳入力の番号付けが自動 (A) または手動 (M) の場合は "Y"
prefix
String
開始番号
JE 番号付けの開始番号
未使用
仕訳入力の番号付け (A) の場合は Y
StartingNumber
整数
ルート実績固有のプロパティ:
次のプロパティは、ルート実績を更新する場合にのみ使用されます。
プロパティ
説明
必須
リクエスト本文のプロパティ名
値のタイプ
バージョンの開始
バージョンの開始
なし
startOfVersion
文字列 (期間コード)
バージョンの終了
バージョンの終了
なし
endOfVersion
文字列 (期間コード)
スクロールの開始場所
バージョンのスクロールの開始場所
なし
startingScrollLocation
文字列 (期間コード)
次の時点までの確定数字を表示
計画バージョンに対する実績のオーバーレイが停止するとき
なし
completedValuesThrough
文字列 (期間コード)
ワークフローを有効化
ワークフローで組織別に実績を送信できます。
なし
endableWorkflow
ブール値
リクエスト本文の例:
リクエスト本文
 
{
        "parent": "Parent Version",
        "versionType": "ACTUALS",
        ...
        "administratorsAccess": "FULL_ACCESS",
        "usersAccess": "IMPORT_AND_NOTES",
        ...
        ...
        "auditTrail": true
}
ネストされたプロパティがあるバージョンのリクエスト本文の例 (仕訳入力バージョンと仮想バージョン):
リクエスト本文
 
{
        "parent": "Actuals",
        "versionType": "ACTUALS",
        "shortName": "test JE version",
        "journalEntryVersion": "true",
        "journalEntryVersionProperties": {
                "journalEntryNumbering": "A",
                "prefix": "JE-Prefix",
                "startingNumber": "25"
        },
        ...
        "auditTrail": true
}
クエリー パラメータ:
名前
説明
必須
versionName
作成する新しいバージョン、または更新する既存バージョンの名前。
あり
proceedWithWarnings
警告メッセージを却下するために使用される任意のクエリー パラメータ。true に設定しない場合、呼び出しが実行される前に潜在能力に関する警告が返されます。URL でこのパラメータを true に指定することにより、それらを却下します。
なし
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
パス パラメータ:
名前
説明
必須
テナント
操作するテナント (GREENCO など)
あり
パブリッシュ アクセス プロパティ:
次のリクエスト本文のプロパティは、WD が有効な場合にのみ使用されます。
回答例
204 NO_CONTENT
成功した応答は空白で、ステータス コードは 204 です。

POST

リクエスト:
/api/REST/modeling/v1/{tenant}/cloneVersion:
新しい計画バージョンの作成
ソース/デフォルト バージョンのクローン化によって新しい計画バージョンまたは予測バージョンを作成するか、仮想バージョンを作成します。
現在、クエリー パラメータでサポートされているバージョン識別子のセットは次の 2 つです。
- 新しいバージョン名
呼び出しごとに URL で指定する必要があるのは、上記のうち 1 つのみです
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012&
sourceVersionName=Budget 2011&
copyAllData=true&
copySharedFormulasAndRules=true&
copyAllOverrideFormulas=false
リクエスト本文:
作成する新しいバージョンに対して指定されるバージョン プロパティを含む JSON。
名前
説明
必須 (プランに対して)
必須 (予測の場合)
必須 (仮想の場合)
リクエスト本文のプロパティ名
値のタイプ
デフォルト値
短縮名
バージョンの短縮名
なし
なし
なし
shortName
String
空の文字列
親
このバージョンの親フォルダ。
なし
なし
なし
親
文字列 (フォルダ名)
バージョン タイプ
バージョンのタイプ (実績または計画)
Y, PLANNING
Y, PLANNING
Y, PLANNING
versionType
String
説明
説明
なし
なし
なし
説明
String
空の文字列
ロック済バージョン
マスター数式や他の科目数式を含む、すべてのユーザーのバージョン全体をロックします。
なし
未使用
未使用
lockedVersion
ブール値
ソース バージョンから継承
数式値を計算
"ロック済バージョン" がオンになっている計画バージョンで使用できます。ほとんどの科目で数式と参照の計算結果を保持し、ロック済バージョンのパフォーマンスを向上させるために使用します。
なし
未使用
未使用
calculateFormulaValues
ブール値
false
管理者アクセス
バージョンの管理者のアクセス レベル
なし
なし
なし
administratorsAccess
VersionAccessControl
ソース バージョン (計画) から継承。 IMPORT_AND_NOTES (予測)ロック済 (仮想)
ユーザー アクセス
バージョン: ユーザーのアクセス レベル
なし
なし
なし
usersAccess
VersionAccessControl
ソース バージョン (計画) から継承。 IMPORT_AND_NOTES (予測)ロック済 (仮想)
編集可能なシート アクセス
バージョンのアクセス レベル ("編集可能なシート アクセス" 権限を持つ人)
なし
なし
なし
editableSheetAccess
VersionAccessControl
ソース バージョンから継承 (計画、予測)
グループ ID
指定したユーザー グループの ID
なし
なし
なし
groupId
整数
ソース バージョンから継承 (計画、予測)
アクセス レベル
指定したユーザー グループのバージョンのアクセス レベル
なし
なし
なし
groupAccessLevel
VersionAccessControl
ソース バージョンから継承 (計画、予測)
表示開始月
バージョンの表示開始月
なし
なし
未使用
startOfVersion
文字列 (期間コード)
ソース バージョンから継承
計画の終了
計画の終了
なし
なし
未使用
endOfPlan
文字列 (期間コード)
ソース バージョンから継承
計画の開始
計画の開始
なし
なし
未使用
startOfPlan
文字列 (期間コード)
ソース バージョンから継承
先行期間をロック
バージョンにおいて、データの指定期間を編集不可にします。UI では "次の時点までのすべての{最下位層をロック" として表示されます。
なし
未使用
未使用
lockLeadingTimePeriod
文字列 (期間コード)
ソース バージョンから継承
先行の完了をロック
上記のプロパティの "完了{最下位層}" オプション。このプロパティと "次の期間をロック" の両方をリクエスト本文で指定することはできません。
なし
未使用
未使用
lockLeadingCompletion
ブール値
ソース バージョンから継承
デフォルト
バージョンを、すべてのユーザーに対してデフォルト バージョンとします。
なし
未使用
未使用
デフォルト
ブール値
false
変更履歴
変更履歴情報の保持/削除。
なし
なし
未使用
auditTrail
ブール値
ソース バージョンから継承
実績のオーバーレイに、利用できない組織を含める
すでに使用されなくなったものも含め、すべての組織を実績オーバーレイに表示します。
なし
なし
未使用
actualsOverlayIncludesUnavailableLevels
ブール値
false
オーバーレイの実績バージョン
計画データを、指定した実績バージョンのデータでオーバーレイします。
なし
なし
未使用
actualsVersionOverlay
文字列 (バージョン名)
ルート実績バージョン
トランザクション ID にドリルイン
バージョンのトランザクションにドリルインできるようにします。
なし
なし
未使用
drillIntoTransactionId
整数
デフォルト レポート
予測バージョン
作成するバージョンが予測バージョンかどうか。
未使用
Y、真
未使用
predictiveVersion
ブール値
仮想バージョン
作成するバージョンが仮想バージョンかどうか。
未使用
未使用
Y、真
virtualVersion
ブール値
returnId
true に設定されている場合はバージョン ID を返します。操作によって新しいバージョンが作成された場合の新しいバージョン ID。それ以外の場合は、更新された既存のバージョンの ID を返します。
なし
なし
なし
returnId
ブール値
false (false の場合は 204 No Content を返します。true の場合は、応答にバージョンが含まれ 200 OK を返します)
- VersionAccessControl 値タイプは、次の文字列値を取ることができます: "HIDDEN"、"LOCKED"、"LOCKED_EXCEPT_NOTES"、"IMPORT_AND_NOTES"、"FULL_ACCESS"
- ロック済計画バージョンには、ユーザー グループに対して "IMPORT_AND_NOTES" または "FULL_ACCESS" を設定することはできません。
- 予測バージョンでは、ユーザー グループに対して "FULL_ACCESS" を設定できません。
- 仮想バージョンには、どのユーザー グループに対しても "非表示" または "ロック済" のみを設定できます。
- プランニングがなくても連結が有効化されている会社では、計画バージョンと予測バージョンを作成できません。
バージョンの仮想プロパティ
次のプロパティは、VirtualVersionProperties のネストされたオブジェクトの下に存在し、仮想バージョンに対してのみ使用されます。
名前
説明
必須 (プランに対して)
必須 (予測の場合)
必須 (仮想の場合)
リクエスト本文のプロパティ名
値のタイプ
デフォルト値
ベース バージョン
仮想バージョンのベース データを提供するバージョンです。仮想バージョンまたはサブ実績バージョンにすることはできません。
未使用
未使用
なし
baseVersion
文字列 (バージョン名)
デフォルト バージョン
為替レート バージョン
固定通貨のレポート作成で使用される仮想バージョン用為替レートを提供するバージョンです。仮想バージョンまたはサブ実績バージョンにすることはできません。
未使用
未使用
なし
exchangeRateVersion
文字列 (バージョン名)
ルート実績バージョン
固定通貨レポートの有効化
固定通貨レポートを有効/無効にします。
未使用
未使用
なし
enableConstantCurrencyReporting
ブール値
false
オフセット
後ろ方向 (正の整数) または前方向 (負の整数) のオフセット量。
未使用
未使用
なし
offset
整数
0
パブリッシュ アクセス プロパティ
次のリクエスト本文のプロパティは、WD が有効な場合にのみ使用されます。
名前
説明
必須 (プランに対して)
必須 (予測の場合)
必須 (仮想の場合)
リクエスト本文のプロパティ名
値のタイプ
デフォルト値
財務計画
このバージョンの財務プランを有効/無効にします。
"Adaptive Planning for Financial Plans" が有効な場合にのみ使用されます。
なし
未使用
未使用
financialPlans
ブール値
false
人員計画
このバージョンのヘッドカウント プランを有効/無効にします。
財務計画に対する Adaptive Planning またはワークフォースに対する Adaptive Planning のいずれかが有効な場合にのみ使用されます。
なし
未使用
未使用
headcountPlans
ブール値
false
ワークフォース アクション計画
このバージョンのワークフォース アクション プランを有効/無効にします。
"ワークフォースへの Adaptive Planning" が有効になっている場合にのみ使用されます。
なし
未使用
未使用
workforceActionPlans
ブール値
false
リクエスト本文の例
リクエスト本文
 
{
        "parent": "Parent Folder",
        "versionType": "PLANNING",
        "description": "Test Plan Version",
        ...
        ...
        "usersAccess": "LOCKED_EXCEPT_NOTES",
        "editableSheetAccess": "LOCKED",
        ...
        "startOfVersion": "2012",
        "endOfVersion": "2013",
        "startingScrollLocation": "01/2012",
        "lockLeadingTimePeriod": "02/2012",
        "actualsOverlayIncludesUnavailableLevels": true
}
クエリー パラメータ
名前
説明
必須 (プランに対して)
必須 (予測の場合)
必須 (仮想の場合)
URL のパラメータ名
デフォルト値
ソース バージョン名
クローン元のバージョンの名前指定しない場合は、デフォルト バージョンのクローンを作成します。
なし
なし
未使用
sourceVersionName
新しいバージョン名
作成する新しいバージョンの名前。
あり
あり
あり
newVersionName
すべてのデータをコピー
True の場合は、すべてのデータをコピーします。
なし
未使用
未使用
copyAllData
false
共有数式とルールをコピー
真の場合、共有数式とルールをコピーします。
なし
未使用
未使用
copySharedFormulasAndRules
false
すべてのオーバーライド数式をコピー
真の場合は、すべてのオーバーライド数式をコピーします。
なし
なし
未使用
copyAllOverrideFormulas
false
GL とカスタム科目の分割をコピー
True の場合、GL とカスタム科目の分割をコピーします。
なし
未使用
未使用
copySplitsInGLAndCustomAccounts
false
モデル行をコピー
真の場合、モデル行をコピーします。
なし
未使用
未使用
copyModeledRows
false
セル、シート、ワークフローのメモをコピー
True の場合は、セル、シート、ワークフローのメモ (該当する場合) をコピーします。
なし
未使用
未使用
copyAllNotes
false
ワークフローのステータスを進行中にリセット
真の場合、ワークフローのステータスは進行中にリセットされます。
なし
未使用
未使用
resetWorkflowStatusToInProgress
false
変更履歴の履歴をコピー
True の場合は、レポートのパラメータの選択肢としてすべてのレポートに追加されます。
未使用
未使用
copyAuditTrailHistory
false
レポートのパラメータとして選択すべてのレポートに追加
True の場合は、レポートのパラメータの選択肢としてすべてのレポートに追加されます。
なし
未使用
未使用
addAsReportParameterChoiceToAllReports
false
シートの再計算値をコピー
True の場合は、シートの再計算値をコピーします。
なし
未使用
未使用
copyRecalculatedValuesOfSheets
false
警告のまま続行
警告メッセージを却下するために使用される任意のクエリー パラメータ。true に設定しない場合、呼び出しが実行される前に潜在能力に関する警告が返されます。URL でこのパラメータを true に指定することにより、それらを却下します。
なし
なし
なし
proceedWithWarnings
false
インスタンス コード
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
なし
なし
instanceCode
ユーザーのデフォルト インスタンス
- "ワークフローのステータスを進行中にリセット" は、ワークフローが無効になっている企業ではサポートされていません。
- "シートの再計算値をコピー" は、モデル ISOLATION 機能フラグがオフの場合、サポートされません。
パス パラメータ:
名前
説明
必須
テナント
操作するテナント (GREENCO など)
あり
回答例:
204 NO_CONTENT
成功した応答は空白で、ステータス コードは 204 です。