Jump to

• Request
• Response

Update 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: string

  Application name.

• database: string

  Database name.

• layout: string

  Layout name.

Query Parameters

• user(optional): string

  User name.

Body ()

Layout details to be updated.

Root Schema : Layout

Type: object

Show Source

• header(optional): object LayoutHeader
• spec(optional): object LayoutSpec

{
    "type":"object",
    "properties":{
        "header":{
            "$ref":"#/definitions/LayoutHeader",
            "description":"<p>Header information about the layout. Includes its name, the user who created it, whether it is the default layout for the cube, and whether it is the default layout for this user.</p>"
        },
        "spec":{
            "$ref":"#/definitions/LayoutSpec",
            "description":"<p>Layout specification object containing information about the dimensions and data in the layout.</p>"
        }
    }
}

Nested Schema : LayoutHeader

Type: object

Show Source

• databaseDefault(optional): boolean
• name(optional): string
• session(optional): boolean
• user(optional): string
• userDefault(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "user":{
            "type":"string"
        },
        "databaseDefault":{
            "type":"boolean"
        },
        "userDefault":{
            "type":"boolean"
        },
        "session":{
            "type":"boolean"
        }
    }
}

Nested Schema : LayoutSpec

Type: object

Show Source

• description(optional): string
• grid(optional): object LayoutGrid
• preferences(optional): object LayoutPreferences

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "grid":{
            "$ref":"#/definitions/LayoutGrid"
        },
        "preferences":{
            "$ref":"#/definitions/LayoutPreferences"
        }
    }
}

Nested Schema : LayoutGrid

Type: object

Show Source

• alias(optional): string

  The active alias table for the grid.

• data(optional): object LayoutData
• dimensions(optional): array dimensions

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutDimension"
            }
        },
        "data":{
            "$ref":"#/definitions/LayoutData"
        }
    }
}

Nested Schema : LayoutPreferences

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "indentation":{
            "type":"string",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "rowSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "columnSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "cellText":{
            "type":"boolean"
        },
        "zoomIn":{
            "$ref":"#/definitions/ZoomIn"
        },
        "navigate":{
            "type":"boolean"
        },
        "includeSelection":{
            "type":"boolean"
        },
        "repeatMemberLabels":{
            "type":"boolean"
        },
        "withinSelectedGroup":{
            "type":"boolean"
        },
        "removeUnSelectedGroup":{
            "type":"boolean"
        },
        "includeDescriptionLabel":{
            "type":"boolean"
        },
        "missingText":{
            "type":"string"
        },
        "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>"
        },
        "maxRows":{
            "type":"integer",
            "format":"int32"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        }
    }
}

Nested Schema : LayoutData

Type: object

Show Source

• dataFormats(optional): array dataFormats
• enumIds(optional): array enumIds
• filters(optional): array filters
• statuses(optional): array statuses
• texts(optional): array texts
• types(optional): array types
• values(optional): array values

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "texts":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "dataFormats":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statuses":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "enumIds":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : dimensions

Type: array

Show Source

• Array of: object LayoutDimension

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

Nested Schema : dataFormats

Type: array

Show Source

• Array of: array items

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

Nested Schema : enumIds

Type: array

Show Source

• Array of: array items

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

Nested Schema : filters

Type: array

Show Source

• Array of: array items

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

Nested Schema : statuses

Type: array

Show Source

• Array of: array items

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

Nested Schema : texts

Type: array

Show Source

• Array of: array items

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

Nested Schema : types

Type: array

Show Source

• Array of: array items

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

Nested Schema : values

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : LayoutDimension

Type: object

Show Source

• 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)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "page":{
            "type":"integer",
            "format":"int32"
        },
        "hidden":{
            "type":"boolean"
        },
        "expanded":{
            "type":"boolean"
        },
        "axis":{
            "type":"string",
            "enum":[
                "COLUMN",
                "ROW",
                "POV"
            ]
        },
        "position":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Suppression

Type: object

Show Source

• derived(optional): boolean
• emptyBlocks(optional): boolean
• error(optional): boolean
• invalid(optional): boolean
• missing(optional): boolean
• noAccess(optional): boolean
• underScore(optional): boolean
• zero(optional): boolean

