レイアウト・グリッドの取得
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/grid/layout
指定されたキューブのレイアウトとして保存する、現在のグリッドのレイアウト・グリッドを返します。
リクエスト
- applicationName(required): string
デフォルト・グリッドのアプリケーション名。
- databaseName(required): string
デフォルト・グリッドのデータベース名またはキューブ名。
現在表示されているグリッド。
object- alias: string
グリッドのアクティブな別名表。
- dimensions: array dimensions
含まれるEssbaseディメンションとその場所を示すグリッドの部分。
- slice: object Slice
列、行およびデータを含むグリッドの部分。
array含まれるEssbaseディメンションとその場所を示すグリッドの部分。
- 配列: object GridDimension
ディメンションの位置を示すディメンション・オブジェクト配列。name、column、rowおよびpovが含まれます。column = 0の場合、ディメンションはグリッドの0番目の列にあります。row = 1の場合、これはグリッドの最初の行にあります。ディメンションにPOVが含まれている場合、そのディメンションはpovフィルタでマークされます。次の例では、Product (100-10)、Market (New York)およびScenario (Actual)がPOVに含まれ、Measures (Sales)が列にあり、Year (Jan)が行にあります。
100-10 New York Actual Sales Jan 1052
object列、行およびデータを含むグリッドの部分。
- columns: integer(int32)
グリッドの列の数。
- data: object Data
- dirtyCells: array dirtyCells
変更された値をマークするインデックスの配列。送信アクションの場合に必須。
- dirtyTexts: array dirtyTexts
変更されたセル・コメントをマークするインデックスの配列。
- rows: integer(int32)
グリッドの行の数。
objectディメンションの位置を示すディメンション・オブジェクト配列。name、column、rowおよびpovが含まれます。column = 0の場合、ディメンションはグリッドの0番目の列にあります。row = 1の場合、これはグリッドの最初の行にあります。ディメンションにPOVが含まれている場合、そのディメンションはpovフィルタでマークされます。次の例では、Product (100-10)、Market (New York)およびScenario (Actual)がPOVに含まれ、Measures (Sales)が列にあり、Year (Jan)が行にあります。
| 100-10 | New York | Actual | |
|---|---|---|---|
| Sales | |||
| Jan | 1052 |
- column: integer(int32)
グリッド内のディメンションの列の場所。
- displayName: string
- expanded: boolean
- hidden: boolean
- name: string
ディメンション名。
- pov: string
ディメンションがPOVにある場合はメンバー名。POVは視点で、グリッドの開始コンテキストまたはスコープです。
- row: integer(int32)
グリッド内のディメンションの行の場所。
array- 配列: object GridRange
グリッド・データを示す範囲。values、types、texts、statuses、enumIds、data、dataFormatsおよびstartポイントとendポイントが含まれます。
objectグリッド・データを示す範囲。values、types、texts、statuses、enumIds、data、dataFormatsおよびstartポイントとendポイントが含まれます。
- dataFormats: array dataFormats
フォーマット文字列が適用される場合はデータ・フォーマット。
- end: integer(int32)
グリッド範囲内の要素の数。
- enumIds: array enumIds
(内部使用)
- filters: array filters
- start: integer(int32)
グリッド範囲の開始点。デフォルトでは0。
- statuses: array statuses
セル・ステータス。セル・ステータスは、セル値に対して返される場合がある追加情報です。DC: 動的計算。RO: 読取り専用。CM: 計算済メンバー。LO: リンク・オブジェクト。
- texts: array texts
セル・コメント。
- types: array types
セルのデータ型。
0: テキスト2: 倍精度7: 空
- values: array values
単一ディメンション・フォーマットでのセルの値。
arrayセル・ステータス。セル・ステータスは、セル値に対して返される場合がある追加情報です。DC: 動的計算。RO: 読取り専用。CM: 計算済メンバー。LO: リンク・オブジェクト。
レスポンス
- application/json
- application/xml
200 レスポンス
OK
レイアウト・グリッドが正常に返されました。
object- alias: string
グリッドのアクティブな別名表。
- dimensions: array dimensions
含まれるEssbaseディメンションとその場所を示すグリッドの部分。
- slice: object Slice
列、行およびデータを含むグリッドの部分。
array含まれるEssbaseディメンションとその場所を示すグリッドの部分。
- 配列: object GridDimension
ディメンションの位置を示すディメンション・オブジェクト配列。name、column、rowおよびpovが含まれます。column = 0の場合、ディメンションはグリッドの0番目の列にあります。row = 1の場合、これはグリッドの最初の行にあります。ディメンションにPOVが含まれている場合、そのディメンションはpovフィルタでマークされます。次の例では、Product (100-10)、Market (New York)およびScenario (Actual)がPOVに含まれ、Measures (Sales)が列にあり、Year (Jan)が行にあります。
100-10 New York Actual Sales Jan 1052
object列、行およびデータを含むグリッドの部分。
- columns: integer(int32)
グリッドの列の数。
- data: object Data
- dirtyCells: array dirtyCells
変更された値をマークするインデックスの配列。送信アクションの場合に必須。
- dirtyTexts: array dirtyTexts
変更されたセル・コメントをマークするインデックスの配列。
- rows: integer(int32)
グリッドの行の数。
objectディメンションの位置を示すディメンション・オブジェクト配列。name、column、rowおよびpovが含まれます。column = 0の場合、ディメンションはグリッドの0番目の列にあります。row = 1の場合、これはグリッドの最初の行にあります。ディメンションにPOVが含まれている場合、そのディメンションはpovフィルタでマークされます。次の例では、Product (100-10)、Market (New York)およびScenario (Actual)がPOVに含まれ、Measures (Sales)が列にあり、Year (Jan)が行にあります。
| 100-10 | New York | Actual | |
|---|---|---|---|
| Sales | |||
| Jan | 1052 |
- column: integer(int32)
グリッド内のディメンションの列の場所。
- displayName: string
- expanded: boolean
- hidden: boolean
- name: string
ディメンション名。
- pov: string
ディメンションがPOVにある場合はメンバー名。POVは視点で、グリッドの開始コンテキストまたはスコープです。
- row: integer(int32)
グリッド内のディメンションの行の場所。
array- 配列: object GridRange
グリッド・データを示す範囲。values、types、texts、statuses、enumIds、data、dataFormatsおよびstartポイントとendポイントが含まれます。
objectグリッド・データを示す範囲。values、types、texts、statuses、enumIds、data、dataFormatsおよびstartポイントとendポイントが含まれます。
- dataFormats: array dataFormats
フォーマット文字列が適用される場合はデータ・フォーマット。
- end: integer(int32)
グリッド範囲内の要素の数。
- enumIds: array enumIds
(内部使用)
- filters: array filters
- start: integer(int32)
グリッド範囲の開始点。デフォルトでは0。
- statuses: array statuses
セル・ステータス。セル・ステータスは、セル値に対して返される場合がある追加情報です。DC: 動的計算。RO: 読取り専用。CM: 計算済メンバー。LO: リンク・オブジェクト。
- texts: array texts
セル・コメント。
- types: array types
セルのデータ型。
0: テキスト2: 倍精度7: 空
- values: array values
単一ディメンション・フォーマットでのセルの値。
arrayセル・ステータス。セル・ステータスは、セル値に対して返される場合がある追加情報です。DC: 動的計算。RO: 読取り専用。CM: 計算済メンバー。LO: リンク・オブジェクト。
400 レスポンス
不正なリクエスト
検証が失敗しました。アプリケーション名またはデータベース名が不足しているか正しくない可能性があります。
500 レスポンス
サーバーの内部エラーです。
例
次の例では、現在のEssbaseグリッドからレイアウトを取得する方法を示します。レイアウトとは、将来使用するために保存するグリッドの形状です。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。
cURLコマンドを含むスクリプト
cURLコマンドで、入力input_grid.jsonに記述されているSample Basicグリッドのレイアウトをリクエストします。
call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/grid/layout -H "Accept:application/json" -H "Content-Type:application/json" --data "@./input_grid.json" -o layout.json -u %User%:%Password%入力グリッドのJSON
input_grid.jsonに含まれる入力グリッドは、次のとおりです。
{
"alias":"Default",
"dimensions":[
{
"name":"Year",
"row":-1,
"column":0,
"pov":"",
"hidden":false,
"expanded":false
},
{
"name":"Measures",
"row":1,
"column":-1,
"pov":"",
"hidden":false,
"expanded":false
},
{
"name":"Product",
"row":-1,
"column":-1,
"pov":"Product",
"hidden":false,
"expanded":false
},
{
"name":"Market",
"row":-1,
"column":-1,
"pov":"Market",
"hidden":false,
"expanded":false
},
{
"name":"Scenario",
"row":-1,
"column":-1,
"pov":"Scenario",
"hidden":false,
"expanded":false
}
],
"slice":{
"columns":4,
"rows":3,
"data":{
"ranges":[
{
"start":0,
"end":11,
"values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Year", "", "", "" ],
"types":[ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
"texts":[ null, null, null, null, null, null, null, null, null, null, null, null ],
"dataFormats":[ ],
"statuses":[ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "8193", "0", "0" ],
"filters":[ ],
"enumIds":[ "", "", "", "", "", "", "", "", "", "", "", "" ]
}
]
}
}
}入力JSONは、サンプル表で示されているグリッドを示しています。数値データはレイアウト・オブジェクトの生成に必要ないため、valuesの範囲に含まれていません。
| - | Product | Market | Scenario |
|---|---|---|---|
| - | Measures | - | - |
| Year | 105522 | - | - |
レスポンスのレイアウトJSON
layout.jsonに書き込まれる結果のレイアウトは、次のとおりです。
{
"alias" : "Default",
"dimensions" : [ {
"name" : "Year",
"page" : 0,
"hidden" : false,
"expanded" : false,
"axis" : "POV",
"position" : 0
}, {
"name" : "Measures",
"page" : 0,
"hidden" : false,
"expanded" : false,
"axis" : "POV",
"position" : 0
}, {
"name" : "Product",
"page" : 0,
"hidden" : false,
"expanded" : false,
"axis" : "POV",
"position" : 0
}, {
"name" : "Market",
"page" : 0,
"hidden" : false,
"expanded" : false,
"axis" : "POV",
"position" : 0
}, {
"name" : "Scenario",
"page" : 0,
"hidden" : false,
"expanded" : false,
"axis" : "POV",
"position" : 0
} ],
"data" : {
"values" : [ [ "", "Product", "Market", "Scenario" ], [ "", "Measures", "", "" ], [ "Year", "", "", "" ] ],
"types" : [ [ "7", "0", "0", "0" ], [ "7", "0", "7", "7" ], [ "0", "2", "7", "7" ] ],
"texts" : [ [ null, null, null, null ], [ null, null, null, null ], [ null, null, null, null ] ],
"dataFormats" : [ ],
"statuses" : [ [ "0", "268435475", "402653203", "536870923" ], [ "0", "134217739", "0", "0" ], [ "135", "8193", "0", "0" ] ],
"filters" : [ ],
"enumIds" : [ [ "", "", "", "" ], [ "", "", "", "" ], [ "", "", "", "" ] ]
}
}