DataLens API: 🚧 [Experimental] Update dashboard
HTTP request
POST https://api.datalens.tech/rpc/updateDashboard
Body parameters
Request schema: application/json
{
"entry": {
"entryId": "string",
"data": {
"counter": "integer",
"salt": "string",
"schemeVersion": "number",
"tabs": [
{
"id": "string",
"title": "string",
"items": [
{
"<allOf>": [
{
"id": "string",
"namespace": "string",
"type": "string"
},
"unknown"
]
}
],
"layout": [
{
"i": "string",
"h": "number",
"w": "number",
"x": "number",
"y": "number",
"parent": "string"
}
],
"connections": [
{
"from": "string",
"to": "string",
"kind": "string"
}
],
"aliases": {
"default": [
"array"
]
}
}
],
"settings": {
"autoupdateInterval": "unknown",
"maxConcurrentRequests": "unknown",
"loadPriority": "string",
"silentLoading": "boolean",
"dependentSelectors": "boolean",
"globalParams": {
"string": "unknown"
},
"hideTabs": "boolean",
"hideDashTitle": "boolean",
"expandTOC": "boolean",
"assistantEnabled": "boolean"
},
"supportDescription": "string",
"accessDescription": "string"
},
"meta": "object | null",
"revId": "string",
"annotation": {
"description": "string"
}
},
"mode": "string"
}
|
Field |
Description |
|
entry |
Required field. |
|
mode |
enum Required field.
|
Entry
|
Field |
Description |
|
entryId |
string Required field. |
|
data |
Required field. |
|
meta |
object | null Required field. |
|
revId |
string |
|
annotation |
Required field. |
Data
|
Field |
Description |
|
counter |
integer Required field. |
|
salt |
string Required field. |
|
schemeVersion |
enum Required field.
|
|
tabs[] |
Required field. |
|
settings |
Required field. |
|
supportDescription |
string |
|
accessDescription |
string |
TabsItem
|
Field |
Description |
|
id |
string Required field. |
|
title |
string Required field. |
|
items[] |
unknown Required field. |
|
layout[] |
Required field. |
|
connections[] |
Required field. |
|
aliases |
Required field. |
LayoutItem
|
Field |
Description |
|
i |
string Required field. |
|
h |
number Required field. |
|
w |
number Required field. |
|
x |
number Required field. |
|
y |
number Required field. |
|
parent |
string |
ConnectionsItem
|
Field |
Description |
|
from |
string Required field. |
|
to |
string Required field. |
|
kind |
enum Required field.
|
Aliases
|
Field |
Description |
|
default[] |
string |
Settings
|
Field |
Description |
|
autoupdateInterval |
Any of number | null | null |
|
maxConcurrentRequests |
Any of number | null | null |
|
loadPriority |
enum
|
|
silentLoading |
boolean Required field. |
|
dependentSelectors |
boolean Required field. |
|
globalParams |
object (map<string, unknown>) |
|
hideTabs |
boolean Required field. |
|
hideDashTitle |
boolean |
|
expandTOC |
boolean Required field. |
|
assistantEnabled |
boolean |
Annotation
|
Field |
Description |
|
description |
string Required field. |
Response
HTTP Code: 200
Response
Response schema: application/json
{
"entry": {
"annotation": "object | null",
"createdAt": "string",
"createdBy": "string",
"data": {
"counter": "integer",
"salt": "string",
"schemeVersion": "number",
"tabs": [
{
"id": "string",
"title": "string",
"items": [
{
"<allOf>": [
{
"id": "string",
"namespace": "string",
"type": "string"
},
"unknown"
]
}
],
"layout": [
{
"i": "string",
"h": "number",
"w": "number",
"x": "number",
"y": "number",
"parent": "string"
}
],
"connections": [
{
"from": "string",
"to": "string",
"kind": "string"
}
],
"aliases": {
"default": [
"array"
]
}
}
],
"settings": {
"autoupdateInterval": "unknown",
"maxConcurrentRequests": "unknown",
"loadPriority": "string",
"silentLoading": "boolean",
"dependentSelectors": "boolean",
"globalParams": {
"string": "unknown"
},
"hideTabs": "boolean",
"hideDashTitle": "boolean",
"expandTOC": "boolean",
"assistantEnabled": "boolean"
},
"supportDescription": "string",
"accessDescription": "string"
},
"entryId": "string",
"hidden": "boolean",
"key": "unknown",
"links": "object | null",
"meta": "object | null",
"public": "boolean",
"publishedId": "string | null",
"revId": "string",
"savedId": "string",
"scope": "string",
"tenantId": "string",
"type": "string",
"updatedAt": "string",
"updatedBy": "string",
"version": "number",
"workbookId": "unknown"
}
}
|
Field |
Description |
|
entry |
Required field. |
Entry
|
Field |
Description |
|
annotation |
object | null |
|
createdAt |
string Required field. |
|
createdBy |
string Required field. |
|
data |
Required field. |
|
entryId |
string Required field. |
|
hidden |
boolean Required field. |
|
key |
Any of null | string | null |
|
links |
object | null |
|
meta |
object | null Required field. |
|
public |
boolean Required field. |
|
publishedId |
string | null Required field. |
|
revId |
string Required field. |
|
savedId |
string Required field. |
|
scope |
enum Required field.
|
|
tenantId |
string Required field. |
|
type |
enum Required field.
|
|
updatedAt |
string Required field. |
|
updatedBy |
string Required field. |
|
version |
enum Required field.
|
|
workbookId |
Any of null | string | null |
Data
|
Field |
Description |
|
counter |
integer Required field. |
|
salt |
string Required field. |
|
schemeVersion |
enum Required field.
|
|
tabs[] |
Required field. |
|
settings |
Required field. |
|
supportDescription |
string |
|
accessDescription |
string |
TabsItem
|
Field |
Description |
|
id |
string Required field. |
|
title |
string Required field. |
|
items[] |
unknown Required field. |
|
layout[] |
Required field. |
|
connections[] |
Required field. |
|
aliases |
Required field. |
LayoutItem
|
Field |
Description |
|
i |
string Required field. |
|
h |
number Required field. |
|
w |
number Required field. |
|
x |
number Required field. |
|
y |
number Required field. |
|
parent |
string |
ConnectionsItem
|
Field |
Description |
|
from |
string Required field. |
|
to |
string Required field. |
|
kind |
enum Required field.
|
Aliases
|
Field |
Description |
|
default[] |
string |
Settings
|
Field |
Description |
|
autoupdateInterval |
Any of number | null | null |
|
maxConcurrentRequests |
Any of number | null | null |
|
loadPriority |
enum
|
|
silentLoading |
boolean Required field. |
|
dependentSelectors |
boolean Required field. |
|
globalParams |
object (map<string, unknown>) |
|
hideTabs |
boolean Required field. |
|
hideDashTitle |
boolean |
|
expandTOC |
boolean Required field. |
|
assistantEnabled |
boolean |