流程待辦查詢 API調試

簡介

API 簡介

該 API 可以取得使用者當前的流程待辦資訊。

API 版本

API 版本

更新時間

版本說明

V1

2023.09.18

新增三個回應參數,如下所示:

  • 待辦開始時間: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/task/list

請求頻率:30 次/秒

請求方式:POST

請求參數:

參數

必須

類型

說明

username

String

使用者名,即成員編號。

limit

Number

分頁參數,頁大小預設 10, 最大 100。

skip

Number

分頁參數,跳過前面資料條數,預設 0

請求範例

{
    "username": "Jodoo",
    "skip": 0,
    "limit": 10
}

回應參數

參數

類型

說明

has_more

Boolean

後面是否還有資料

tasks

Object[]

待辦列表

tasks[].app_id

String

應用 ID

tasks[].form_id

String

表單 ID

tasks[].task_id

String

待辦 ID

tasks[].instance_id

String

實例 ID,同 data_id

tasks[].form_title

String

表單名稱

tasks[].title

String

待辦名稱

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

完成待辦時間,恆為 null

tasks[].status

Number

待辦狀態

回應範例

{
    "has_more": false,
    "tasks": [
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "task_id": "63f31ae8144f4a09ec197163",
            "form_id": "63ff33531c2f7e5fe8789b4b",
            "instance_id": "628d8c0d73544c0006a54bfc",
            "form_title": "待辦測試表單標題",
            "title": "待辦標題",
            "flow_id": 1,
            "flow_name": "節點1"
            "url": "",
            "assignee": {
                "username": "xiaoyun",
                "name": "小云",
                "departments": [
                    1,
                    3
                ],
                "type": 0,
                "status": 1,
                "integrate_id": "xiaoyun"
            },
            "creator": {
                "username": "xiaojian",
                "name": "小簡",
                "departments": [
                    1,
                    3
                ],
                "type": 0,
                "status": 1,
                "integrate_id": "xiaojian"
            },
            "create_time": "2022-10-26T13:18:57.605Z",
            "create_action": "forward",
            "finish_time": null,
            "finish_action": null,
            "status": 0
        }
    ]
}

這項資訊有幫助嗎?
需要更多協助嗎?聯繋技術支援。