jdy
  1. workflow
jdy
  • 开发指南
  • app
    • 用户应用查询接口
      POST
    • 用户表单查询接口
      POST
  • formdata
    • form
      • 表单字段查询接口V5
    • data
      • 查询单条数据接口
      • 查询多条数据接口
      • 新建单条数据接口
      • 新建多条数据接口
      • 修改单条数据接口
      • 修改多条数据接口
      • 删除单条数据接口
      • 删除多条数据接口
  • file
    • 获取文件上传凭证和上传地址接口
      POST
    • 文件上传接口
      POST
  • corp
    • user
      • 获取成员信息接口
      • 添加成员接口
      • 修改成员接口
      • 删除成员接口
      • 批量删除成员接口
      • 增量导入成员接口
    • department
      • (递归)获取部门成员接口
      • (递归)获取部门列表接口
      • 创建部门接口
      • 修改部门接口
      • 删除部门接口
      • 获取集成模式部门编号接口
      • 全量导入部门接口
    • role
      • 列出角色接口
      • 创建一个自建角色
      • 更新一个自建角色
      • 删除一个自建角色
      • 列出角色下的成员
      • 为自建角色批量添加成员
      • 为自建角色批量移除成员
    • role_group
      • 列出自建角色组
      • 创建自建角色组
      • 更新自建角色组
      • 删除自建角色组
    • guest
      • 列出我连接的企业
      • 列出我连接的企业的对接人
      • 获取我连接的企业对接人的详细信息
  • workflow
    • 获取单条流程表单数据的审批意见
      POST
    • 查询流程实例信息
      POST
    • 结束流程实例
      POST
    • 流程待办查询
      POST
    • 流程待办提交
      POST
    • 流程待办回退
      POST
    • 流程待办转交
      POST
    • 查询流程日志
      POST
    • 激活流程实例
      POST
  1. workflow

查询流程实例信息

