Jump to

• Request
• Response
• Examples

Download workbook export

get

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

Download the exported PDF or PNG output created by workbook export.

Request

Path Parameters

• exportId(required): string
  Export ID. Also called work request ID. Response from Export workbook canvas API.
• urlBase64WorkbookId(required): string
  Workbook ID encoded as a Base64 value.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• image/png
• application/pdf

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: string(binary)

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

This example shows you how to get the ouput of a given export ID. Export IDs are the same value the as work request IDs obtained as a response when exporting a workbook canvas.

Example - Get PDF Output for a Given Export ID

In this example, you get the output of a PDF from a workbook with the given object and export ID. 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.

The export ID in this example is biwj-J2NwOjY1OCcuJ2NlOjM4ODEn. You obtain the export ID as a work request ID in the response from Export workbook canvas.

cURL Example:

curl    --header 'Authorization: Bearer <token>'    
         --request GET 'http://<hostname>:<port>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s/exports/{export-id}'

Example of Request Body

Not applicable.

Example of Response Body

Response of binary data. Response would contain metadata headers for the type of file (PDF/PNG).

Back to Top