VeryReport · 帮助文档

QueryWorks - 作品列表

开放 API:分页查询已发布的仪表板、报表、大屏、填报、门户作品。

1. 接口说明

列出已发布作品。未发布(草稿)作品不会出现在结果中。

请求方法:GET
请求路径:/api/open/v1/works

2. 认证

需要 HMAC 签名,详见 API 使用说明

3. 请求参数

3.2 查询参数

参数名类型必填说明
typestring作品类型:DASHBOARD / REPORT / SCREEN / FORM / PORTAL
pageint页码,默认 1
pageSizeint每页条数,默认 20
keywordstring按作品名称模糊匹配

4. 响应参数

4.2 返回字段(data)

参数名类型必填说明
totalint-总记录数
listarray-作品列表
list[].worksIdlong-作品 ID(resource_id)
list[].namestring-作品名称
list[].typestring-作品类型
list[].nodeTypestring-资源节点类型,一般为 FILE
list[].parentIdlong-父文件夹 ID

5. 补充说明

仅返回已发布作品:DASHBOARD/REPORT/SCREEN 的 status=1,PORTAL 的 publish_status=PUBLISHED。

上一篇DisableUser - 停用用户下一篇QueryWorksInfo - 作品详情