Mark Layout as Default
post
/essbase/rest/v1/applications/{application}/databases/{database}/layouts/{layout}/actions/markDefault
Marks a saved grid layout as the default grid view for this user or this cube. Requires Database Access permission to set the user default layout, and Database Manager permission to set the cube default layout.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
application: string
Application name.
-
database: string
Database name.
-
layout: string
Saved grid layout name.
User default or database default details.
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Layout successfully marked as default.
Nested Schema : LayoutGrid
Type:
Show Source
object
-
alias(optional):
string
The active alias table for the grid.
-
data(optional):
object LayoutData
-
dimensions(optional):
array dimensions
Nested Schema : LayoutPreferences
Type:
Show Source
object
-
cellText(optional):
boolean
-
columnSuppression(optional):
object Suppression
-
formulaRetention(optional):
object FormulaRetention
-
includeDescriptionLabel(optional):
boolean
-
includeSelection(optional):
boolean
-
indentation(optional):
string
Allowed Values:
[ "NONE", "SUBITEMS", "TOTALS" ]
-
maxRows(optional):
integer(int32)
-
missingText(optional):
string
- 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
-
repeatMemberLabels(optional):
boolean
-
rowSuppression(optional):
object Suppression
-
withinSelectedGroup(optional):
boolean
-
zoomIn(optional):
object ZoomIn
Nested Schema : LayoutDimension
Type:
Show Source
object
-
axis(optional):
string
Allowed Values:
[ "COLUMN", "ROW", "POV" ]
-
displayName(optional):
string
-
expanded(optional):
boolean
- hidden(optional): boolean
-
name(optional):
string
-
page(optional):
integer(int32)
-
position(optional):
integer(int32)
Nested Schema : ZoomIn
Type:
Show Source
object
-
ancestor(optional):
string
Allowed Values:
[ "TOP", "BOTTOM" ]
-
mode(optional):
string
Allowed Values:
[ "CHILDREN", "DESCENDENTS", "BASE" ]
400 Response
Bad Request
Failed to mark layout as user default or database default.