Jump to

• Request
• Response

Withdraw a Task

post

/process/api/v1/tasks/{id}/withdraw

Withdraw a task

Request

Path Parameters

• id(required): string
  Task Id

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request for completing the task

Show Source

• comment: string
  comment
• isWithdrawChild: boolean
  Default Value: true

  This is applicable only for Parent Adhoc Task. Default is true, which will automatically withdraw all its non completed child tasks. Set this to false, if the non completed child tasks should not be withdrawn automatically.

{
    "type":"object",
    "properties":{
        "isWithdrawChild":{
            "type":"boolean",
            "default":true,
            "description":"This is applicable only for Parent Adhoc Task. Default is true, which will automatically withdraw all its non completed child tasks. Set this to false, if the non completed child tasks should not be withdrawn automatically."
        },
        "comment":{
            "type":"string",
            "description":"comment"
        }
    },
    "description":"Request for completing the task"
}

Back to Top

Response

204 Response

Successful operation - no content returned

401 Response

Unauthorized

404 Response

Task not found for given ID

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top