{
    "type":"object",
    "properties":{
        "missing":{
            "type":"boolean"
        },
        "invalid":{
            "type":"boolean"
        },
        "derived":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "underScore":{
            "type":"boolean"
        },
        "noAccess":{
            "type":"boolean"
        },
        "emptyBlocks":{
            "type":"boolean"
        },
        "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 : 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

Layout updated successfully.

Body ()

Root Schema : Layout

Type: object

Show Source

• header(optional): object LayoutHeader
• spec(optional): object LayoutSpec

{
    "type":"object",
    "properties":{
        "header":{
            "$ref":"#/definitions/LayoutHeader",
            "description":"<p>Header information about the layout. Includes its name, the user who created it, whether it is the default layout for the cube, and whether it is the default layout for this user.</p>"
        },
        "spec":{
            "$ref":"#/definitions/LayoutSpec",
            "description":"<p>Layout specification object containing information about the dimensions and data in the layout.</p>"
        }
    }
}

Nested Schema : LayoutHeader

Type: object

Show Source

• databaseDefault(optional): boolean
• name(optional): string
• session(optional): boolean
• user(optional): string
• userDefault(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "user":{
            "type":"string"
        },
        "databaseDefault":{
            "type":"boolean"
        },
        "userDefault":{
            "type":"boolean"
        },
        "session":{
            "type":"boolean"
        }
    }
}

Nested Schema : LayoutSpec

Type: object

Show Source

• description(optional): string
• grid(optional): object LayoutGrid
• preferences(optional): object LayoutPreferences

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "grid":{
            "$ref":"#/definitions/LayoutGrid"
        },
        "preferences":{
            "$ref":"#/definitions/LayoutPreferences"
        }
    }
}

Nested Schema : LayoutGrid

Type: object

Show Source

• alias(optional): string

  The active alias table for the grid.

• data(optional): object LayoutData
• dimensions(optional): array dimensions

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutDimension"
            }
        },
        "data":{
            "$ref":"#/definitions/LayoutData"
        }
    }
}

Nested Schema : LayoutPreferences

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "indentation":{
            "type":"string",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "rowSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "columnSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "cellText":{
            "type":"boolean"
        },
        "zoomIn":{
            "$ref":"#/definitions/ZoomIn"
        },
        "navigate":{
            "type":"boolean"
        },
        "includeSelection":{
            "type":"boolean"
        },
        "repeatMemberLabels":{
            "type":"boolean"
        },
        "withinSelectedGroup":{
            "type":"boolean"
        },
        "removeUnSelectedGroup":{
            "type":"boolean"
        },
        "includeDescriptionLabel":{
            "type":"boolean"
        },
        "missingText":{
            "type":"string"
        },
        "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>"
        },
        "maxRows":{
            "type":"integer",
            "format":"int32"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        }
    }
}

Nested Schema : LayoutData

Type: object

Show Source

• dataFormats(optional): array dataFormats
• enumIds(optional): array enumIds
• filters(optional): array filters
• statuses(optional): array statuses
• texts(optional): array texts
• types(optional): array types
• values(optional): array values

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "texts":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "dataFormats":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statuses":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "enumIds":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : dimensions

Type: array

Show Source

• Array of: object LayoutDimension

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

Nested Schema : dataFormats

Type: array

Show Source

• Array of: array items

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

Nested Schema : enumIds

Type: array

Show Source

• Array of: array items

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

Nested Schema : filters

Type: array

Show Source

• Array of: array items

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

Nested Schema : statuses

Type: array

Show Source

• Array of: array items

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

Nested Schema : texts

Type: array

Show Source

• Array of: array items

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

Nested Schema : types

Type: array

Show Source

• Array of: array items

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

Nested Schema : values

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

Nested Schema : LayoutDimension

Type: object

Show Source

• 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)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "page":{
            "type":"integer",
            "format":"int32"
        },
        "hidden":{
            "type":"boolean"
        },
        "expanded":{
            "type":"boolean"
        },
        "axis":{
            "type":"string",
            "enum":[
                "COLUMN",
                "ROW",
                "POV"
            ]
        },
        "position":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Suppression

Type: object

Show Source

• derived(optional): boolean
• emptyBlocks(optional): boolean
• error(optional): boolean
• invalid(optional): boolean
• missing(optional): boolean
• noAccess(optional): boolean
• underScore(optional): boolean
• zero(optional): boolean

{
    "type":"object",
    "properties":{
        "missing":{
            "type":"boolean"
        },
        "invalid":{
            "type":"boolean"
        },
        "derived":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "underScore":{
            "type":"boolean"
        },
        "noAccess":{
            "type":"boolean"
        },
        "emptyBlocks":{
            "type":"boolean"
        },
        "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 : 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"
            ]
        }
    }
}

400 Response

Bad Request

Failed to update layout.

Back to Top