POST
/v5/workflow/instance/get
该接口用来查询流程实例信息。
**请求地址:**https://api.jiandaoyun.com/api/v5/workflow/instance/get
请求频率:30 次/秒
请求方式:POST
请求参数:
参数必须类型说明
instance_id是String实例 id,同 data_id
tasks_type否number返回待办种类,0 表示不返回;1 表示全部返回
请求示例:
{
    "instance_id": "63ff32d918fbc20007a4a082",
    "tasks_type":1
}
响应参数:
参数类型说明
urlString实例访问链接
instance_idString实例 id
app_idString应用 id
form_idString表单 id
form_titleString表单名称
update_timeString实例修改时间
create_timeString创建时间
finish_timeString结束时间
creatorObject创建者信息 同 成员实体结构
statusNumber实例状态,枚举:0 - 进行中1 - 流转完成2 - 手动结束
tasksObject待办任务列表
tasks[].app_idString应用 id
tasks[].form_idString表单 id
tasks[].form_titleString表单名称
tasks[].titleString待办名称
tasks[].instance_idString实例 id
tasks[].task_idString待办 id
tasks[].flow_idNumber节点 id
tasks[].flow_nameString节点名称
tasks[].urlString待办访问链接
tasks[].assigneeObject待办人信息 同 成员实体结构
tasks[].creatorObject实例创建者信息 同 成员实体结构
tasks[].create_timeString待办开始时间
tasks[].create_actionString创建待办的流程动作,枚举:auto_approve: 去重审批forward:提交back:回退transfer:转交revoke:撤回activate:激活auto_forward:超时自动提交auto_back:超时自动回退batch_forward:批量提交batch_transfer:批量调整负责人sign_before:前加签sign_after:后加签sign_parallel:并加签invoke_plugin:插件执行
tasks[].finish_timeString待办结束时间
tasks[].finish_actionString完成待办的流程动作,枚举:auto_approve:去重审批forward:提交back:回退close:关闭transfer:转交batch_forward:批量提交sign_after:后加签
tasks[].statusNumber待办状态0-进行中1-已完成2-手动结束4-被激活5-任务被暂停
响应示例:
{
    "app_id": "628d8c0d73544c0006a54bfd",
    "form_id": "63f31ae8144f4a09ec197163",
    "form_title": "物品信息借用",
    "instance_id": "63ff32d918fbc20007a4a082",
    "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082",
    "update_time": "2022-10-26T13:18:57.605Z",
    "create_time": "2022-10-26T13:11:45.087Z",
    "finish_time": null,
    "status": 0,
    "creator": {
        "username": "xiaojian",
        "name": "小简",
        "departments": [
            1
        ],
        "type": 0,
        "status": 1
    },
    "tasks": [
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "form_id": "63f31ae8144f4a09ec197163",
            "form_title": "物品信息借用",
            "title": "流程发起节点",
            "instance_id": "63ff32d918fbc20007a4a082",
            "task_id": "63f31ae8144f4a09ec197162",
            "flow_id": 0,
            "flow_name": "流程发起节点",
            "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197162",
            "assignee": {
                "username": "xiaoyun",
                "name": "小云",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "creator": {
                "username": "xiaojian",
                "name": "小简",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "create_time": "2022-10-26T13:11:45.087Z",
            "create_action": "forward",
            "finish_time": 2022-10-26T13:11:45.087Z,
            "finish_action": "forward",
            "status": 1
         },
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "form_id": "63f31ae8144f4a09ec197163",
            "form_title": "物品信息借用",
            "title": "审批",
            "instance_id": "63ff32d918fbc20007a4a082",
            "task_id": "63f31ae8144f4a09ec197163",
            "flow_id": 2,
            "flow_name": "审批",
            "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197163",
            "assignee": {
                "username": "xiaoyun",
                "name": "小云",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "creator": {
                "username": "xiaojian",
                "name": "小简",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "create_time": "2022-10-26T13:18:57.605Z",
            "create_action": "forward",
            "finish_time": null,
            "finish_action": null,
            "status": 0
        }
    ]
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
instance_id
string 
必需
实例 id,同 data_id
tasks_type
number 
必需
返回待办种类,0 表示不返回;1 表示全部返回
示例
{
    "instance_id": "string",
    "tasks_type": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.jiandaoyun.com/api/v5/workflow/instance/get' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instance_id": "string",
    "tasks_type": 0
}'

返回响应

🟢200成功
application/json
Body
url
string 
实例访问链接
必需
instance_id
string 
实例 id
必需
app_id
string 
应用 id
必需
form_id
string 
表单 id
必需
form_title
string 
表单名称
必需
update_time
string 
实例修改时间
必需
create_time
string 
创建时间
必需
creator
object 
必需
创建者信息 同 成员实体结构
username
string 
必需
name
string 
必需
departments
array[integer]
必需
type
integer 
必需
status
integer 
必需
status
integer 
必需
实例状态,枚举: 0 - 进行中 1 - 流转完成 2 - 手动结束
tasks
array [object {16}] 
待办任务列表
必需
app_id
string 
应用 id
必需
form_id
string 
表单 id
必需
form_title
string 
表单名称
必需
instance_id
string 
实例 id
必需
task_id
string 
待办 id
必需
flow_id
integer 
节点 id
必需
flow_name
string 
节点名称
必需
url
string 
待办访问链接
必需
assignee
object 
必需
待办人信息 同 成员实体结构
creator
object 
必需
实例创建者信息 同 成员实体结构
title
string 
待办名称
必需
create_time
string  | null 
待办开始时间
可选
create_action
string  | null 
可选
创建待办的流程动作,枚举: auto_approve: 去重审批 forward:提交 back:回退 transfer:转交 revoke:撤回 activate:激活 auto_forward:超时自动提交 auto_back:超时自动回退 batch_forward:批量提交 batch_transfer:批量调整负责人 sign_before:前加签 sign_after:后加签 sign_parallel:并加签 invoke_plugin:插件执行
finish_time
string  | null 
待办结束时间
可选
finish_action
string  | null 
可选
完成待办的流程动作,枚举: auto_approve:去重审批 forward:提交 back:回退 close:关闭 transfer:转交 batch_forward:批量提交 sign_after:后加签
status
integer  | null 
可选
待办状态 0-进行中 1-已完成 2-手动结束 4-被激活 5-任务被暂停
finish_time
string  | null 
结束时间
可选
示例
{
    "app_id": "628d8c0d73544c0006a54bfd",
    "form_id": "63f31ae8144f4a09ec197163",
    "form_title": "物品信息借用",
    "instance_id": "63ff32d918fbc20007a4a082",
    "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082",
    "update_time": "2022-10-26T13:18:57.605Z",
    "create_time": "2022-10-26T13:11:45.087Z",
    "status": 0,
    "creator": {
        "username": "xiaojian",
        "name": "小简",
        "departments": [
            1
        ],
        "type": 0,
        "status": 1
    },
    "tasks": [
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "form_id": "63f31ae8144f4a09ec197163",
            "form_title": "物品信息借用",
            "title": "审批",
            "instance_id": "63ff32d918fbc20007a4a082",
            "task_id": "63f31ae8144f4a09ec197163",
            "flow_id": 2,
            "flow_name": "审批",
            "url": "https://www.jiandaoyun.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197163",
            "assignee": {
                "username": "xiaoyun",
                "name": "小云",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "creator": {
                "username": "xiaojian",
                "name": "小简",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            }
        }
    ]
}
上一页
获取单条流程表单数据的审批意见
下一页
结束流程实例
Built with