Documentation Overview
Getting started with DoubleCloud
Use cases and datasets
ClickHouse®
Apache Kafka®
Apache Airflow
Transfer
Visualization
VPC
API
- Overview
- Get IAM token for service account
- Install SDK
- List of API endpoints
- Tutorials
- API reference
  - Common
  - ClickHouse
  - Kafka
  - Network
  - Transfer
  - Visualization
    - Overview
    - WorkbookService
    - Models
    - Configs
Administration
Billing
Security

Service doublecloud.visualization.v1.WorkbookService

Get

Workbook operations

Request

Field	Description
`workbook_id`	string

Response

Field	Description
`workbook`	doublecloud.visualization.v1.Workbook Workbook config (only dashboards/charts/datasets)
`id`	string
`title`	string
`project_id`	string

Create

Request

Field	Description
`project_id`	string
`workbook_title`	string

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Update

Request

Field	Description
`workbook_id`	string
`workbook`	doublecloud.visualization.v1.Workbook Workbook config (only dashboards/charts/datasets)
`force_rewrite`	google.protobuf.BoolValue

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Delete

Request

Field	Description
`workbook_id`	string

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

GetConnection

Connections operations

Request

Field	Description
`workbook_id`	string
`connection_name`	string

Response

Field	Description
`connection`	doublecloud.visualization.v1.Connection

CreateConnection

Request

Field	Description
`workbook_id`	string
`connection_name`	string
`connection`	doublecloud.visualization.v1.Connection Connection config
`secret`	doublecloud.visualization.v1.Secret

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

UpdateConnection

Request

Field	Description
`workbook_id`	string
`connection_name`	string
`connection`	doublecloud.visualization.v1.Connection
`secret`	doublecloud.visualization.v1.Secret

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

DeleteConnection

Request

Field	Description
`workbook_id`	string
`connection_name`	string

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

AdviseDatasetFields

List all direct fields of dataset with configured data source

Request

Field	Description
`workbook_id`	string
`connection_name`	string
`partial_dataset`	doublecloud.visualization.v1.Dataset Dataset without fields

Response

Field	Description
`dataset`	doublecloud.visualization.v1.Dataset Dataset (with all direct fields & filled defaults)

ListWorkbooks

List all workbooks for given project_id

Request

Field	Description
`project_id`	string

Response

Field	Description
`workbooks`	list
`workbooks[]`	doublecloud.visualization.v1.WorkbooksIndexItem