メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2024-09-20
Modeled Sheet Definition

Modeled Sheet Definition

URL エンドポイント

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/modeled/definition
バージョン: v1
カテゴリ
データの送信
説明
メタデータの変更
呼び出すために必要な権限
モデル管理アクセス
モデルに含まれるシート、科目、属性、数式
リクエストに必要なパラメータ
名前

サポートされている HTTP VERB

HTTP Verb
単一リソース
回収リソース
説明
PATCH
サポート済
サポートされていません
モデル シート定義の挿入または更新
DELETE
サポート済
サポートされていません
モデル シート定義を削除
POST
サポート済
サポートされていません
モデル シート定義アップロードの検証モード
オプション
サポート済
サポートされていません
このコレクション リソースでサポートされている HTTP 動詞のリストを返します。

PATCH

リクエスト URI
/sheet/modeled/definition
指定されたクエリー パラメータと一致するモデル シート定義を更新してください。
一致する識別子を持つシートが存在しない場合は、指定されたプロパティで新しいモデル シートが作成されます。
名称別リクエストの例
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
リクエスト ヘッダーの例
受諾言語: en
リクエスト本文の例
"リクエスト本文" セクションを参照してください。
クエリー パラメータ
名前
説明
必須
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
名前
シートの名前。
なし
proceedWithWarnings
警告の検証を無視するかどうかを指定します。通常は、変更されたシート プロパティによってシートからデータが削除される可能性がある場合に返されます。
なし
reorderColumns
このクエリー パラメータを true に設定すると、列リストの順序が変更され、API リクエスト本文で指定された列の順序が反映されます。デフォルトでは、false に設定されています。参照 参考: モデル シート定義およびキューブ シート定義の JSON API における列の並べ替え。
なし
リクエスト本文
リクエスト本文の例
両方のエンドポイントで、同じモデル シート定義形式が JSON ペイロードとして使用されます。
リクエストのフォーマット
 
