Workflow Tasks Withdraw APIAPI Explorer

Introduction

API Introduction

Workflow Tasks Withdraw API is used to withdraw workflow tasks.

API Version

API Version

Update Time

Version Description

v1

2023/08/01

Original API

API Calling

This API is used to withdraw workflow tasks.

Request URL: https://api.jodoo.com/api/v1/workflow/task/revoke

Request Frequency: 20 times/second

Request Method: POST

Request Parameters:

Parameter

Required

Type

Description

instance_id

Yes

String

The instance ID of the corresponding workflow instance that needs to be withdrawn.

task_id

No

String

  • The task ID of the task that needs to be withdrawn (the task ID that has been submitted before, not the current instance ID);
  • It is an optional parameter. If it is empty, the start node will be withdrawn by default.

username

Yes

String

The username of the user who is responsible for the task to be withdrawn.

Sample Request:

{
    "instance_id": "64c72910561073000755af52",
    "task_id": "64c72910561073000755af7c",
    "username": "Jodoo-90ahnts5a6rh"
}

Response Parameters:

Parameter

Type

Description

status

String

success: indicating a successful API call

failure: indicating a failed API call (with the error code and its description)

code

Number

Error code (return only for failure)

message

String

Description of return code (return only for failure)

Sample Response:

{
    "status": "success"
}

Was this information helpful?
Yes
NoNo
Need more help? Contact support