REST API for Oracle Essbase

Get Default Grid

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/grid

Returns the default grid for the specified cube. The default grid is the first grid you would see in an ad hoc analysis of the database, before performing any grid operations.

Request

Path Parameters

applicationName(required): string

Application name for default grid.
databaseName(required): string

Database/Cube name for default grid.

Query Parameters

reset: boolean

Reset flag to avoid saved grid layout.

Default Value: false

Response

Supported Media Types

application/json
application/xml

200 Response

Grid returned successfully.

Root Schema : Grid

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "slice":{
            "$ref":"#/definitions/Slice",
            "description":"<p>The part of the grid that contains columns, rows and data.</p>"
        },
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "dimensions":{
            "type":"array",
            "description":"<p>The part of the grid that describes the included Essbase dimensions and their locations.</p>",
            "items":{
                "$ref":"#/definitions/GridDimension"
            }
        }
    }
}

Nested Schema : dimensions

Type: array

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

Show Source

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

{
    "type":"array",
    "description":"<p>The part of the grid that describes the included Essbase dimensions and their locations.</p>",
    "items":{
        "$ref":"#/definitions/GridDimension"
    }
}

Nested Schema : Slice

Type: object

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

Show Source

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.

{
    "type":"object",
    "description":"<p>The part of the grid that contains columns, rows and data.</p>",
    "properties":{
        "dirtyCells":{
            "type":"array",
            "description":"<p>Array of indexes marking which values are are changed. Required for submit action.</p>",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "dirtyTexts":{
            "type":"array",
            "description":"<p>Array of indexes marking which cell comments are changed.</p>",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "columns":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of columns in the grid.</p>"
        },
        "data":{
            "$ref":"#/definitions/Data",
            "description":"<p>Grid data, consisting of ranges. Ranges contain values, types, texts, statuses, enumIds, data, and dataFormats.</p>"
        },
        "rows":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of rows in the grid.</p>"
        }
    }
}

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-10	New York	Actual
	Sales
Jan	1052

Show Source

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.

{
    "type":"object",
    "description":"<p>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. <table><tr><th>&nbsp;</th><th>100-10</th><th>New York</th><th>Actual</th></tr><tr><td>&nbsp;</td><td><strong>Sales</strong></td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td><strong>Jan</strong></td><td>1052</td><td>&nbsp;</td><td>&nbsp;</td></tr></table></p>",
    "properties":{
        "expanded":{
            "type":"boolean"
        },
        "pov":{
            "type":"string",
            "description":"<p>If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid. </p>"
        },
        "row":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Row location of the dimension in the grid.</p>"
        },
        "column":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Column location of the dimension in the grid.</p>"
        },
        "displayName":{
            "type":"string"
        },
        "hidden":{
            "type":"boolean"
        },
        "name":{
            "type":"string",
            "description":"<p>Dimension name.</p>"
        }
    }
}

Nested Schema : Data

Type: object

Show Source

ranges: array ranges

{
    "type":"object",
    "properties":{
        "ranges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GridRange"
            }
        }
    }
}

Nested Schema : dirtyCells

Type: array

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

Show Source

Array of: integer(int32)

{
    "type":"array",
    "description":"<p>Array of indexes marking which values are are changed. Required for submit action.</p>",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : dirtyTexts

Type: array

Array of indexes marking which cell comments are changed.

Show Source

Array of: integer(int32)

{
    "type":"array",
    "description":"<p>Array of indexes marking which cell comments are changed.</p>",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : ranges

Type: array

Show Source

Array of: object GridRange

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

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GridRange"
    }
}

Nested Schema : GridRange

Type: object

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

Show Source

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: text
- 2: double
- 7: empty
values: array values

Cell values, in single-dimension format.

{
    "type":"object",
    "description":"<p>Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.</p>",
    "properties":{
        "statuses":{
            "type":"array",
            "description":"<p>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.</p>",
            "items":{
                "type":"string"
            }
        },
        "enumIds":{
            "type":"array",
            "description":"<p>(Internal use)</p>",
            "items":{
                "type":"string"
            }
        },
        "texts":{
            "type":"array",
            "description":"<p>Cell comments.</p>",
            "items":{
                "type":"string"
            }
        },
        "dataFormats":{
            "type":"array",
            "description":"<p>Data formats, if format strings are applied.</p>",
            "items":{
                "type":"string"
            }
        },
        "types":{
            "type":"array",
            "description":"<p>Data types of the cells. <ul><li><code>0</code>: text</li><li><code>2</code>: double</li><li><code>7</code>: empty</li></ul></p>",
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "end":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of elements in the grid range.</p>"
        },
        "start":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Start of the grid range. 0 by default.</p>"
        },
        "values":{
            "type":"array",
            "description":"<p>Cell values, in single-dimension format.</p>",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : dataFormats

Type: array

Data formats, if format strings are applied.

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>Data formats, if format strings are applied.</p>",
    "items":{
        "type":"string"
    }
}

Nested Schema : enumIds

Type: array

(Internal use)

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>(Internal use)</p>",
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Array of: string

{
    "type":"array",
    "description":"<p>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.</p>",
    "items":{
        "type":"string"
    }
}

Nested Schema : texts

Type: array

Cell comments.

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>Cell comments.</p>",
    "items":{
        "type":"string"
    }
}

Nested Schema : types

Type: array

Data types of the cells.

0: text
2: double
7: empty

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>Data types of the cells. <ul><li><code>0</code>: text</li><li><code>2</code>: double</li><li><code>7</code>: empty</li></ul></p>",
    "items":{
        "type":"string"
    }
}

Nested Schema : values

Type: array

Cell values, in single-dimension format.

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>Cell values, in single-dimension format.</p>",
    "items":{
        "type":"string"
    }
}

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 the default grid for the specified Essbase database.

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 the default grid for the Sample Basic cube to be returned in JSON format.

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/grid -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Response Grid

The response JSON describes the grid that is represented by the sample table.

-	Product	Market	Scenario
-	Measures	-	-
Year	105522	-	-

The alias table used in the grid is named Default. Each dimension of the cube is listed in the dimensions object. The slice object describes the number of columns and rows, and the position, values, and types of data cells. Data cell types are 0 for text, 2 for doubles, and 7 for empty.

{
  "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", "105522.0", "", "" ],
        "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", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}