Jump to

• Request
• Response
• Examples

Get canvases

post

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

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

Request

Path Parameters

• id(required): string
  Catalog item ID in base64url format.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: string

Allowed Values: [ "" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : WorkbookCanvases

Type: object

Show Source

• presentCanvases: array presentCanvases
• visualizeCanvases: array visualizeCanvases

{
    "type":"object",
    "properties":{
        "visualizeCanvases":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkbookVisualizeCanvas"
            }
        },
        "presentCanvases":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/WorkbookPresentCanvas"
            }
        }
    }
}

Nested Schema : presentCanvases

Type: array

Show Source

• Array of: WorkbookPresentCanvas

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkbookPresentCanvas"
    }
}

Nested Schema : visualizeCanvases

Type: array

Show Source

• Array of: object WorkbookCanvas

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WorkbookVisualizeCanvas"
    }
}

Nested Schema : WorkbookPresentCanvas

Match All

Show Source

• object WorkbookCanvas
• object WorkbookPresentCanvas-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkbookCanvas"
        },
        {
            "type":"object",
            "properties":{
                "visualizeCanvasId":{
                    "type":"string",
                    "description":"Visualize canvas ID."
                },
                "isEnabled":{
                    "type":"string",
                    "description":"Indicates whether this canvas is enabled."
                }
            }
        }
    ]
}

Nested Schema : WorkbookCanvas

Type: object

Show Source

• canvasId: string
  Canvas ID.
• canvasName: string
  Canvas name.

{
    "type":"object",
    "properties":{
        "canvasId":{
            "type":"string",
            "description":"Canvas ID."
        },
        "canvasName":{
            "type":"string",
            "description":"Canvas name."
        }
    }
}

Nested Schema : WorkbookPresentCanvas-allOf[1]

Type: object

Show Source

• isEnabled: string
  Indicates whether this canvas is enabled.
• visualizeCanvasId: string
  Visualize canvas ID.

{
    "type":"object",
    "properties":{
        "visualizeCanvasId":{
            "type":"string",
            "description":"Visualize canvas ID."
        },
        "isEnabled":{
            "type":"string",
            "description":"Indicates whether this canvas is enabled."
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

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