Jump to

• Request
• Response

Set Grid Preferences

put

/essbase/rest/v1/preferences/grid

Sets the grid preferences for the current session.

Request

Body ()

Grid preferences to be stored in the session.

Root Schema : Preferences

Type: object

Show Source

• cellText(optional): boolean
• columnSupression(optional): object ColumnSuppression
• formulaRetention(optional): object FormulaRetention
• includeDescriptionLabel(optional): boolean
• includeSelection(optional): boolean

  Display the selected member and the members retrieved as a result of the operation.

• indentation(optional): string
  Allowed Values: [ "NONE", "SUBITEMS", "TOTALS" ]

  How hierarchy levels are indented. NONE: No indentation. SUBITEMS: Indent descendants. Ancestors are left-justified in the column. TOTALS: Indent ancestors. Descendants are left-justified in the column.

• maxColumns(optional): integer(int64)
• maxRows(optional): integer(int64)
• missingText(optional): string

  The string displayed for cells that have no data value. Default is #Missing.

• navigate(optional): boolean
• noAccessText(optional): string

  The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.

• removeUnSelectedGroup(optional): boolean

  For Zoom In or Zoom Out, remove all dimensions and members except the selected member and the members retrieved as a result of zooming.

• repeatMemberLabels(optional): boolean

  Whether to repeat member labels in each row or column cell that represents a data point. Setting to true can help with legibility in large grids that require scrolling.

• rowSupression(optional): object RowSuppression
• withinSelectedGroup(optional): boolean

  Perform ad hoc operations only on the selected group of cells, leaving unselected cells as is. This setting is meaningful only when there are two or more dimensions down the grid as rows or across the grid as columns. For Zoom, Keep Only, and Remove Only.

• zoomIn(optional): object ZoomIn

{
    "type":"object",
    "properties":{
        "indentation":{
            "type":"string",
            "description":"<p>How hierarchy levels are indented. NONE: No indentation. SUBITEMS: Indent descendants. Ancestors are left-justified in the column. TOTALS: Indent ancestors. Descendants are left-justified in the column.</p>",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "navigate":{
            "type":"boolean"
        },
        "includeSelection":{
            "type":"boolean",
            "description":"<p>Display the selected member and the members retrieved as a result of the operation.</p>"
        },
        "repeatMemberLabels":{
            "type":"boolean",
            "description":"<p>Whether to repeat member labels in each row or column cell that represents a data point. Setting to true can help with legibility in large grids that require scrolling.</p>"
        },
        "withinSelectedGroup":{
            "type":"boolean",
            "description":"<p>Perform ad hoc operations only on the selected group of cells, leaving unselected cells as is. This setting is meaningful only when there are two or more dimensions down the grid as rows or across the grid as columns. For Zoom, Keep Only, and Remove Only.</p>"
        },
        "removeUnSelectedGroup":{
            "type":"boolean",
            "description":"<p>For Zoom In or Zoom Out, remove all dimensions and members except the selected member and the members retrieved as a result of zooming.</p>"
        },
        "includeDescriptionLabel":{
            "type":"boolean"
        },
        "missingText":{
            "type":"string",
            "description":"<p>The string displayed for cells that have no data value. Default is #Missing.</p>"
        },
        "noAccessText":{
            "type":"string",
            "description":"<p>The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.</p>"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        },
        "maxColumns":{
            "type":"integer",
            "format":"int64"
        },
        "rowSupression":{
            "$ref":"#/definitions/RowSuppression",
            "description":"<p>Row suppression options.</p>"
        },
        "columnSupression":{
            "$ref":"#/definitions/ColumnSuppression",
            "description":"<p>Column suppression options.</p>"
        },
        "cellText":{
            "type":"boolean"
        },
        "zoomIn":{
            "$ref":"#/definitions/ZoomIn",
            "description":"<p> Zoom-In options.</p>"
        },
        "maxRows":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : ColumnSuppression

Type: object

Show Source

• derived(optional): boolean

  Whether to suppress columns containing only data derived from a calculation.

• emptyBlocks(optional): boolean

  Whether to suppress columns containing only cells for which no data exists in the database.

• error(optional): boolean
• invalid(optional): boolean

  Whether to suppress columns that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.

• missing(optional): boolean

  Whether to suppress columns containing only #Missing values.

• noAccess(optional): boolean

  Whether to suppress columns containing only values that you do not have the security access to view.

• underScore(optional): boolean

  Whether to suppress columns that contain underscore characters in member names.

• zero(optional): boolean

  Whether to suppress columns that contain only zeroes.

{
    "type":"object",
    "properties":{
        "zero":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns that contain only zeroes.</p>"
        },
        "missing":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only #Missing values.</p>"
        },
        "underScore":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns that contain underscore characters in member names.</p>"
        },
        "derived":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only data derived from a calculation.</p>"
        },
        "noAccess":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only values that you do not have the security access to view.</p>"
        },
        "emptyBlocks":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only cells for which no data exists in the database.</p>"
        },
        "invalid":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.</p>"
        },
        "error":{
            "type":"boolean"
        }
    }
}

Nested Schema : FormulaRetention

Type: object

Show Source

• comments(optional): boolean
• fill(optional): boolean
• focus(optional): boolean
• retrive(optional): boolean
• zoom(optional): boolean

{
    "type":"object",
    "properties":{
        "comments":{
            "type":"boolean"
        },
        "zoom":{
            "type":"boolean"
        },
        "focus":{
            "type":"boolean"
        },
        "retrive":{
            "type":"boolean"
        },
        "fill":{
            "type":"boolean"
        }
    }
}

Nested Schema : RowSuppression

Type: object

Show Source

• derived(optional): boolean

  Whether to suppress rows containing only data derived from a calculation.

• emptyBlocks(optional): boolean

  Whether to suppress rows containing only cells for which no data exists in the database.

• error(optional): boolean
• invalid(optional): boolean

  Whether to suppress rows that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.

• missing(optional): boolean

  Whether to suppress rows containing only #Missing values.

• noAccess(optional): boolean

  Whether to suppress rows containing only values that you do not have the security access to view.

• underScore(optional): boolean

  Whether to suppress rows that contain underscore characters in member names.

• zero(optional): boolean

  Whether to suppress rows that contain only zeroes.

{
    "type":"object",
    "properties":{
        "zero":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows that contain only zeroes.</p>"
        },
        "missing":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only #Missing values.</p>"
        },
        "underScore":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows that contain underscore characters in member names.</p>"
        },
        "derived":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only data derived from a calculation.</p>"
        },
        "noAccess":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only values that you do not have the security access to view.</p>"
        },
        "emptyBlocks":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only cells for which no data exists in the database.</p>"
        },
        "invalid":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.</p>"
        },
        "error":{
            "type":"boolean"
        }
    }
}

Nested Schema : ZoomIn

Type: object

Show Source

• ancestor(optional): string
  Allowed Values: [ "TOP", "BOTTOM" ]
• mode(optional): string
  Allowed Values: [ "CHILDREN", "DESCENDENTS", "BASE" ]

{
    "type":"object",
    "properties":{
        "ancestor":{
            "type":"string",
            "enum":[
                "TOP",
                "BOTTOM"
            ]
        },
        "mode":{
            "type":"string",
            "enum":[
                "CHILDREN",
                "DESCENDENTS",
                "BASE"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Grid preferences set successfully.

400 Response

Bad Request

Failed to set grid preferences. The session may be invalid.

500 Response

Internal Server Error.

Back to Top