DataLens API: 🚧 [Experimental] Update editor chart
- HTTP request
- Body parameters
- UpdateEditorTableNodeEntry
- Annotation
- Data
- UpdateEditorGravityChartsNodeEntry
- UpdateEditorMarkdownNodeEntry
- Data
- UpdateEditorAdvancedChartNodeEntry
- UpdateEditorSelectorNodeEntry
- Data
- Response
- EditorTableNode
- Data
- EditorGravityChartsNode
- EditorMarkdownNode
- Data
- EditorAdvancedChartNode
- EditorSelectorNode
- Data
Updates the specified Editor chart.
HTTP request
POST https://api.datalens.tech/rpc/updateEditorChart
Body parameters
Request schema: application/json
{
"mode": "string",
"entry": "unknown"
}
|
Field |
Description |
|
mode |
enum Required field.
|
|
entry |
One of UpdateEditorTableNodeEntry | UpdateEditorGravityChartsNodeEntry | UpdateEditorMarkdownNodeEntry | UpdateEditorAdvancedChartNodeEntry | UpdateEditorSelectorNodeEntry |
UpdateEditorTableNodeEntry
|
Field |
Description |
|
entryId |
string Required field. Unique identifier of the entry. |
|
revId |
string Version ID for the Editor chart. |
|
meta |
object (map<string, unknown>) Metadata associated with the entry. |
|
links |
object (map<string, string>) Link information. |
|
annotation |
Required field. Annotation information. |
|
type |
enum Required field. For Table Editor charts takes value:
|
|
data |
Required field. Chart data. |
Annotation
|
Field |
Description |
|
description |
string Required field. Description of annotation. |
Data
|
Field |
Description |
|
meta |
string Required field. Configuration from the Meta tab. |
|
params |
string Required field. Configuration from the Params tab. |
|
sources |
string Required field. Configuration from the Sources tab. |
|
controls |
string Required field. Configuration from the Controls tab. |
|
prepare |
string Required field. Configuration from the Prepare tab. |
|
config |
string Required field. Configuration from the Config tab. |
UpdateEditorGravityChartsNodeEntry
|
Field |
Description |
|
entryId |
string Required field. Unique identifier of the entry. |
|
revId |
string Version ID for the Editor chart. |
|
meta |
object (map<string, unknown>) Metadata associated with the entry. |
|
links |
object (map<string, string>) Link information. |
|
annotation |
Required field. Annotation information. |
|
type |
enum Required field. For D3 Editor charts takes value:
|
|
data |
Required field. Chart data. |
UpdateEditorMarkdownNodeEntry
|
Field |
Description |
|
entryId |
string Required field. Unique identifier of the entry. |
|
revId |
string Version ID for the Editor chart. |
|
meta |
object (map<string, unknown>) Metadata associated with the entry. |
|
links |
object (map<string, string>) Link information. |
|
annotation |
Required field. Annotation information. |
|
type |
enum Required field. For Markdown Editor charts takes value:
|
|
data |
Required field. Chart data. |
Data
|
Field |
Description |
|
meta |
string Required field. Configuration from the Meta tab. |
|
params |
string Required field. Configuration from the Params tab. |
|
sources |
string Required field. Configuration from the Sources tab. |
|
controls |
string Required field. Configuration from the Controls tab. |
|
prepare |
string Required field. Configuration from the Prepare tab. |
UpdateEditorAdvancedChartNodeEntry
|
Field |
Description |
|
entryId |
string Required field. Unique identifier of the entry. |
|
revId |
string Version ID for the Editor chart. |
|
meta |
object (map<string, unknown>) Metadata associated with the entry. |
|
links |
object (map<string, string>) Link information. |
|
annotation |
Required field. Annotation information. |
|
type |
enum Required field. For Advanced Editor charts takes value:
|
|
data |
Required field. Chart data. |
UpdateEditorSelectorNodeEntry
|
Field |
Description |
|
entryId |
string Required field. Unique identifier of the entry. |
|
revId |
string Version ID for the Editor chart. |
|
meta |
object (map<string, unknown>) Metadata associated with the entry. |
|
links |
object (map<string, string>) Link information. |
|
annotation |
Required field. Annotation information. |
|
type |
enum Required field. For Editor JS selectors takes value:
|
|
data |
Required field. Chart data. |
Data
|
Field |
Description |
|
meta |
string Required field. Configuration from the Meta tab. |
|
params |
string Required field. Configuration from the Params tab. |
|
sources |
string Required field. Configuration from the Sources tab. |
|
controls |
string Required field. Configuration from the Controls tab. |
Response
HTTP Code: 200
Response
Response schema: application/json
{
"entry": "unknown"
}
|
Field |
Description |
|
entry |
One of EditorTableNode | EditorGravityChartsNode | EditorMarkdownNode | EditorAdvancedChartNode | EditorSelectorNode |
EditorTableNode
|
Field |
Description |
|
version |
enum Required field. Editor version. Аvailable values:
|
|
entryId |
string Required field. Unique identifier of the entry. |
|
key |
Any of null | string | null Key identifier of the entry. |
|
createdAt |
string Required field. Creation timestamp. |
|
createdBy |
string Required field. Creator of the entry. |
|
updatedAt |
string Required field. Last update timestamp. |
|
updatedBy |
string Required field. Last updater of the entry. |
|
revId |
string Required field. Version ID for the Editor chart. |
|
savedId |
string Required field. Saved version ID. |
|
publishedId |
string | null Required field. Published version ID. |
|
tenantId |
string Required field. Tenant ID. |
|
hidden |
boolean Required field. Indicates if the entry is hidden. |
|
public |
boolean Required field. Indicates if the entry is public. |
|
workbookId |
Any of null | string | null ID of the workbook the Editor chart belongs to. |
|
scope |
enum Required field. Type of the entry. For charts takes value:
|
|
meta |
object | null Required field. Metadata associated with the entry. |
|
links |
object | null Link information. |
|
annotation |
object | null Annotation information. |
|
type |
enum Required field. For Table Editor charts takes value:
|
|
data |
Required field. Chart data. |
Data
|
Field |
Description |
|
meta |
string Required field. Configuration from the Meta tab. |
|
params |
string Required field. Configuration from the Params tab. |
|
sources |
string Required field. Configuration from the Sources tab. |
|
controls |
string Required field. Configuration from the Controls tab. |
|
prepare |
string Required field. Configuration from the Prepare tab. |
|
config |
string Required field. Configuration from the Config tab. |
EditorGravityChartsNode
|
Field |
Description |
|
version |
enum Required field. Editor version. Аvailable values:
|
|
entryId |
string Required field. Unique identifier of the entry. |
|
key |
Any of null | string | null Key identifier of the entry. |
|
createdAt |
string Required field. Creation timestamp. |
|
createdBy |
string Required field. Creator of the entry. |
|
updatedAt |
string Required field. Last update timestamp. |
|
updatedBy |
string Required field. Last updater of the entry. |
|
revId |
string Required field. Version ID for the Editor chart. |
|
savedId |
string Required field. Saved version ID. |
|
publishedId |
string | null Required field. Published version ID. |
|
tenantId |
string Required field. Tenant ID. |
|
hidden |
boolean Required field. Indicates if the entry is hidden. |
|
public |
boolean Required field. Indicates if the entry is public. |
|
workbookId |
Any of null | string | null ID of the workbook the Editor chart belongs to. |
|
scope |
enum Required field. Type of the entry. For charts takes value:
|
|
meta |
object | null Required field. Metadata associated with the entry. |
|
links |
object | null Link information. |
|
annotation |
object | null Annotation information. |
|
type |
enum Required field. For D3 Editor charts takes value:
|
|
data |
Required field. Chart data. |
EditorMarkdownNode
|
Field |
Description |
|
version |
enum Required field. Editor version. Аvailable values:
|
|
entryId |
string Required field. Unique identifier of the entry. |
|
key |
Any of null | string | null Key identifier of the entry. |
|
createdAt |
string Required field. Creation timestamp. |
|
createdBy |
string Required field. Creator of the entry. |
|
updatedAt |
string Required field. Last update timestamp. |
|
updatedBy |
string Required field. Last updater of the entry. |
|
revId |
string Required field. Version ID for the Editor chart. |
|
savedId |
string Required field. Saved version ID. |
|
publishedId |
string | null Required field. Published version ID. |
|
tenantId |
string Required field. Tenant ID. |
|
hidden |
boolean Required field. Indicates if the entry is hidden. |
|
public |
boolean Required field. Indicates if the entry is public. |
|
workbookId |
Any of null | string | null ID of the workbook the Editor chart belongs to. |
|
scope |
enum Required field. Type of the entry. For charts takes value:
|
|
meta |
object | null Required field. Metadata associated with the entry. |
|
links |
object | null Link information. |
|
annotation |
object | null Annotation information. |
|
type |
enum Required field. For Markdown Editor charts takes value:
|
|
data |
Required field. Chart data. |
Data
|
Field |
Description |
|
meta |
string Required field. Configuration from the Meta tab. |
|
params |
string Required field. Configuration from the Params tab. |
|
sources |
string Required field. Configuration from the Sources tab. |
|
controls |
string Required field. Configuration from the Controls tab. |
|
prepare |
string Required field. Configuration from the Prepare tab. |
EditorAdvancedChartNode
|
Field |
Description |
|
version |
enum Required field. Editor version. Аvailable values:
|
|
entryId |
string Required field. Unique identifier of the entry. |
|
key |
Any of null | string | null Key identifier of the entry. |
|
createdAt |
string Required field. Creation timestamp. |
|
createdBy |
string Required field. Creator of the entry. |
|
updatedAt |
string Required field. Last update timestamp. |
|
updatedBy |
string Required field. Last updater of the entry. |
|
revId |
string Required field. Version ID for the Editor chart. |
|
savedId |
string Required field. Saved version ID. |
|
publishedId |
string | null Required field. Published version ID. |
|
tenantId |
string Required field. Tenant ID. |
|
hidden |
boolean Required field. Indicates if the entry is hidden. |
|
public |
boolean Required field. Indicates if the entry is public. |
|
workbookId |
Any of null | string | null ID of the workbook the Editor chart belongs to. |
|
scope |
enum Required field. Type of the entry. For charts takes value:
|
|
meta |
object | null Required field. Metadata associated with the entry. |
|
links |
object | null Link information. |
|
annotation |
object | null Annotation information. |
|
type |
enum Required field. For Advanced Editor charts takes value:
|
|
data |
Required field. Chart data. |
EditorSelectorNode
|
Field |
Description |
|
version |
enum Required field. Editor version. Аvailable values:
|
|
entryId |
string Required field. Unique identifier of the entry. |
|
key |
Any of null | string | null Key identifier of the entry. |
|
createdAt |
string Required field. Creation timestamp. |
|
createdBy |
string Required field. Creator of the entry. |
|
updatedAt |
string Required field. Last update timestamp. |
|
updatedBy |
string Required field. Last updater of the entry. |
|
revId |
string Required field. Version ID for the Editor chart. |
|
savedId |
string Required field. Saved version ID. |
|
publishedId |
string | null Required field. Published version ID. |
|
tenantId |
string Required field. Tenant ID. |
|
hidden |
boolean Required field. Indicates if the entry is hidden. |
|
public |
boolean Required field. Indicates if the entry is public. |
|
workbookId |
Any of null | string | null ID of the workbook the Editor chart belongs to. |
|
scope |
enum Required field. Type of the entry. For charts takes value:
|
|
meta |
object | null Required field. Metadata associated with the entry. |
|
links |
object | null Link information. |
|
annotation |
object | null Annotation information. |
|
type |
enum Required field. For Editor JS selectors takes value:
|
|
data |
Required field. Chart data. |
Data
|
Field |
Description |
|
meta |
string Required field. Configuration from the Meta tab. |
|
params |
string Required field. Configuration from the Params tab. |
|
sources |
string Required field. Configuration from the Sources tab. |
|
controls |
string Required field. Configuration from the Controls tab. |