Jump to

• Request
• Response
• Examples

Export workbook canvas

post

/api/20210901/catalog/workbooks/{urlBase64WorkbookId}/exports

Initiate an export of a workbook canvas to PDF or PNG. Returns a work request ID.

Request

Path Parameters

• urlBase64WorkbookId(required): string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object ExportBasePayload
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ExportBasePayload"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the output file."
                },
                "type":{
                    "type":"string",
                    "enum":[
                        "file"
                    ],
                    "description":"The type of the entity."
                },
                "format":{
                    "type":"string",
                    "enum":[
                        "pdf",
                        "png"
                    ],
                    "description":"The output format."
                },
                "canvasIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "description":"A list of canvas IDs."
                },
                "screenwidth":{
                    "type":"integer",
                    "description":"Browser screen width. Maximum width is 3600."
                },
                "screenheight":{
                    "type":"integer",
                    "description":"Browser screen height. Maximum height is 3600."
                }
            },
            "required":[
                "name",
                "type",
                "format",
                "canvasIds",
                "screenwidth",
                "screenheight"
            ]
        }
    ]
}

Nested Schema : ExportBasePayload

Type: object

Show Source

• format(required): string
  Allowed Values: [ "pdf", "png" ]

  The output format.
• name(required): string
  The name of the output file.
• type(required): string
  Allowed Values: [ "file" ]

  The type of the entity.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the output file."
        },
        "type":{
            "type":"string",
            "enum":[
                "file"
            ],
            "description":"The type of the entity."
        },
        "format":{
            "type":"string",
            "enum":[
                "pdf",
                "png"
            ],
            "description":"The output format."
        }
    },
    "required":[
        "name",
        "type",
        "format"
    ]
}

Nested Schema : type

Type: object

Show Source

• canvasIds(required): array canvasIds
  A list of canvas IDs.
• format(required): string
  Allowed Values: [ "pdf", "png" ]

  The output format.
• name(required): string
  The name of the output file.
• screenheight(required): integer
  Browser screen height. Maximum height is 3600.
• screenwidth(required): integer
  Browser screen width. Maximum width is 3600.
• type(required): string
  Allowed Values: [ "file" ]

  The type of the entity.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the output file."
        },
        "type":{
            "type":"string",
            "enum":[
                "file"
            ],
            "description":"The type of the entity."
        },
        "format":{
            "type":"string",
            "enum":[
                "pdf",
                "png"
            ],
            "description":"The output format."
        },
        "canvasIds":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"A list of canvas IDs."
        },
        "screenwidth":{
            "type":"integer",
            "description":"Browser screen width. Maximum width is 3600."
        },
        "screenheight":{
            "type":"integer",
            "description":"Browser screen height. Maximum height is 3600."
        }
    },
    "required":[
        "name",
        "type",
        "format",
        "canvasIds",
        "screenwidth",
        "screenheight"
    ]
}

Nested Schema : canvasIds

Type: array

A list of canvas IDs.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"A list of canvas IDs."
}

Back to Top

Response

202 Response

Asynchronous operation started.

Headers

• oa-work-request-id:

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"
    ]
}

412 Response

Precondition Failed. One or more preconditions are not satisfied for the operation to proceed.

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"
    ]
}

422 Response

Unprocessable Entity. Unable to proceed the operation, though the request entity was correct.

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

To export canvases from a workbook or PDF or PNG, you need to create a payload that contains the following information:

• name: The output file name.
• type: Output type. Type must be file.
• canvasIds: IDs of the canvases in the workbook. Maximum 5 canvases. Maximum length of a canvasId is 2000 characters.
• format: Output format. Format must be PDF or PNG.
• screenwidth: Browser screen width. Maximum width is 3600.
• screenheight: Browser screen height. Maximum height is 3600.

Here's an example JSON file, named payload.json:

{
    "name": "Monthly report",
    "type": "file",
    "canvasIds": ["snapshot!canvas!1", "snapshot!canvas!2"],
    "format": "pdf",
    "screenwidth": 1440,
    "screenheight": 900
}

Example - Request PDF Output from a Workbook with a JSON Payload

In this example, you request a PDF with two canvases from an existing workbook with the given ID using the JSON file payload.json. The object ID of the workbook is '/shared/Sales/MySalesWorkbook' which has the Base64URL-safe encoded ID value: L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s. You can get the ID of a workbook by using Get catalog items by type.

Successful operation returns a work request ID, which in the example response is biwj-J2MwOjQwOCcuJ2N3Ojc4NSc. You can check the status of your export request by passing the work request ID to Get a work request item. Work request IDs are also referred to as export IDs.

cURL Example:

curl    --header 'Authorization: Bearer <token>'    
            --header 'Content-Type: application/json'   
         --request POST 'http://<hostname>:<port>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/exports/
         --data @payload.json'

Example of Request Body

Not applicable.

Example of Response Body

{
    "resourceUri": "/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/exports/biwj-J2MwOjQwOCcuJ2N3Ojc4NSc"
}

Back to Top