{
  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",
              "values": ["value1", "value2"],
              "lookupTables": [
                  {
                      "name": "valueLookup1",
                      "type": "VALUE",
                      "decimalPrecision": 1,
                      "displayAs": "CURRENCY"
                  },
                  {
                      "name": "spreadLookup1",
                      "type": "SPREAD",
                      "decimalPrecision": 0,
                      "displayAs": "NUMBER"
                  }
              ]
          },
          "availability": [
              {
                  "name": "100k",
                  "code": "100k",
                  "available": true
              }
          ],
          "defaultAvailability": false,
          "defaultActionIfDataIsPresent": "delete"
      },
      {
          "properties": {
              "code": "Label",
              "name": "Label",
              "type": "TEXT"
          },
          "delete": true
      }
  ],
  "accounts": [
      {
          "name": "AccountName",
          "code": "AccountCode"
      }
  ],
  "accessibility": {
      "usernames": [ "test@greenco.com" ],
      "excludedFromWorkflow": true
  }
}
シート定義オブジェクト
名前
説明
必須
プロパティ
一般シート プロパティを含むオブジェクト
なし
列
モデル シート列オブジェクトのリスト
新しい列はシート定義の最後に作成され、新しい列の相対的な順序が考慮されます。
既存の列はインプレースでのみ更新されます。再発注されることはありません。
なし
科目
科目オブジェクトのリスト
なし
アクセシビリティ
ユーザー割当シートのアクセシビリティの定義を含むオブジェクト
なし
シート プロパティ オブジェクト
名前
説明
必須
タイプ
デフォルト
説明
シートの説明
なし
文字列
空の文字列
code
科目コードと二次的な一意の識別子のプレフィックスとして使用されるシート コード新しいシートの作成時には必須です。
なし
文字列
prefix
科目コードに使用されるシート プレフィックス新しいシートの作成時には必須です。コードに代わって廃止予定です。
なし
文字列
userAssigned
シートがユーザー割当シートか (デフォルト) 組織割当シートか。
なし
ブール値
false
salaryDetail
シートに給与の詳細が含まれているかどうか。
なし
ブール値
false
frozenColumnCount
なし
整数
0
allowSplits
シートで分割行が許可されているかどうか。
なし
ブール値
false
allowRollupModelEdits
組織の合計の表示中にシートの編集が許可されているかどうか。
なし
ブール値
false
allowActuals
シートが実績バージョンで使用可能かどうか。
なし
ブール値
false
recalculateOnDemand
シートで "要求に応じて再計算" が有効になっているかどうか。
なし
ブール値
false
timeStratumCode
シートのデータに関連付けられた時間層コード
なし
文字列
GL の時間層
シート列オブジェクト
名前
説明
必須
タイプ
デフォルト
プロパティ
シート列のプロパティを含むオブジェクト。
あり
オブジェクト
使用可否設定
現在の列に対するシート使用可否オブジェクトのリスト参照 シートの使用可否 リスト形式の詳細については、
なし
リスト
defaultAvailability
空き状況で指定されていない限り、すべての値に適用されるデフォルトの空き状況。組織と属性列で有効です。
属性列の場合、"availability" または "defaultAvailability" が指定されていない場合、"defaultAvailability" は新しい列に対して true に設定されます。
デフォルトでは、この値は空になっています。つまり、空き状況によって特に変更されない限り、既存の空き状況が保持されます。
なし
ブール値
defaultActionIfDataIsPresent
使用可否設定で指定されていない限り、値の削除時にデータが存在する場合のデフォルトのアクション。属性列では有効です。
既存の列の "デフォルトの使用可否設定" が偽の場合は必須です。
なし
文字列
削除
指定されたシートから列を削除するリクエストです。削除のフラグが設定されていない既存の列に依存する列 (属性特性など) に対しては無効です。
なし
ブール値
シート列のプロパティ オブジェクト
名前
説明
必須
タイプ
デフォルト
名前
列名
なし
文字列
code
列コード。組織と組織通貨列を除くすべての列に必須です。
あり
文字列
type
列のタイプ。
可能な値: Level、DIMENSION、Level_attribute、DIMENSION_UTRIbuTE、TIMESPAR、NUMBER、DATE、TEXT、TEXT_SELECTOR、LEvel_CURRENCY、DISplay、INITIAL_BALANCE、チェックボックス
あり
文字列
readOnly
現在の列が読み取り専用かどうか。属性特性列で、特性を属性のフィルタとして使用するには、"読み取り専用" を "false" に設定します。
組織の特性および表示列では、true である必要があります (デフォルトは true)。
なし
ブール値
false
allowSplits
現在の列が分割可能かどうか。一般の AllowSplits プロパティが True の場合に、シートに対してのみ有効です。
なし
ブール値
false
showTotalsAtBottom
この列のシートの下部に合計を表示するかどうか。
なし
ブール値
false
allowHidden
"表示オプション" のシート ビューアーでこの列を非表示にできるかどうか。テキスト セレクターと期間列を除くすべての列で有効です。
なし
ブール値
真
editableOnSheet
シートから属性列に新しい値を追加できるか。属性とテキスト セレクターの列でのみ有効です。
なし
ブール値
false
必須
各行のこの列に値が必要かどうか。AllowHidden が偽の属性列でのみ有効です。
なし
ブール値
false
recalculateOnMatch
一致した場合に値を再計算するかどうか。recalculateOnDemand が真であるシートでのみ有効な属性とテキスト セレクター列
なし
ブール値
false
lookupTables
スプレッドと値ルックアップを定義する LookupTable オブジェクトのリスト属性とテキスト セレクターの列でのみ有効です。
なし
LookupTable
ヌル
値
テキスト セレクター値として追加する文字列のリスト。テキスト セレクターの列でのみ有効です。
なし
文字列配列
ヌル
rowKey
この列を行キーとして使用できるか。テキスト ドライバー列でのみ有効です。
なし
ブール値
false
displayAs
列の "表示形式" 。数値ドライバー列でのみ有効です。
可能な値: NUMBER、PERCENT、CURRENCY
なし
DisplayAs
false
decimalPrecision
表示する小数点以下の桁数。数値ドライバー列でのみ有効です。
可能な値は 0 ～ 9、-1 (CURRENCY と表示される場合に通貨の小数部桁数を使用する場合) です。
なし
整数
0
showToggle
チェックボックス列をトグルとして表示するかどうか。チェックボックスの列でのみ有効です。
なし
ブール値
false
showInEditMode
モデル シートの編集可能な行に列を表示するかどうか。組織通貨列でのみ有効です。
なし
ブール値
false
referenceTimePeriod
表示列の参照期間を示します。科目表示列でのみ有効です。
可能な値: FIRST_Non_ACTUALS_PERIOD、Start_OF_Plan
なし
文字列
FIRST_NON_ACTUALS_PERIOD
startOfRollupRange
表示列の期間合計範囲を開始する場所を示します。科目表示列でのみ有効です。
可能な値: CONTINING_REFERENCE_PERIOD、BEFORE_REFERENCE_PERIOD、AFTER_REFERENCE_PERIOD
なし
文字列
CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange
表示列の合計範囲に含める期間の数科目表示列でのみ有効です。
なし
整数
1
startOfRollupRangeTimeStratumCode
表示列の合計範囲の開始を決定する期間のコード。科目表示列でのみ有効です。可能な値には、シートの時間層と同じかそれ以降の時間層が含まれます。
なし
文字列
シートの時間層
accountCode
表示列のモデル科目を決定する科目のコード。表示列でのみ有効です。有効な値のみが指定されたモデル シートの科目です
なし
文字列
シート列ルックアップ テーブル オブジェクト
名前
説明
必須
タイプ
デフォルト
名前
ルックアップ テーブル名
あり
文字列
displayAs
このルックアップ テーブルの "表示形式" フォーマット。可能な値: "NUMBER" と "PERCENT"。値ルックアップ テーブルでのみ有効です。
なし
文字列
NUMBER
decimalPrecision
このルックアップ テーブルの値の小数点以下の桁数。可能な値は 0 ～ 9 です。
なし
整数
0
type
ルックアップ テーブルのタイプ。可能な値: VALUE、SPREAD。
あり
文字列
シート科目オブジェクト
詳細については、次を参照してください: 参考: 科目の JSON インポート ペイロードのプロパティ
名前
説明
必須
名前
科目名。
あり
code
科目コード。
あり
親
親科目。
なし
説明
科目の説明。
なし
isCumulative
科目がストックであるかどうかを返します。
なし
isActualsByDelta
科目が実績であるかどうかを差額で返します。
なし
isLink
科目がリンクされた科目であるかどうかを返します。
なし
timeRollupType
時間合計に対して実行する合計のタイプ。
なし
timeWeightAccount
期間合計に使用される加重科目。
なし
levelDimRollupType
組織/カスタム属性合計で実行する合計のタイプ。
なし
levelDimWeightAccount
組織/カスタム属性合計に使用される加重科目。
なし
levelDimRollupText
組織/カスタム属性合計で使用される合計テキスト値。
なし
actualsOverlay
科目の実績オーバーレイ設定。
なし
attributeValues
この科目の科目特性値オブジェクトのリスト。
なし
displayAs
科目の設定として表示されます。
なし
数式
科目の数式。
なし
weightedAverageTranslationsEnabled
科目の加重平均換算が有効かどうかを返します。
なし
weightedAverageTranslationResetStratum
この科目の WAAT REST 層。
なし
weightedAverageTranslationTransferAccount
この科目の WAT 移転科目
なし
decimalPrecision
科目のデフォルトの小数点以下の桁数。
なし
exchangeRateType
この科目の為替レート タイプです。
なし
suppressZeros
シート上の科目に対してゼロ行を非表示にするかどうかを返します。
なし
startExpanded
科目がシート上で展開されているかどうかを返します。
なし
dataEntryType
この科目のデータ入力タイプ設定。
なし
dataPrivacy
この科目のデータ プライバシー設定。
なし
hasSalaryDetail
科目に給与の詳細があるかどうかを返します。
なし
isBreakbackEligible
按分がこの科目の対象であるかどうかを返します。
なし
isSystemAccount
この科目がシステム科目であるかどうかを返します。
なし
isIntercompany
内部取引科目であるかどうかを返します。
なし
IS前提条件
科目が前提条件であるかどうかを返します。
なし
isMetric
科目がメトリック科目であるかどうかを返します。
なし
modeledSheetSpreadCode
関連するモデル スプレッドのモデル シート スプレッド コード。
なし
spreadTargetAccount
スプレッド科目のターゲット科目オブジェクト。
なし
シートのアクセシビリティ オブジェクト
名前
説明
必須
タイプ
デフォルト
ユーザー名
シートに追加するユーザー名のリスト
有効な E メール アドレスの形式である必要があります。
なし
文字列配列
excludedFromWorkflow
シートのアクセシビリティ設定の
"ワークフローから除外済
 " チェックボックスを更新します
