Update Grid Layout
put
/essbase/rest/v1/applications/{application}/databases/{database}/layouts/{layout}
Updates the layout with the provided details in the specified cube.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
application(required): string
Application name.
-
database(required): string
Database name.
-
layout(required): string
Layout name.
Query Parameters
-
user: string
User name.
Layout details to be updated.
Nested Schema : LayoutGrid
Type:
Show Source
object
-
alias:
string
The active alias table for the grid.
-
data:
object LayoutData
-
dimensions:
array dimensions
Nested Schema : LayoutPreferences
Type:
Show Source
object
-
cellText:
boolean
-
columnSuppression:
object Suppression
-
formulaRetention:
object FormulaRetention
-
includeDescriptionLabel:
boolean
-
includeSelection:
boolean
-
indentation:
string
Allowed Values:
[ "NONE", "SUBITEMS", "TOTALS" ]
-
maxRows:
integer(int32)
-
missingText:
string
- navigate: boolean
-
noAccessText:
string
The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.
-
removeUnSelectedGroup:
boolean
-
repeatMemberLabels:
boolean
-
rowSuppression:
object Suppression
-
withinSelectedGroup:
boolean
-
zoomIn:
object ZoomIn
Nested Schema : LayoutDimension
Type:
Show Source
object
-
axis:
string
Allowed Values:
[ "COLUMN", "ROW", "POV" ]
-
displayName:
string
-
expanded:
boolean
- hidden: boolean
-
name:
string
-
page:
integer(int32)
-
position:
integer(int32)
Nested Schema : ZoomIn
Type:
Show Source
object
-
ancestor:
string
Allowed Values:
[ "TOP", "BOTTOM" ]
-
mode:
string
Allowed Values:
[ "CHILDREN", "DESCENDENTS", "BASE" ]
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Layout updated successfully.
Nested Schema : LayoutGrid
Type:
Show Source
object
-
alias:
string
The active alias table for the grid.
-
data:
object LayoutData
-
dimensions:
array dimensions
Nested Schema : LayoutPreferences
Type:
Show Source
object
-
cellText:
boolean
-
columnSuppression:
object Suppression
-
formulaRetention:
object FormulaRetention
-
includeDescriptionLabel:
boolean
-
includeSelection:
boolean
-
indentation:
string
Allowed Values:
[ "NONE", "SUBITEMS", "TOTALS" ]
-
maxRows:
integer(int32)
-
missingText:
string
- navigate: boolean
-
noAccessText:
string
The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.
-
removeUnSelectedGroup:
boolean
-
repeatMemberLabels:
boolean
-
rowSuppression:
object Suppression
-
withinSelectedGroup:
boolean
-
zoomIn:
object ZoomIn
Nested Schema : LayoutDimension
Type:
Show Source
object
-
axis:
string
Allowed Values:
[ "COLUMN", "ROW", "POV" ]
-
displayName:
string
-
expanded:
boolean
- hidden: boolean
-
name:
string
-
page:
integer(int32)
-
position:
integer(int32)
Nested Schema : ZoomIn
Type:
Show Source
object
-
ancestor:
string
Allowed Values:
[ "TOP", "BOTTOM" ]
-
mode:
string
Allowed Values:
[ "CHILDREN", "DESCENDENTS", "BASE" ]
400 Response
Bad Request
Failed to update layout.