删除看板图表

删除指定数据看板中的图表。此操作不可逆。

DELETE https://api.moi.matrixorigin.cn/v5/data-dashboards/{dashboard_id}/charts/{chart_id}

调用前准备

准备有目标工作区访问权限的个人访问令牌目标工作区 ID,分别通过 X-API-Key 和 X-Workspace-ID 请求头传递。从查看数据看板列表的列表中选择所需数据看板的 ID 作为 $DASHBOARD_ID,再从查看数据看板详情的图表列表中选择所需图表的 ID 作为 $CHART_ID;两者都写入请求路径。

路径参数

curl -X DELETE "https://api.moi.matrixorigin.cn/v5/data-dashboards/$DASHBOARD_ID/charts/$CHART_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

路径参数

参数

类型

是否必填

说明

dashboard_id

string

数据看板 ID。

chart_id

string

图表 ID。

成功响应

删除成功时,响应中的 deletedtrue

{
  "code": 0,
  "data": {
    "deleted": true
  }
}

字段

类型

说明

code

integer

成功时为 0。

data

object

删除结果。

下面表格展开响应示例中的 data 对象;每一行是该对象的一个字段。

字段

类型

说明

deleted

boolean

是否已删除。

错误响应

{
  "code": 3,
  "message": "not found",
  "details": {
    "domain": "moi-core.catalog.data_dashboard",
    "reason": "DATA_DASHBOARD_NOT_FOUND"
  }
}

字段

类型

说明

code

integer 或 string

错误代码或状态码。

message

string

错误信息。

最后更新于