なし
ブール値
false
回答例
204
正常に完了した場合の応答は空白で、ステータス コードは 204 です。

DELETE

リクエスト URI
/sheet/modeled/definition
指定されたクエリー パラメータに一致するモデル シートの定義を削除します。一致する識別子を持つシートが存在しない場合、次のエラーが発生します。
名称別リクエストの例
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
リクエスト ヘッダーの例
受諾言語: en
リクエスト本文の例
<なし>
クエリー パラメータ
名前
説明
必須
名前
モデル シートの名前。
なし
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
回答例
204
成功した応答は空白で、ステータス コードは 204 です。

POST

リクエスト URI
/sheet/modeled/definition/validate
モデル シートの定義リクエストを検証します。
名称別リクエストの例
https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/modeled/definition/validate?name=My Sheet
リクエスト ヘッダーの例
受諾言語: en
リクエスト本文の例
<以下に記載>
クエリー パラメータ
検証されている相対エンドポイント (PATCH など) を参照してください。
リクエスト本文
リクエスト本文の例
検証されるエンドポイントの JSON ペイロードと同じモデル シート定義形式が使用されます。ただし、オブジェクト
validationOptions
 は検証リクエストの送信時にペイロードに含まれている必要があります。
リクエストのフォーマット
 
{

  "validationOptions": {
      "httpMethod": "Patch",
      "dependentDimensions": [
          "MyTestDim1", "MyTestDim2"
      ],
      "dependentAttributes": [
          {
              "attributeName": "MyTestAttr1",
              "attributeType": "DIMENSION_ATTRIBUTE",
              "dimensionName": "MyTestDim2"
          },
          {
              "attributeName": "MyTestAttr2",
              "attributeType": "LEVEL_ATTRIBUTE"
          }
      ]
  },

  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",

...
検証オプション オブジェクト
名前
説明
必須
httpMethod
どのモデル シートの API エンドポイントを検証するかを指定します。現在、次のエンドポイントをサポートしています。
  • PATCH
あり
dependentDimensions
検証で存在すると想定される属性名のリスト。検証リクエストの結果、属性は保持されません。依存するすべてのカスタム属性が均一であると想定されます。
なし
dependentAttributes
依存特性オブジェクトのリスト検証リクエストの結果、特性は保持されません。
なし
扶養家族の属性オブジェクト
名前
説明
必須
attributeName
依存特性の名前。
あり
attributeType
依存特性のタイプ。サポートされているタイプは次のとおりです。
  • LEVEL_ATTRIBUTE
  • DIMENSION_ATTRIBUTE
あり
dimensionName
依存特性の属性の名前。属性特性にのみ適用され、必須です。組織の特性では使用できません。
なし