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

キューブ シート定義

URL エンドポイント

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

サポートされている HTTP VERB

HTTP Verb
単一リソース
説明
PATCH
サポート済
キューブ シート定義の挿入または更新
DELETE
サポート済
キューブ シート定義の削除
オプション
サポート済
このコレクション リソースでサポートされている HTTP 動詞のリストを返します。

PATCH

リクエスト URI
/sheet/cube/definition
指定されたクエリー パラメータと一致するキューブ シート定義を更新してください。
一致する名前のシートが存在しない場合は、指定されたプロパティで新しいキューブ シートが作成されます。
名称別リクエストの例
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
リクエスト ヘッダーの例
受諾言語: en
リクエスト本文の例
"リクエスト本文" セクションを参照してください。
クエリー パラメータ
名前
説明
必須
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
名前
シートの名前。
なし
reorderColumns
このクエリー パラメータを true に設定すると、列リストの順序が変更され、API リクエスト本文で指定された列の順序が反映されます。デフォルトでは、false に設定されています。参照 参考: モデル シート定義およびキューブ シート定義の JSON API における列の並べ替え。
なし
リクエスト本文
リクエスト本文の例
両方のエンドポイントで、同じキューブ シート定義形式が JSON ペイロードとして使用されます。
リクエストのフォーマット
 
{
   "properties": {
       "description": "Expense Cube",
       "prefix": "Expense",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "ProductFurniture"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "availability":List<SheetAvaliabilityDTO>,
           "defaultAvailability": false
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode"
       }
   ],
   "accessibility": {
       "usernames": [ "test@greenco.com" ],
       "excludedFromWorkflow": true
   }
}
リクエストの例:
シート作成のリクエストの例
 
