Written by

Get workbooks list

Returns a list of workbooks.

Request

POST

https://api.datalens.tech/rpc/getWorkbooksList

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

Body

application/json

{
  "collectionId": "example",
  "includePermissionsInfo": true,
  "filterString": "example",
  "page": 0.5,
  "pageSize": 0.5,
  "orderField": "title",
  "orderDirection": "asc",
  "onlyMy": true
}

Name	Description
collectionId	Type: string \| null Filter workbooks by collection ID. Example: `example`
filterString	Type: string Filter workbooks by title. Example: `example`
includePermissionsInfo	Type: boolean Include permission information in the response.
onlyMy	Type: boolean Return only workbooks created by the current user.
orderDirection	Type: string Workbook sorting direction. Enum: `asc`, `desc`
orderField	Type: string Field to order workbooks by. Enum: `title`, `createdAt`, `updatedAt`
page	Type: number Page number for pagination.
pageSize	Type: number Number of workbooks per page.

Responses

200 OK

Response

Body

application/json

{
  "workbooks": [
    {
      "workbookId": "example",
      "collectionId": "example",
      "title": "example",
      "description": "example",
      "tenantId": "example",
      "meta": {
        "importId": "example"
      },
      "createdBy": "example",
      "createdAt": "example",
      "updatedBy": "example",
      "updatedAt": "example",
      "status": "creating",
      "permissions": {
        "listAccessBindings": true,
        "updateAccessBindings": true,
        "limitedView": true,
        "view": true,
        "update": true,
        "copy": true,
        "move": true,
        "publish": true,
        "embed": true,
        "delete": true
      }
    }
  ],
  "nextPageToken": "example"
}

Name

Description

workbooks

Type: object[]

collectionId

Type: string | null

ID of the collection the workbook belongs to.

Example: example

createdAt

Type: string

Creation timestamp.

Example: example

createdBy

Type: string

ID of the user who created the workbook.

Example: example

description

Type: string | null

Description of the workbook.

Example: example

meta

All of 2 types

Type: object

importId

Type: string

ID of the workbook import operation.

Example: example
Example
```
{
  "importId": "example"
}
```
Type: object

[additional]

Type: unknown

Example: null
Example
```
{}
```

Metadata associated with the workbook.

Example

{
  "importId": "example"
}

tenantId

Type: string

ID of the DataLens tenant.

Example: example

title

Type: string

Title of the workbook.

Example: example

updatedAt

Type: string

Last update timestamp.

Example: example

updatedBy

Type: string

ID of the user who last updated the workbook.

Example: example

workbookId

Type: string

Unique identifier of the workbook.

Example: example

permissions

Type: object

copy	Type: boolean Indicates if the workbook can be copied.
delete	Type: boolean Indicates if the workbook can be deleted.
embed	Type: boolean Indicates if entries in the workbook can be embedded.
limitedView	Type: boolean Indicates if the workbook can be viewed with limited access.
listAccessBindings	Type: boolean Indicates if access bindings for the workbook can be listed.
move	Type: boolean Indicates if the workbook can be moved.
publish	Type: boolean Indicates if entries in the workbook can be published.
update	Type: boolean Indicates if the workbook can be updated.
updateAccessBindings	Type: boolean Indicates if access bindings for the workbook can be updated.
view	Type: boolean Indicates if the workbook can be viewed.

Permissions for the workbook.

Example

{
  "listAccessBindings": true,
  "updateAccessBindings": true,
  "limitedView": true,
  "view": true,
  "update": true,
  "copy": true,
  "move": true,
  "publish": true,
  "embed": true,
  "delete": true
}

status

Type: string

Status of the workbook.

Enum: creating, deleting, active, deleted

List of workbooks.

Example

[
  {
    "workbookId": "example",
    "collectionId": "example",
    "title": "example",
    "description": "example",
    "tenantId": "example",
    "meta": {
      "importId": "example"
    },
    "createdBy": "example",
    "createdAt": "example",
    "updatedBy": "example",
    "updatedAt": "example",
    "status": "creating",
    "permissions": {
      "listAccessBindings": true,
      "updateAccessBindings": true,
      "limitedView": true,
      "view": true,
      "update": true,
      "copy": true,
      "move": true,
      "publish": true,
      "embed": true,
      "delete": true
    }
  }
]

nextPageToken

Type: string

Token for retrieving the next page of results.

Example: example

Get workbooks list

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

Was the article helpful?

Request

Headers

Body

Responses

200 OK

Body