更新数据看板¶

更新指定数据看板的名称、说明和数据源。

PATCH https://api.moi.matrixorigin.cn/v5/data-dashboards/{dashboard_id}

调用前准备¶

先在查看数据看板列表中选择要更新的数据看板。

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体¶

将示例中的调用者专属值替换为实际值。

输入示例

curl -X PATCH "https://api.moi.matrixorigin.cn/v5/data-dashboards/$DASHBOARD_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "销售概览",
    "description": "更新后的说明",
    "sources": [{"table_id": 1001}]
  }'

参数说明

参数	类型	是否必填	说明
`name`	string	是	数据看板名称。
`description`	string	是	数据看板说明。
`sources`	array	是	数据源列表。
`sources`	object（对象数组）	是	数据源列表。
`table_id`	integer	是	每个数据源中的表 ID。

成功响应¶

更新成功时，响应中的 updated 为 true。

响应示例

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

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 0。
data	object	更新结果。

更新结果

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

字段	类型	说明
updated	boolean	是否已更新。

错误响应¶

响应示例

{
  "code": 2,
  "message": "invalid argument",
  "details": {
    "domain": "moi-core.catalog.data_dashboard",
    "reason": "DATA_DASHBOARD_INVALID_REQUEST"
  }
}

字段说明

字段	类型	说明
`code`	integer 或 string	错误代码或状态码。
`message`	string	错误信息。

最后更新于 2026 年 9 月 6 日