Get Layout Details
/essbase/rest/v1/applications/{application}/databases/{database}/layouts/{layout}
Gets the details for the specified layout.
A layout is a saved grid shape associated with a cube. If you create a grid that you would like to use again in the future, you can save it as a Layout. Layouts and reports are included when the cube is copied or moved using migration, export, and Lifecycle Mangement (LCM) tools.
Request
-
application: string
Application name.
-
database: string
Database name.
-
layout: string
Layout name.
-
user(optional): string
User name.
Response
- application/json
- application/xml
200 Response
OK
Layout details returned successfully.
object-
alias(optional):
string
The active alias table for the grid.
-
data(optional):
object LayoutData
-
dimensions(optional):
array dimensions
object-
cellText(optional):
boolean
-
columnSuppression(optional):
object Suppression
-
formulaRetention(optional):
object FormulaRetention
-
includeDescriptionLabel(optional):
boolean
-
includeSelection(optional):
boolean
-
indentation(optional):
string
Allowed Values:
[ "NONE", "SUBITEMS", "TOTALS" ] -
maxRows(optional):
integer(int32)
-
missingText(optional):
string
- navigate(optional): boolean
-
noAccessText(optional):
string
The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.
-
removeUnSelectedGroup(optional):
boolean
-
repeatMemberLabels(optional):
boolean
-
rowSuppression(optional):
object Suppression
-
withinSelectedGroup(optional):
boolean
-
zoomIn(optional):
object ZoomIn
object-
axis(optional):
string
Allowed Values:
[ "COLUMN", "ROW", "POV" ] -
displayName(optional):
string
-
expanded(optional):
boolean
- hidden(optional): boolean
-
name(optional):
string
-
page(optional):
integer(int32)
-
position(optional):
integer(int32)
object-
ancestor(optional):
string
Allowed Values:
[ "TOP", "BOTTOM" ] -
mode(optional):
string
Allowed Values:
[ "CHILDREN", "DESCENDENTS", "BASE" ]
400 Response
Bad Request
Failed to get layout details.
Examples
The following example shows how to retrieve details about a specific Essbase named layout associated with the cube.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.
Script with cURL Command
The GET operation requests details about a layout in Sample Basic named Q1ColaSalesNY. (To create the same layout, try the example used in Save Layout.)
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%Example of Response Body
The following example shows the contents of the response body written to 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" : [ [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ], [ "", "" ] ]
}
}
}
}The header information about the layout includes its name, the user who created it, whether it is the default layout for the cube, and whether it is the default layout for this user. Information about the grid is listed within the spec object, including a listing of each dimension of the cube, and the data contained in the layout. The data object includes the values and types of data cells. Data cell types are 0 for text, 2 for doubles, and 7 for empty.