Get Layout Grid

post

/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

Path Parameters
Body ()

The current grid displayed.

Root Schema : Grid
Type: object
Show Source
Nested Schema : dimensions
Type: array

The part of the grid that describes the included Essbase dimensions and their locations.

Show Source
  • 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-10New YorkActual
     Sales  
    Jan1052  

Nested Schema : Slice
Type: object

The part of the grid that contains columns, rows and data.

Show Source
Nested Schema : GridDimension
Type: 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-10New YorkActual
 Sales  
Jan1052  

Show Source
Nested Schema : Data
Type: object
Show Source
Nested Schema : dirtyCells
Type: array

Array of indexes marking which values are are changed. Required for submit action.

Show Source
Nested Schema : dirtyTexts
Type: array

Array of indexes marking which cell comments are changed.

Show Source
Nested Schema : ranges
Type: array
Show Source
  • GridRange

    Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.

Nested Schema : GridRange
Type: object

Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.

Show Source
Nested Schema : dataFormats
Type: array

Data formats, if format strings are applied.

Show Source
Nested Schema : enumIds
Type: array

(Internal use)

Show Source
Nested Schema : filters
Type: array
Show Source
Nested Schema : statuses
Type: 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.

Show Source
Nested Schema : texts
Type: array

Cell comments.

Show Source
Nested Schema : types
Type: array

Data types of the cells.

  • 0: text
  • 2: double
  • 7: empty

Show Source
Nested Schema : values
Type: array

Cell values, in single-dimension format.

Show Source
Back to Top

Response

Supported Media Types

200 Response

OK

Layout grid returned successfully.

Body ()
Root Schema : Grid
Type: object
Show Source
Nested Schema : dimensions
Type: array

The part of the grid that describes the included Essbase dimensions and their locations.

Show Source
  • 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-10New YorkActual
     Sales  
    Jan1052  

Nested Schema : Slice
Type: object

The part of the grid that contains columns, rows and data.

Show Source
Nested Schema : GridDimension
Type: 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-10New YorkActual
 Sales  
Jan1052  

Show Source
Nested Schema : Data
Type: object
Show Source
Nested Schema : dirtyCells
Type: array

Array of indexes marking which values are are changed. Required for submit action.

Show Source
Nested Schema : dirtyTexts
Type: array

Array of indexes marking which cell comments are changed.

Show Source
Nested Schema : ranges
Type: array
Show Source
  • GridRange

    Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.

Nested Schema : GridRange
Type: object

Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.

Show Source
Nested Schema : dataFormats
Type: array

Data formats, if format strings are applied.

Show Source
Nested Schema : enumIds
Type: array

(Internal use)

Show Source
Nested Schema : filters
Type: array
Show Source
Nested Schema : statuses
Type: 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.

Show Source
Nested Schema : texts
Type: array

Cell comments.

Show Source
Nested Schema : types
Type: array

Data types of the cells.

  • 0: text
  • 2: double
  • 7: empty

Show Source
Nested Schema : values
Type: array

Cell values, in single-dimension format.

Show Source

400 Response

Bad Request

Validation failed. The application or database name may be missing or incorrect.

500 Response

Internal Server Error.

Back to Top

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" : [ [ "", "", "", "" ], [ "", "", "", "" ], [ "", "", "", "" ] ]
  }
}
Notice that layout objects do not include the data values. You can use this saved layout to render a grid using Execute Grid Layout.
Back to Top