Jump to

• Request
• Response
• Examples

Execute Grid Operation

post

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

Returns the grid for specified operation. Supported grid operations are Zoom In (zoomin), Zoom Out (zoomout), Refresh (refresh), Keep Only (keeponly), Remove Only (removeonly), Submit (submit), Pivot (pivot), and Pivot To POV (pivotToPOV).

Request

Path Parameters

• applicationName: string

  Application name for grid operation.

• databaseName: string

  Database/Cube name for grid operation.

Body ()

Grid Operation to be performed.

Root Schema : GridOperation

Type: object

Grid operation to perform, specifying the grid, action, coordinates, and ranges.

Show Source

• action(optional): string
  Allowed Values: [ "ZOOMIN", "ZOOMOUT", "KEEPONLY", "REMOVEONLY", "REFRESH", "PIVOT", "PIVOTTOPOV", "SUBMIT" ]

  Type of action to perform on the grid.

• alias(optional): string

  The active alias table for the grid.

• coordinates(optional): array coordinates

  Coordinates array for grid operation. Specify using syntax "coordinates": [index], where index describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.

• grid(optional): object Grid
• ranges(optional): array ranges

  Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: "ranges": [rowNo,colNo,noOfRows,noOfCols], where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.

{
    "type":"object",
    "description":"<p>Grid operation to perform, specifying the grid, action, coordinates, and ranges.</p>",
    "properties":{
        "grid":{
            "$ref":"#/definitions/Grid",
            "description":"<p>Grid object containing dimensions, the position of each dimension, and the slice consisting of data.</p>"
        },
        "action":{
            "type":"string",
            "description":"<p>Type of action to perform on the grid.</p>",
            "enum":[
                "ZOOMIN",
                "ZOOMOUT",
                "KEEPONLY",
                "REMOVEONLY",
                "REFRESH",
                "PIVOT",
                "PIVOTTOPOV",
                "SUBMIT"
            ]
        },
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "coordinates":{
            "type":"array",
            "description":"<p>Coordinates array for grid operation. Specify using syntax <code>\"coordinates\": [<i>index</i>]</code>, where <i>index</i> describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.</p>",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "ranges":{
            "type":"array",
            "description":"<p>Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: <code>\"ranges\": [<i>rowNo</i>,<i>colNo</i>,<i>noOfRows</i>,<i>noOfCols</i>]</code>, where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.</p>",
            "items":{
                "type":"array",
                "items":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    }
}

Nested Schema : coordinates

Type: array

Coordinates array for grid operation. Specify using syntax "coordinates": [index], where index describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "description":"<p>Coordinates array for grid operation. Specify using syntax <code>\"coordinates\": [<i>index</i>]</code>, where <i>index</i> describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.</p>",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : Grid

Type: object

Show Source

• alias(optional): string

  The active alias table for the grid.

• dimensions(optional): array dimensions

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

• slice(optional): 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 : ranges

Type: array

Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: "ranges": [rowNo,colNo,noOfRows,noOfCols], where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.

Show Source

• Array of: array items

{
    "type":"array",
    "description":"<p>Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: <code>\"ranges\": [<i>rowNo</i>,<i>colNo</i>,<i>noOfRows</i>,<i>noOfCols</i>]</code>, where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.</p>",
    "items":{
        "type":"array",
        "items":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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(optional): integer(int32)

  Number of columns in the grid.

• data(optional): object Data
• dirtyCells(optional): array dirtyCells

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

• dirtyTexts(optional): array dirtyTexts

  Array of indexes marking which cell comments are changed.

• rows(optional): 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(optional): integer(int32)

  Column location of the dimension in the grid.

• displayName(optional): string
• expanded(optional): boolean
• hidden(optional): boolean
• name(optional): string

  Dimension name.

• pov(optional): string

  If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid.

• row(optional): 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(optional): 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(optional): array dataFormats

  Data formats, if format strings are applied.

• end(optional): integer(int32)

  Number of elements in the grid range.

• enumIds(optional): array enumIds

  (Internal use)

• filters(optional): array filters
• start(optional): integer(int32)

  Start of the grid range. 0 by default.

• statuses(optional): 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(optional): array texts

  Cell comments.

• types(optional): array types

  Data types of the cells.

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

• values(optional): 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"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Grid operation completed successfully.

Body ()

Root Schema : Grid

Type: object

Show Source

• alias(optional): string

  The active alias table for the grid.

• dimensions(optional): array dimensions

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

• slice(optional): 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(optional): integer(int32)

  Number of columns in the grid.

• data(optional): object Data
• dirtyCells(optional): array dirtyCells

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

• dirtyTexts(optional): array dirtyTexts

  Array of indexes marking which cell comments are changed.

• rows(optional): 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(optional): integer(int32)

  Column location of the dimension in the grid.

• displayName(optional): string
• expanded(optional): boolean
• hidden(optional): boolean
• name(optional): string

  Dimension name.

• pov(optional): string

  If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid.

• row(optional): 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(optional): 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(optional): array dataFormats

  Data formats, if format strings are applied.

• end(optional): integer(int32)

  Number of elements in the grid range.

• enumIds(optional): array enumIds

  (Internal use)

• filters(optional): array filters
• start(optional): integer(int32)

  Start of the grid range. 0 by default.

• statuses(optional): 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(optional): array texts

  Cell comments.

• types(optional): array types

  Data types of the cells.

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

• values(optional): 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

Failed to execute grid operation. The application name or database name may be incorrect or missing.

500 Response

Internal Server Error.

Back to Top

Examples

The following examples show how to perform Essbase grid operations.

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 sends a submit operation on the grid described in the input gridsubmit.json.

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

Examples of other operations you can execute as JSON objects will follow the Submit example.

• Submit Example
• Refresh Example
• Zoom In Example
• Zoom Out Example
• Keep Only Example
• Remove Only Example
• Pivot Example
• Pivot To POV Example

Submit Example

The following grid submit operation submits data value 1052 to ([Jan], [Sales], [Cola], [New York], [Actual]).

-	Cola	New York	Actual
-	Sales	-	-
Jan	1052	-	-

Input Grid for Submit

The input grid and action to send the submit operation are in gridsubmit.json, which looks like:

{
	"action": "submit",
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 0
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "Product"
			},
			{
				"name": "Market",
				"pov": "Market"
			},
			{
				"name": "Scenario",
				"pov": "Scenario"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"dirtyCells": [ 9 ],
			"data": {
				"ranges": [
					{
						"end": 11,
						"values": [ "", "100-10", "New York", "Actual", "", "Sales", "", "", "Jan", "1052", "", "" ],
						"types": [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ]
					}
				]
			}
		}
	}
}

The submit action requires a dirtyCells array. Specify one or indexes of changed values (where count starts with 0 for the first value in the values array). Use the syntax:

"dirtyCells": [index]

where the index argument describes the position of at least one cell that is changed by the submit operation. Multiple index arguments can be given in the array, separated by commas.

Response Grid for Submit

The resulting response written to out_gridsubmit.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" : "Cola",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "New York",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Actual",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "Cola", "New York", "Actual", "", "Sales", "", "", "Jan", "1052.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", "268435472", "402653200", "536870928", "0", "134217744", "0", "0", "16", "2", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

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.

Refresh Example

The following grid refresh operation returns to the default Sample Basic grid.

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

Input Grid for Refresh

The input grid and action to send the refresh operation are in gridrefresh.json, which looks like:

{
"action" : "refresh",
"grid": {
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "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 ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

Response Grid for Refresh

The resulting response grid 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", "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" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

Zoom In Example

The following grid zoom-in operation expands the Year dimension to analyze the quarters.

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

Input Grid for Zoom In

The input grid and action to send the zoom in operation are in gridzoomin.json, which looks like:

{
"action" : "zoomin",
"ranges": [[2,0,1,1]],
"grid": {
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "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 ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

The zoom in action requires a ranges object. Specify one or more ranges as an array using the syntax:

"ranges": [rowNo,colNo,noOfRows,noOfCols]

where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns. For example, in the default grid for Sample Basic,

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

if you want to zoom in on Year (coordinate 2,0), provide "ranges": [[2,0,1,1]] after the action. To zoom in on multiple cells at the same time, provide multiple ranges as shown: "ranges": [[2,0,1,1],[1,1,1,1]], which zooms in on both Year and Measures.

Response Grid for Zoom In

The resulting response grid 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" : 7,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 27,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "", "Year", "105522.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "135", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

Zoom Out Example

The following grid zoom-out operation collapses the quarters in the Year dimension so as to view only the year total again.

Input Grid for Zoom Out

The input grid and action to send the zoom out operation are in gridzoomout.json, which looks like:

{
"action" : "zoomout",
"ranges": [[2,0,1,1]],
"grid":
{
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 6,
    "data" : {
      "ranges" : [ {
        "end" : 23,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

The zoom out action requires a ranges object. Specify one or more ranges as an array using the syntax:

"ranges": [rowNo,colNo,noOfRows,noOfCols]

where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns. For example, in the following grid for Sample Basic,

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

if you want to zoom out on Qtr1 (coordinate 2,0), provide "ranges": [[2,0,1,1]] after the action. To zoom out on multiple cells at the same time, provide multiple ranges as shown: "ranges": [[2,0,1,1],[1,1,1,1]] (not applicable in this example, as Measures is already zoomed out).

Response Grid for Zoom Out

The resulting response grid is:

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

{
  "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" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

Keep Only Example

The following grid keep-only example removes all the quarters except for Qtr1 from the following grid:

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

Input Grid for Keep Only

The input grid and action to send the keep only operation are in gridkeeponly.json, which looks like:

{
"action" : "keeponly",
"ranges": [[2,0,1,1]],
"grid":
{
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 6,
    "data" : {
      "ranges" : [ {
        "end" : 23,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

Response Grid for Keep Only

The resulting response grid is:

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-

{
  "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", "", "", "Qtr1", "24703.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", "134", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

Remove Only Example

The following grid remove-only operation removes only Qtr1 from the Year dimension, in the following grid:

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

Input Grid for Remove Only

The input grid and action to send the remove-only operation are in gridremoveonly.json, which looks like:

{
"action" : "removeonly",
"ranges": [[2,0,1,1]],
"grid":
{
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 6,
    "data" : {
      "ranges" : [ {
        "end" : 23,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

Response Grid for Remove Only

The resulting response grid is:

-	Product	Market	Scenario
-	Measures	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

{
  "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" : 5,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 19,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

Pivot Example

The following grid pivot operation moves New York to rows. Pivot either moves columns to rows, or rows to columns. If you pivot a POV member, it moves to rows. The starting grid looks like:

-	Cola	New York	Actual
-	Sales	-	-
Jan	1052	-	-

Input Grid for Pivot

The input grid and action to send the pivot operation are in gridpivot.json, which looks like:

{
	"action": "pivot",
	"coordinates": [ 2 ],
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 0
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "Product"
			},
			{
				"name": "Market",
				"pov": "Market"
			},
			{
				"name": "Scenario",
				"pov": "Scenario"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"data": {
				"ranges": [ {
					"end": 11,
					"values": [ "", "100-10", "New York", "Actual", "", "Sales", "", "", "Jan", "1051", "", "" ],
					"types": [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ]
					}
				]
			}
		}
	}
}

The pivot action requires a coordinates array. Specify a coordinate as an array using the syntax:

"coordinates": [index]

where the index argument describes the cell position of the member to pivot, starting with 0 for the upper-left-most cell, and counting left to right, row by row.

Response Grid for Pivot

The resulting response grid is:

-	-	Cola	Actual
-	-	Sales	-
New York	Jan	1052	-

{
	"action": "pivot",
	"coordinates": [ 2 ],
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 0
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "Product"
			},
			{
				"name": "Market",
				"pov": "Market"
			},
			{
				"name": "Scenario",
				"pov": "Scenario"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"data": {
				"ranges": [ {
					"end": 11,
					"values": [ "", "100-10", "New York", "Actual", "", "Sales", "", "", "Jan", "1051", "", "" ],
					"types": [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ]
					}
				]
			}
		}
	}
}

Pivot to POV Example

The following grid moves New York back to POV, starting with the grid in the previous example.

Input Grid for Pivot to POV

The input grid and action to send the pivot-to-POV operation are in gridpivottopov.json, which looks like:

{
	"action": "pivotToPOV",
	"coordinates": [ 8, 2 ],
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 1
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "100-10"
			},
			{
				"name": "Market",
				"column": 0
			},
			{
				"name": "Scenario",
				"pov": "Actual"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"data": {
				"ranges": [
					{
						"end": 11,
						"values": [ "", "", "100-10", "Actual", "", "", "Sales", "", "New York", "Jan", "1051.0", "" ],
						"types": [ "7", "7", "0", "0", "7", "7", "0", "7", "0", "0", "2", "7" ],
						"texts": [ null, null, null, null, null, null, null, null, null, null, null, null ],
						"statuses": [ "0", "0", "268435472", "536870928", "0", "0", "134217744", "0", "402653200", "16", "2", "0" ],
						"enumIds": ["", "", "", "", "", "", "", "", "", "", "", "" ],
						"dataFormats": [ null, null, null, null, null, null, null, null, null, null, null, null ]
					}
				]
			}
		}
	}
}

Response Grid for Pivot to POV

The resulting response grid is:

-	New York	Cola	Actual
-	Sales	-	-
Jan	1052	-	-

{
  "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" : "Cola",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "New York",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Actual",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "New York", "Cola", "Actual", "", "Sales", "", "", "Jan", "1052.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", "402653200", "268435472", "536870928", "0", "134217744", "0", "0", "16", "2", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

Back to Top