1. 接口说明
列出已发布作品。未发布(草稿)作品不会出现在结果中。
请求方法:GET
请求路径:/api/open/v1/works
2. 认证
需要 HMAC 签名,详见 API 使用说明。
3. 请求参数
3.2 查询参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
type | string | 否 | 作品类型:DASHBOARD / REPORT / SCREEN / FORM / PORTAL |
page | int | 否 | 页码,默认 1 |
pageSize | int | 否 | 每页条数,默认 20 |
keyword | string | 否 | 按作品名称模糊匹配 |
4. 响应参数
4.2 返回字段(data)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
total | int | - | 总记录数 |
list | array | - | 作品列表 |
list[].worksId | long | - | 作品 ID(resource_id) |
list[].name | string | - | 作品名称 |
list[].type | string | - | 作品类型 |
list[].nodeType | string | - | 资源节点类型,一般为 FILE |
list[].parentId | long | - | 父文件夹 ID |
5. 补充说明
仅返回已发布作品:DASHBOARD/REPORT/SCREEN 的 status=1,PORTAL 的 publish_status=PUBLISHED。