List Grid Layouts
/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
-
application(required): string
Application name.
-
database(required): string
Database name.
Response
- application/json
- application/xml
200 Response
OK
List of layouts returned successfully.
400 Response
Bad Request
Failed to get layouts.
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
}