查詢流程實例資訊 API

簡介

API 簡介

該 API 用來查詢流程實例資訊。

API 版本

API版本	更新時間	版本說明
V1	2023.09.18	1. 新增請求參數返回待辦種類：tasks_type； 2. 新增回應參數，如下所示：結束時間：finish_time 待辦名稱：tasks[].title 待辦開始時間：tasks[].create_time 待辦結束時間：tasks[].finish_time 待辦狀態：tasks[].status
V2	2023.12.01	新增兩個回應參數，如下所示：建立待辦的流程動作：tasks[].create_action 完成待辦的流程動作：tasks[].finish_action

API 調用

該 API 用來查詢流程實例資訊。

請求地址：https://api.jodoo.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 }

回應參數：

參數	類型	說明
url	String	實例造訪連結
instance_id	String	實例 ID
app_id	String	應用 ID
form_id	String	表單 ID
form_title	String	表單名稱
update_time	String	實例修改時間
create_time	String	建立時間
finish_time	String	結束時間
creator	Object	建立者資訊同成員實體結構
status	Number	實例狀態，枚舉： 0: 進行中 1: 流轉完成 2: 手動結束
tasks	Object	待辦任務列表
tasks[].app_id	String	應用 ID
tasks[].form_id	String	表單 ID
tasks[].form_title	String	表單名稱
tasks[].title	String	待辦名稱
tasks[].instance_id	String	實例 ID
tasks[].task_id	String	待辦 ID
tasks[].flow_id	Number	節點 ID
tasks[].flow_name	String	節點名稱
tasks[].url	String	待辦造訪連結
tasks[].assignee	Object	待辦人資訊同成員實體結構
tasks[].creator	Object	實例建立者資訊同成員實體結構
tasks[].create_time	String	待辦開始時間
tasks[].create_action	String	建立待辦的流程動作，枚舉： 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_time	String	待辦結束時間
tasks[].finish_action	String	完成待辦的流程動作，枚舉： auto_approve：去重簽核 forward：送出 back：退回 close：關閉 transfer：轉交 batch_forward：批次送出 sign_after：後加籤
tasks[].status	Number	待辦狀態 0: 進行中 1: 已完成 2: 手動結束 4: 被激活 5: 任務被暫停

回應範例：

{     "app_id": "628d8c0d73544c0006a54bfd",     "form_id": "63f31ae8144f4a09ec197163",     "form_title": "物品資訊借用",     "instance_id": "63ff32d918fbc20007a4a082",     "url": "https://www.jodoo.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": "Jodoo",         "name": "Jodoo",         "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.jodoo.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197162",             "assignee": {                 "username": "Jodoo",                 "name": "Jodoo",                 "departments": [                     1                 ],                 "type": 0,                 "status": 1             },             "creator": {                 "username": "Jodoo",                 "name": "Jodoo",                 "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.jodoo.com/workflow/process_instance/63ff32d918fbc20007a4a082/task/63f31ae8144f4a09ec197163",             "assignee": {                 "username": "Jodoo",                 "name": "Jodoo",                 "departments": [                     1                 ],                 "type": 0,                 "status": 1             },             "creator": {                 "username": "Jodoo",                 "name": "Jodoo",                 "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         }     ] }