跳到主要内容

查询PPT文档列表

1.接口说明

请求该接口查询PPT文档列表,支持分页查询。

  • 按PPT文档创建时间倒序排列。

2.请求地址

https://digitbot.bokecc.com/api/ppt/page

3.请求方式

GET

4.请求参数

(1).公共参数,参考服务说明

(2).接口参数

①.Query参数:通过URL参数传递。

参数名类型必需说明
versionString接口版本号,当前支持版本:1.0.0。
projectIdString项目ID。
filenameStringPPT文件名,模糊匹配查询,默认查询全部。
statusInteger文档状态,枚举值。默认查询全部。0=上传中;1=解析中;2=处理完成;-1=上传失败。
startDateString开始日期,包含,格式:yyyy-MM-dd。
endDateString结束日期,包含,格式:yyyy-MM-dd。
pageNumInteger查询页码,正整数。默认值:1。
pageSizeInteger分页大小,正整数,取值范围为[1, 100]区间,默认值:25。
  • startDate、endDate:两个参数同时传值且符合规范时,条件生效,过滤PPT文档创建时间。
    • startDate和endDate间隔不超过1年。
  • 查询参数条件为 并且 的关系。

5.请求示例

GET https://digitbot.bokecc.com/api/ppt/page?projectId=xxx&pageNum=1&pageSize=50&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1

6.响应示例

{
"count": 100,
"items": [{
  "id": "xxx",
"filename": "xxxxx",
"size": 12345,
"status": 1,
"totalPage": 100,
"successPage": 30,
"createTime": "2024-01-29 12:25:00",
"finishTime": "",
"failReason": ""
}, ...]
}

7.响应说明

字段名类型说明
countLong符合查询条件的PPT文档总数量。
itemsArray查询页返回的PPT文档(ppt)列表。

ppt字段说明

字段名类型说明
idStringPPT-ID。
filenameStringPPT文件名。
sizeLongPPT文件大小,单位:B(字节)。
statusIntegerPPT文档状态,枚举值。0=上传中;1=解析中;2=处理完成;-1=上传失败。
totalPageIntegerPPT总页数。
successPageInteger已解析成功页数。
createTimeString创建时间,yyyy-MM-dd HH:mm:ss格式。
finishTimeString完成时间,yyyy-MM-dd HH:mm:ss格式。
failReasonString上传失败原因。