グリッド・レイアウトの保存
/essbase/rest/v1/applications/{application}/databases/{database}/layouts
指定されたキューブのグリッド・レイアウトを保存します。レイアウトとは、キューブに関連付けられている保存済のグリッドの形状です。将来的に再度使用するグリッドを作成する場合は、これをレイアウトとして保存できます。キューブが移行、エクスポートおよびライフサイクル管理(LCM)ツールを使用してコピーまたは移動される場合、レイアウトとレポートが含められます。
リクエスト
- application/json
- application/xml
- application(required): string
アプリケーション名。
- database(required): string
データベース名。
レイアウトとして保存するグリッド。
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" ]
レスポンス
- 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コマンドを含むスクリプト
POST操作で、postlayout.json内の指定を使用して、Sample Basic内にQ1ColaSalesNYという名前で保存されるレイアウトを作成します。
call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/layouts?links=none" -H "Accept:application/json" -H "Content-Type:application/json" --data "@./postlayout.json" -u %User%:%Password%入力JSON
次の例は、postlayout.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です。