Jump to

• Request
• Response
• Examples

Get workbook details

get

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

Return details of an existing workbook with the given id. For example, details such as owner, name, description, id, last modfied date, object type, and parent id. Workbook 'content' is also returned if the 'content' is requested via the query parameter 'fields'.

Request

Path Parameters

• urlBase64WorkbookId(required): string
  Workbook id with Base64URL encoding. For example, if you have a workbook with id '/myuser/samplefolder/samplesales', enter the Base64URL encoded value 'L215dXNlci9zYW1wbGVmb2xkZXIvc2FtcGxlc2FsZXM='.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: object

400 Response

Invalid workbook encoded id

Body ()

Root Schema : 400BadRequest

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

403 Response

Not authorized to view workbook

Body ()

Root Schema : 403Forbidden

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

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

These examples show you how to return the details of a workbook with a given ID.

• Example 1 - No field criteria
• Example 2 - Multiple field criteria

Example 1 - No field criteria

In this example, you return all details of an existing workbook with the given ID without specifying fields to return. Listing no fields returns all details except for content. 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.

cURL Example:

curl    --header 'Authorization: Bearer <token>'    \
         --request GET 'https://<hostname>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s'

Example of Request Body

Not applicable.

Example of Response Body

{   
    "owner": "smith",    
    "name": "/shared/Sales/MySalesWorkbook",
    "description": "Sales Workbook",
    "id": "L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "last modified": "2025-01-01T19:53:07Z",
    "type": "workbooks",
    "parent": "L3NoYXJlZC9TYWxlcy8",
}

Example 2 - Multiple fields specified

In this example, you return the specified details of an existing workbook with the given ID. Which details are returned is determined by listed fields after ?fields=, in this case workbook, name, description, and content details.

cURL Example:

curl    --header 'Authorization: Bearer <token>'    \
         --request GET 'https://<hostname>/api/20210901/catalog/workbooks/L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s?fields=id,name,description,content'

Example of Request Body

Not applicable.

Example of Response Body

{   
    "id": "L3NoYXJlZC9TYWxlcy9NeVNhbGVzV29ya2Jvb2s",
    "name": "/shared/Sales/MySalesWorkbook",
    "description": "Sales Workbook",
    "content": {
        "json": { //workbook JSON object
            ....
      }
   }
}

Back to Top