{
   "properties": {
       "description": "Test description",
       "prefix": "TestPrefix",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "Base Pay"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "type": "Account"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Level"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Time"
           }
       },
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "defaultAvailability": true
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode",
           "type": "Standard"
       }
   ]
}
シート定義オブジェクト
名前
説明
必須
プロパティ
一般シート プロパティを含むオブジェクト
なし
列
キューブ シートの列オブジェクトのリスト
なし
科目
科目オブジェクトのリスト
なし
アクセシビリティ
ユーザー割当シートのアクセシビリティの定義を含むオブジェクト
なし
シート プロパティ オブジェクト
名前
説明
必須
タイプ
デフォルト
説明
シートの説明
なし
文字列
空の文字列
prefix
科目コードに使用されるシート プレフィックス
なし
文字列
userAssigned
シートがユーザー割当シートか (デフォルト) 組織割当シートか。
なし
ブール値
false
timeStratumCode
シートのデータに関連付けられた時間層コード
なし
文字列
GL の時間層
recalculateOnDemand
シートで "要求に応じて再計算" が有効になっているかどうか。
なし
ブール値
false
rearrangeGLAndCustomAccounts
ユーザーが他のキューブ科目とともにキューブ入力科目を並べ替えることが許可されているかどうか。これは、キューブ標準科目が存在する場合、またはリクエストで作成されている場合にのみ有効化できます。
なし
ブール値
false
hideRollupTotals
シートのパフォーマンスを向上させるために合計を非表示にするかどうか。
なし
ブール値
false
horizontalAxis
横軸の列を識別する列参照オブジェクト。
なし
列オブジェクト
Time
verticalAxis
縦軸の列を識別する列参照オブジェクトのリスト指定した場合、縦軸は以前の選択を上書きします。
なし
列オブジェクト配列
Account
maxColumnWidth
各列のピクセル単位の最大幅10 ～ 1000 の値の間で指定してください。幅が指定されていない場合は 0 を指定してください。
なし
整数
0
suppressZeroRows
ゼロ行を非表示にするかどうか
なし
ブール値
false
シート列の参照オブジェクト
名前
説明
必須
名前
列名カスタム属性および特性の場合は必須です。
あり
type
列タイプ
あり
シート列オブジェクト
名前
説明
必須
プロパティ
シート列のプロパティを含むオブジェクト。
あり
使用可否設定
現在の列に対するシート使用可否オブジェクトのリスト参照 シートの使用可否 リスト形式の詳細については、
なし
defaultAvailability
空き状況で指定されていない限り、すべての値に適用されるデフォルトの空き状況。組織と属性列で有効です。
なし
削除
指定されたシートから列を削除するリクエストです。削除のフラグが設定されていない既存の列に依存する列 (属性特性など) に対しては無効です。
なし
シート列のプロパティ オブジェクト
名前
説明
必須
タイプ
デフォルト
名前
列名 カスタム属性列および特性列の場合、名前はそれぞれのカスタム属性または特性の名前と一致します。
あり
文字列
type
列のタイプ。
可能な値: Level、ACCOUNT、TIME、DIMENSION、Level_attribute、ACCOUNT_ATRIBTE、DIMENSION_ATRIbuTE
あり
文字列
initialBalance
初期残高がシートに表示されるかどうか。時間列でのみ有効です。
なし
ブール値
真
visibleTimeStratumCodes
シートに表示される時間層のリストを定義します。時間列でのみ有効です。
なし
文字列配列
すべての時間層
editableOnSheet
シートから属性列に新しい値を追加できるか。属性とテキスト セレクターの列でのみ有効です。
なし
ブール値
false
newValueBehavior
が元の属性に追加されたときに新しい値を有効にするか無効にするかを定義します。属性列でのみ有効です。サポートされている値: AVAILable、UNAVAilable、PARENT
なし
文字列
使用可能
シート列ルックアップ テーブル オブジェクト
名前
説明
必須
タイプ
デフォルト
名前
ルックアップ テーブル名
あり
文字列
displayAs
このルックアップ テーブルの "表示形式" フォーマット。可能な値: "NUMBER" と "PERCENT"。値ルックアップ テーブルでのみ有効です。
なし
文字列
NUMBER
decimalPrecision
このルックアップ テーブルの値の小数点以下の桁数。可能な値は 0 ～ 9 です。
なし
整数
0
type
ルックアップ テーブルのタイプ。可能な値: VALUE、SPREAD。
あり
文字列
シート科目オブジェクト
詳細については、次を参照してください: 参考: 科目の JSON インポート ペイロードのプロパティ
名前
説明
必須
名前
科目名。
あり
code
科目コード。
あり
親
親科目。
なし
タイプ
科目タイプ。
あり
説明
科目の説明。
なし
shortName
科目の短縮名
なし
isCumulative
科目がストックであるかどうかを返します。
なし
isPlanByDelta
科目が差額での計画であるかどうかを返します。
なし
isActualsByDelta
科目が実績であるかどうかを差額で返します。
なし
isLink
科目がリンクされた科目であるかどうかを返します。
なし
timeRollupType
時間合計に対して実行する合計のタイプ。
なし
timeWeightAccount
期間合計に使用される加重科目。
なし
levelDimRollupType
組織/カスタム属性合計で実行する合計のタイプ。
なし
levelDimWeightAccount
組織/カスタム属性合計に使用される加重科目。
なし
levelDimRollupText
組織/カスタム属性合計で使用される合計テキスト値。
なし
actualsOverlay
科目の実績オーバーレイ設定。
なし
attributeValues
この科目の科目特性値オブジェクトのリスト。
なし
displayAs
科目の設定として表示されます。
なし
数式
科目の数式。
なし
decimalPrecision
科目のデフォルトの小数点以下の桁数。
なし
exchangeRateType
この科目の為替レート タイプです。
なし
suppressZeros
シート上の科目に対してゼロ行を非表示にするかどうかを返します。
なし
startExpanded
科目がシート上で展開されているかどうかを返します。
なし
dataEntryType
この科目のデータ入力タイプ設定。
なし
dataPrivacy
この科目のデータ プライバシー設定。
なし
linkedAccountMappings
LinkedAccountMapping のリスト。
なし
シートのアクセシビリティ オブジェクト
名前
説明
必須
タイプ
デフォルト
ユーザー名
シートに追加するユーザー名のリスト
有効な E メール アドレスの形式である必要があります。
なし
文字列配列
excludedFromWorkflow
シートのアクセシビリティ設定の "ワークフローから除外" チェックボックスが更新されます。
なし
ブール値
false
回答例
204
正常に完了した場合の応答は空白で、ステータス コードは 204 です。

DELETE

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