/chart/{pk} - VegasLounge API 对接文档

Changes a Chart.

Request

Path Params

integer

required

Body Params application/json

cache_timeout

integer <int32> | null

optional

Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.

dashboards

array[integer <int32>]

optional

datasource_id

integer <int32> | null

optional

The id of the dataset/datasource this new chart will use. A complete datasource identification needs datasouce_id and datasource_type.

datasource_type

enum<string> | enum<null>

optional

The type of dataset/datasource identified on datasource_id.

Allowed values:

druidtableview

description

string | null

optional

A description of the chart propose.

owners

array[integer <int32>]

optional

params

string | null

optional

Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.

slice_name

string | null

optional

The name of the chart.

>= 0 characters<= 250 characters

viz_type

string | null

optional

The type of chart visualization used.

>= 0 characters<= 250 characters

Example:

["bar","line_multi","area","table"]

Example

{
    "cache_timeout": 0,
    "dashboards": [
        0
    ],
    "datasource_id": 0,
    "datasource_type": "druid",
    "description": "string",
    "owners": [
        0
    ],
    "params": "string",
    "slice_name": "string",
    "viz_type": [
        "bar",
        "line_multi",
        "area",
        "table"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Chart changed

Body

number

optional

result

object (ChartRestApi.put)

optional

cache_timeout

integer <int32> | null

optional

Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.

dashboards

array[integer <int32>]

optional

datasource_id

integer <int32> | null

optional

The id of the dataset/datasource this new chart will use. A complete datasource identification needs datasouce_id and datasource_type.

datasource_type

enum<string> | enum<null>

optional

The type of dataset/datasource identified on datasource_id.

Allowed values:

druidtableview

description

string | null

optional

A description of the chart propose.

owners

array[integer <int32>]

optional

params

string | null

optional

Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.

slice_name

string | null

optional

The name of the chart.

>= 0 characters<= 250 characters

viz_type

string | null

optional

The type of chart visualization used.

>= 0 characters<= 250 characters

Example:

["bar","line_multi","area","table"]

Example

{
    "id": 0,
    "result": {
        "cache_timeout": 0,
        "dashboards": [
            0
        ],
        "datasource_id": 0,
        "datasource_type": "druid",
        "description": "string",
        "owners": [
            0
        ],
        "params": "string",
        "slice_name": "string",
        "viz_type": [
            "bar",
            "line_multi",
            "area",
            "table"
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

🔴500Server Error