创建 SQL 草稿版本¶
为一个 SQL 工作簿创建可编辑的草稿版本,并保存初始 SQL 内容。
POST https://api.moi.matrixorigin.cn/v5/workbook/version/create
调用前准备¶
查看 SQL 工作簿列表,选择并记录工作簿 ID。新建工作簿时,也可以使用创建 SQL 工作簿返回的工作簿 ID。
sql_content 只保存 SQL 内容,不会执行 SQL。
请求体¶
将示例中的调用者专属值替换为实际值。
curl -X POST "https://api.moi.matrixorigin.cn/v5/workbook/version/create" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d "{
\"workbook_id\": \"$WORKBOOK_ID\",
\"sql_content\": \"SELECT 1\"
}"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
SQL 工作簿的 ID。 |
|
string |
否 |
草稿 SQL 内容。 |
成功响应¶
响应返回新草稿版本的 ID。记录该 ID 后,可以修改或定稿该版本。
{
"code": 200,
"data": {
"id": "version-123",
"version": "v1",
"status": "draft"
}
}
字段 |
类型 |
说明 |
|---|---|---|
code |
integer |
成功时为 200。 |
data |
object |
新建草稿版本的信息。 |
下面表格展开响应示例中的 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
id |
string |
新建草稿版本 ID。 |
version |
string |
版本名称。 |
status |
string |
新建版本状态,为 draft。 |
错误响应¶
{
"code": 500,
"message": "Internal server error"
}
字段 |
类型 |
说明 |
|---|---|---|
|
integer 或 string |
错误代码或状态码。 |
|
string |
错误信息。 |
后续操作¶
使用工作簿 ID 和版本 ID,查看 SQL 工作簿版本内容确认保存结果。
最后更新于