グリッド・レイアウト詳細の取得
/essbase/rest/v1/applications/{application}/databases/{database}/layouts/{layout}
指定されたレイアウトの詳細を取得します。
レイアウトとは、キューブに関連付けられている保存済のグリッドの形状です。将来的に再度使用するグリッドを作成する場合は、これをレイアウトとして保存できます。キューブが移行、エクスポートおよびライフサイクル管理(LCM)ツールを使用してコピーまたは移動される場合、レイアウトとレポートが含められます。
リクエスト
- application(required): string
アプリケーション名。
- database(required): string
データベース名。
- layout(required): string
レイアウト名。
- user: string
ユーザー名。
レスポンス
- application/json
- application/xml
200 レスポンス
OK
レイアウト詳細が正常に返されました。
object- alias: string
グリッドのアクティブな別名表。
- data: object LayoutData
- dimensions: array dimensions
object- cellText: boolean
- columnSuppression: object Suppression
- formulaRetention: object FormulaRetention
- includeDescriptionLabel: boolean
- includeSelection: boolean
- indentation: string
指定可能な値:
[ "NONE", "SUBITEMS", "TOTALS" ] - maxRows: integer(int32)
- missingText: string
- navigate: boolean
- noAccessText: string
データ値を表示するための適切なセキュリティ・アクセス権がない場合に表示される文字列。デフォルトは#NoAccessです。
- removeUnSelectedGroup: boolean
- repeatMemberLabels: boolean
- rowSuppression: object Suppression
- withinSelectedGroup: boolean
- zoomIn: object ZoomIn
object- axis: string
指定可能な値:
[ "COLUMN", "ROW", "POV" ] - displayName: string
- expanded: boolean
- hidden: boolean
- name: string
- page: integer(int32)
- position: integer(int32)
object- ancestor: string
指定可能な値:
[ "TOP", "BOTTOM" ] - mode: string
指定可能な値:
[ "CHILDREN", "DESCENDENTS", "BASE" ]
400 レスポンス
不正なリクエスト
レイアウト詳細の取得に失敗しました。
例
次の例では、キューブに関連付けられた特定のEssbase名前付きレイアウトの詳細を取得する方法を示します。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。
cURLコマンドを含むスクリプト
GET操作で、Sample Basic内のQ1ColaSalesNYという名前のレイアウトを要求します。(同じレイアウトを作成するには、「レイアウトの保存」で使用されている例を試行します。)
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/layouts/Q1ColaSalesNY?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -o Q1ColaSalesNY.json -u %User%:%Password%レスポンス本体の例
次の例は、Q1ColaSalesNY.jsonに書き込まれるレスポンス本体の内容を示しています。
{
"header" : {
"name" : "Q1ColaSalesNY",
"user" : "admin",
"databaseDefault" : false,
"userDefault" : false,
"session" : false
},
"spec" : {
"description" : "",
"grid" : {
"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" : [ [ "", "Actual" ], [ "", "Cola" ], [ "", "New York" ], [ "", "Sales" ], [ "Jan", "1052.0" ], [ "Feb", "645.0" ], [ "Mar", "675.0" ], [ "Qtr1", "2372.0" ] ],
"types" : [ [ "7", "0" ], [ "7", "0" ], [ "7", "0" ], [ "7", "0" ], [ "0", "2" ], [ "0", "2" ], [ "0", "2" ], [ "0", "2" ] ],
"texts" : [ [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ], [ null, null ] ],
"dataFormats" : [ ],
"statuses" : [ [ "0", "536870928" ], [ "0", "268435472" ], [ "0", "402653200" ], [ "0", "134217744" ], [ "16", "2" ], [ "16", "2" ], [ "16", "2" ], [ "134", "1" ] ],
"filters" : [ ],
"enumIds" : [ [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ] ]
}
}
}
}レイアウトに関するヘッダー情報には、その名前、作成したユーザー、キューブのデフォルト・レイアウトであるかどうか、およびこのユーザーのデフォルト・レイアウトであるかどうかが含まれます。キューブの各ディメンションのリストやレイアウトに含まれるデータなど、グリッドに関する情報がspecオブジェクト内にリストされます。dataオブジェクトには、データ・セルの値とデータ型が含まれます。データ・セルのデータ型は、テキストの場合は0、倍精度の場合は2、空の場合は7です。