Get Layout Grid
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/grid/layout
Returns the layout grid for the current grid to be saved as layout for the specified cube.
Request
-
applicationName(required): string
Application name for default grid.
-
databaseName(required): string
Database/Cube name for default grid.
The current grid displayed.
object
-
alias:
string
The active alias table for the grid.
-
dimensions:
array dimensions
The part of the grid that describes the included Essbase dimensions and their locations.
-
slice:
object Slice
The part of the grid that contains columns, rows and data.
array
The part of the grid that describes the included Essbase dimensions and their locations.
-
Array of:
object GridDimension
Dimension object array describing the position of a dimension. Includes name, column, row, and pov. If column = 0, the dimension is located at 0th column in grid. If row = 1, it is located at first row in the grid. If the dimension contains a POV, then that dimension is marked with the pov filter. In the following example, Product (100-10), Market (New York), and Scenario (Actual) are in the POV, Measures (Sales) is on columns, and Year (Jan) is on rows.
100-10 New York Actual Sales Jan 1052
object
The part of the grid that contains columns, rows and data.
-
columns:
integer(int32)
Number of columns in the grid.
-
data:
object Data
-
dirtyCells:
array dirtyCells
Array of indexes marking which values are are changed. Required for submit action.
-
dirtyTexts:
array dirtyTexts
Array of indexes marking which cell comments are changed.
-
rows:
integer(int32)
Number of rows in the grid.
object
Dimension object array describing the position of a dimension. Includes name, column, row, and pov. If column = 0, the dimension is located at 0th column in grid. If row = 1, it is located at first row in the grid. If the dimension contains a POV, then that dimension is marked with the pov filter. In the following example, Product (100-10), Market (New York), and Scenario (Actual) are in the POV, Measures (Sales) is on columns, and Year (Jan) is on rows.
100-10 | New York | Actual | |
---|---|---|---|
Sales | |||
Jan | 1052 |
-
column:
integer(int32)
Column location of the dimension in the grid.
-
displayName:
string
-
expanded:
boolean
- hidden: boolean
-
name:
string
Dimension name.
-
pov:
string
If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid.
-
row:
integer(int32)
Row location of the dimension in the grid.
array
Array of indexes marking which values are are changed. Required for submit action.
array
Array of indexes marking which cell comments are changed.
array
-
Array of:
object GridRange
Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.
object
Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.
-
dataFormats:
array dataFormats
Data formats, if format strings are applied.
-
end:
integer(int32)
Number of elements in the grid range.
-
enumIds:
array enumIds
(Internal use)
-
filters:
array filters
-
start:
integer(int32)
Start of the grid range. 0 by default.
-
statuses:
array statuses
Cell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.
-
texts:
array texts
Cell comments.
-
types:
array types
Data types of the cells.
0
: text2
: double7
: empty
-
values:
array values
Cell values, in single-dimension format.
array
Cell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.
Response
- application/json
- application/xml
200 Response
OK
Layout grid returned successfully.
object
-
alias:
string
The active alias table for the grid.
-
dimensions:
array dimensions
The part of the grid that describes the included Essbase dimensions and their locations.
-
slice:
object Slice
The part of the grid that contains columns, rows and data.
array
The part of the grid that describes the included Essbase dimensions and their locations.
-
Array of:
object GridDimension
Dimension object array describing the position of a dimension. Includes name, column, row, and pov. If column = 0, the dimension is located at 0th column in grid. If row = 1, it is located at first row in the grid. If the dimension contains a POV, then that dimension is marked with the pov filter. In the following example, Product (100-10), Market (New York), and Scenario (Actual) are in the POV, Measures (Sales) is on columns, and Year (Jan) is on rows.
100-10 New York Actual Sales Jan 1052
object
The part of the grid that contains columns, rows and data.
-
columns:
integer(int32)
Number of columns in the grid.
-
data:
object Data
-
dirtyCells:
array dirtyCells
Array of indexes marking which values are are changed. Required for submit action.
-
dirtyTexts:
array dirtyTexts
Array of indexes marking which cell comments are changed.
-
rows:
integer(int32)
Number of rows in the grid.
object
Dimension object array describing the position of a dimension. Includes name, column, row, and pov. If column = 0, the dimension is located at 0th column in grid. If row = 1, it is located at first row in the grid. If the dimension contains a POV, then that dimension is marked with the pov filter. In the following example, Product (100-10), Market (New York), and Scenario (Actual) are in the POV, Measures (Sales) is on columns, and Year (Jan) is on rows.
100-10 | New York | Actual | |
---|---|---|---|
Sales | |||
Jan | 1052 |
-
column:
integer(int32)
Column location of the dimension in the grid.
-
displayName:
string
-
expanded:
boolean
- hidden: boolean
-
name:
string
Dimension name.
-
pov:
string
If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid.
-
row:
integer(int32)
Row location of the dimension in the grid.
array
Array of indexes marking which values are are changed. Required for submit action.
array
Array of indexes marking which cell comments are changed.
array
-
Array of:
object GridRange
Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.
object
Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.
-
dataFormats:
array dataFormats
Data formats, if format strings are applied.
-
end:
integer(int32)
Number of elements in the grid range.
-
enumIds:
array enumIds
(Internal use)
-
filters:
array filters
-
start:
integer(int32)
Start of the grid range. 0 by default.
-
statuses:
array statuses
Cell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.
-
texts:
array texts
Cell comments.
-
types:
array types
Data types of the cells.
0
: text2
: double7
: empty
-
values:
array values
Cell values, in single-dimension format.
array
Cell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.
400 Response
Bad Request
Validation failed. The application or database name may be missing or incorrect.
500 Response
Internal Server Error.
Examples
The following example shows how to get a layout from the current Essbase grid. A layout is a grid shape you want to save for future use.
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 cURL command requests a layout for the Sample Basic grid described in the input input_grid.json
.
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%
Input Grid JSON
The input grid in input_grid.json
is:
{
"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":[ "", "", "", "", "", "", "", "", "", "", "", "" ]
}
]
}
}
}
The input JSON describes the grid that is represented by the sample table. Numeric data is not included in the values
range, as it is not needed to produce a layout object.
- | Product | Market | Scenario |
---|---|---|---|
- | Measures | - | - |
Year | 105522 | - | - |
Response Layout JSON
The resulting layout written to layout.json
is:
{
"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" : [ [ "", "", "", "" ], [ "", "", "", "" ], [ "", "", "", "" ] ]
}
}