DataLens API: Create workbook
HTTP request
POST https://api.datalens.tech/rpc/createWorkbook
Body parameters
Request schema: application/json
{
"collectionId": "string | null",
"title": "string",
"description": "string"
}
|
Field |
Description |
|
collectionId |
string | null |
|
title |
string Required field. |
|
description |
string |
Response
HTTP Code: 200
Response
Response schema: application/json
{
"workbookId": "string",
"collectionId": "string | null",
"title": "string",
"description": "string | null",
"tenantId": "string",
"meta": "unknown",
"createdBy": "string",
"createdAt": "string",
"updatedBy": "string",
"updatedAt": "string",
"status": "string",
"operation": {
"id": "string",
"description": "string",
"createdBy": "string",
"createdAt": {
"seconds": "string",
"nanos": "number"
},
"modifiedAt": {
"seconds": "string",
"nanos": "number"
},
"metadata": {},
"done": "boolean"
}
}
|
Field |
Description |
|
workbookId |
string Required field. |
|
collectionId |
string | null Required field. |
|
title |
string Required field. |
|
description |
string | null Required field. |
|
tenantId |
string Required field. |
|
meta |
All of Meta0 & object (map<string, unknown>) |
|
createdBy |
string Required field. |
|
createdAt |
string Required field. |
|
updatedBy |
string Required field. |
|
updatedAt |
string Required field. |
|
status |
enum
|
|
operation |
Required field. |
Meta0
|
Field |
Description |
|
importId |
string |
Operation
|
Field |
Description |
|
id |
string Required field. |
|
description |
string Required field. |
|
createdBy |
string Required field. |
|
createdAt |
Required field. |
|
modifiedAt |
Required field. |
|
metadata |
Required field. |
|
done |
boolean Required field. |
CreatedAt
|
Field |
Description |
|
seconds |
string Required field. |
|
nanos |
number |
ModifiedAt
|
Field |
Description |
|
seconds |
string Required field. |
|
nanos |
number |
Metadata
|
Field |
Description |
|
Empty |
|