Jump to

• Request
• Response
• Examples

List Layouts

get

/essbase/rest/v1/applications/{application}/databases/{database}/layouts

Lists the available saved grid layouts. If you are a service administrator, all saved layouts are listed, including those created by other users.

A layout is a saved grid shape associated with a cube. If you create a grid that you would like to use again in the future, you can save it as a Layout. Layouts and reports are included when the cube is copied or moved using migration, export, and Lifecycle Mangement (LCM) tools.

Request

Path Parameters

• application: string

  Application name.

• database: string

  Database name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

List of layouts returned successfully.

Body ()

Root Schema : Layouts

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutMetadata"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object LayoutMetadata

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : LayoutMetadata

Type: object

Show Source

• dbDefault(optional): boolean
• links(optional): array links
• name(optional): string
• user(optional): string
• userDefault(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "user":{
            "type":"string"
        },
        "userDefault":{
            "type":"boolean"
        },
        "dbDefault":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get layouts.

Back to Top

Examples

The following example shows how to retrieve a list of Essbase named layouts associated with the cube.

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/layouts?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "items" : [ {
    "name" : "Q1ColaSalesNY",
    "user" : "admin",
    "userDefault" : false,
    "dbDefault" : false
  }, {
    "name" : "Q2ColaSalesNY",
    "user" : "admin",
    "userDefault" : false,
    "dbDefault" : false
  } ],
  "count" : 2,
  "totalResults" : 2
}

Back to Top