Workflow Tasks Query API - Jodoo

Introduction

API Introduction

The API is used to access the workflow tasks of the current user.

API Version

API Version	Updated Time	Description
V1	2023.09.18	Here are the three new response parameters: Start time for tasks: tasks[].create_time End time for tasks: tasks[].finish_time Task status: tasks[].status
V2	2023.12.01	Add two response parameters: The workflow action to create tasks: tasks[].create_action The workflow action to complete tasks: tasks[].finish_action

API Calling

The API is used to access the current tasks of the user.

Request URL: https://api.jodoo.com/api/v4/workflow/task/list

Request Frequency: 30 times/second

Request Method: POST

Request Parameters:

Parameter	Required	Type	Description
username	Yes	String	It refers to the User No. in Contacts.
Limit	No	Number	Pagination parameter. The page size is ten by default and is 100 at most.
skip	No	Number	Pagination parameter. The number of records to be skipped is 0 by default.

Sample Request:

{
    "username": "R-peHE5VS",
    "skip": 0,
    "limit": 10
}

Response Parameter:

Parameter	Type	Description
has_more	Boolean	Indicates whether there is more data available
tasks	Object[]	Task list
tasks[].app_id	String	App ID
tasks[].form_id	String	Form ID
tasks[].task_id	String	Task ID
tasks[].instance_id	Object[]	Instance ID, same as data_id
tasks[].form_title	String	Form name
tasks[].title	String	Task name
tasks[].flow_id	Number	Node ID
tasks[].flow_name	String	Node name
tasks[].url	String	Task access link
tasks[].assignee	Object	Task assignee information, same as member entity structure
tasks[].creator	Object	Task creator information, same as member entity structure
task[].create_time	String	Start time for tasks
tasks[].create_action	String	Workflow-related actions for task creation: auto_approve: remove duplicate approvers and keep the highest-level approver forward: submit back: return transfer: hand over revoke: withdraw activate: activate auto_forward: automatically submit overdue tasks auto_back: automatically return overdue tasks batch_forward: batch submit batch_transfer: batch change approvers sign_before: add a pre-approver sign_after: add a post-approver sign_parallel: add a parallel approver invoke_plugin: run a plugin
task[].finish_time	String	End time for tasks
tasks[].finish_action	String	Workflow-related actions for task completion: auto_approve: remove duplicate approvers and keep the highest-level approver forward: submit back: return close: close transfer: hand over batch_forward: batch submit sign_after: add a post-approver
task[].status	Number	Task status

Response Example:

{
    "has_more": false,
    "tasks": [
        {
            "app_id": "628d8c0d73544c0006a54bfd",
            "task_id": "63f31ae8144f4a09ec197163",
            "form_id": "63ff33531c2f7e5fe8789b4b",
            "instance_id": "628d8c0d73544c0006a54bfc",
            "form_title": "Item request",
            "title": "Task title",
            "flow_id": 3,
            "flow_name": "Administrative approval",
            "url": "",
            "assignee": {
                "username": "R-peHE5VS4",
                "name": "Martin",
                "departments": [
                    1,
                    3
                ],
                "type": 0,
                "status": 1,
                "integrate_id": "Martin"
            },
            "creator": {
                "username": "R-peHE5VS4",
                "name": "Martin",
                "departments": [
                    1,
                    3
                ],
                "type": 0,
                "status": 1,
                "integrate_id": "Martin"
              },
              "create_time": "2022-10-26T13:18:57.605Z",
              "create_action": "forward",
              "finish_time": null,
              "finish_action": null,
              "status": 0
        }
    ]
}

Workflow Tasks Query APIAPI Explorer

Introduction

API Introduction

API Version

API Calling