查询流程日志调试
1. 简介
1.1 接口简介
该接口用来查询流程日志信息,目前仅支持返回包含审批意见的流程日志。
1.2 接口版本
接口版本 | 更新时间 | 接口说明 |
v1 | 2024.01.19 | 原始接口 |
2. 接口调用
该接口用来查询流程日志信息。
请求地址:https://api.jiandaoyun.com/api/v1/workflow/instance/logs
请求频率:30 次/秒
请求方式:POST
请求参数:
参数 | 必须 | 类型 | 说明 |
instance_id | 是 | string | 实例 id,同 data_id |
types | 是 | string[] | 返回的日志类型,可选项; 审批意见:“comment” |
limit | 否 | number | 分页参数 页大小默认 100 ,最大 100 |
skip | 否 | number | 分页参数,跳过前面数据条数 默认为 0 |
请求示例:
{
"instance_id": "659cba93489a49c06f7d4281",
"types": [
"comment"
],
"skip": 0,
"limit": 10
}
响应参数:
参数 | 类型 | 说明 |
logs | object[] | 日志列表 |
logs[].flow_id | number | 节点 ID |
logs[].flow_name | string | 节点名称 |
logs[].create_action | string | 创建待办的流程动作 |
logs[].create_time | Date | 待办开始时间 |
logs[].finish_action | string | 完成待办的流程动作 |
logs[].finish_time | Date | 待办完成时间 |
logs[].comment | string | 审批意见内容 |
logs[].signature | object | 审批意见手写签名 |
logs[].signature.url | string | 审批意见手写签名URL,15 天有效期 |
logs[].attachments | object[] | 附件列表 |
logs[].attachments[].name | string | 附件文件名 |
logs[].attachments[].size | number | 附件文件大小 |
logs[].attachments[].mime | string | 附件文件类型 |
logs[].attachments[].url | string | 附件文件URL,15 天有效期 |
logs[].operator | object | 审批/操作人信息,同 成员实体结构 |
响应示例:
{
"logs": [
{
"flow_id": 1,
"flow_name": "必须手写签名",
"create_time": "2024-01-09T03:16:35.447Z",
"create_action": "forward",
"finish_time": "2024-01-09T03:17:03.239Z",
"finish_action": "forward",
"operator": {
"username": "xiaojian",
"name": "小简",
"departments": [
1
],
"type": 0,
"status": 1
},
"comment": "一条审批意见",
"signature": {
"url": "https://files.jiandaoyun.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
},
"attachments": [
{
"name": "WechatIMG21.jpeg",
"size": 74935,
"mime": "image/jpeg",
"url": "https://files.jiandaoyun.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
},
{
"name": "6b2cc009-141d-44c4-b5fc-5d01667ee0f8.jpg",
"size": 33174,
"mime": "image/jpeg",
"url": "https://files.jiandaoyun.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
},
{
"name": "24x24.png",
"size": 34281,
"mime": "image/png",
"url": "https://files.jiandaoyun.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
}
]
}
]
}