1. 接口说明
查询指定作品详情。必须同时提供 type 查询参数。
请求方法:GET
请求路径:/api/open/v1/works/{worksId}
2. 认证
需要 HMAC 签名,详见 API 使用说明。
3. 请求参数
3.1 路径参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
worksId | long | 是 | 作品 ID |
3.2 查询参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
type | string | 是 | DASHBOARD / REPORT / SCREEN / FORM / PORTAL |
4. 响应参数
4.2 返回字段(data)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
worksId | long | - | 作品 ID |
name | string | - | 作品名称 |
type | string | - | 作品类型 |
nodeType | string | - | 节点类型 |
parentId | long | - | 父文件夹 ID |
5. 补充说明
未发布或不存在时返回 40401。