Get canvases

post

/api/20210901/catalog/workbooks/{id}/actions/getCanvases

Get a list of canvases for workbook with a given ID.

Request

Path Parameters
Supported Media Types
Request Body - */* ()
Root Schema : schema
Type: string
Allowed Values: [ "" ]
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : WorkbookCanvases
Type: object
Show Source
Nested Schema : presentCanvases
Type: array
Show Source
Nested Schema : visualizeCanvases
Type: array
Show Source
Nested Schema : WorkbookPresentCanvas
Match All
Show Source
Nested Schema : WorkbookCanvas
Type: object
Show Source
Nested Schema : WorkbookPresentCanvas-allOf[1]
Type: object
Show Source

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).
Body ()
Root Schema : Error
Type: object
Show Source

401 Response

Unauthorized (missing or expired credentials, and so on).
Body ()
Root Schema : Error
Type: object
Show Source

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).
Body ()
Root Schema : Error
Type: object
Show Source

404 Response

Not Found. The requested resource was not found.
Body ()
Root Schema : Error
Type: object
Show Source

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top

Examples

In this example, you return the details of all canvases belonging to the specified workbook ID. The object ID of the workbook is '/shared/Sales/Sales Analysis' which has the Base64URL-safe encoded ID value: L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw. You can get the ID of a workbook by using Get catalog items by type.

cURL Example:

curl    --header 'Authorization: Bearer <token>'    \
         --request POST 'https://<hostname>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9TYWxlcyBBbmFseXNpcw/actions/getCanvases'

Example of Request Body

Not applicable.

Example of Response Body

{
    "visualizeCanvases": [
        {
            "canvasId": 1,
            "canvasName": "Sales by Product Category"
        }
    ],
    "presentCanvases": [
        {
            "canvasId": "snapshot!canvas!1",
            "visualizeCanvasId": 1,
            "isEnabled": true,
            "canvasName": "Sales by Product Category"
        }
    ]
}
Back to Top