Jump to

• Request
• Response

Complete a Task

post

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

Complete 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

  Applicable only for the parent adhoc task. The default value is true. When set to true, automatically withdraws all its incomplete child tasks. Set it to false if the incomplete child tasks should not be withdrawn automatically.
• outcome: string
  Outcome

{
    "type":"object",
    "properties":{
        "outcome":{
            "type":"string",
            "description":"Outcome"
        },
        "isWithdrawChild":{
            "type":"boolean",
            "default":true,
            "description":"Applicable only for the parent adhoc task. The default value is true. When set to true, automatically withdraws all its incomplete child tasks. Set it to false if the incomplete child tasks should not be withdrawn automatically."
        },
        "comment":{
            "type":"string",
            "description":"comment"
        }
    },
    "description":"Request for completing the task"
}

Examples

Select an example Complete a Task

Back to Top

Response

204 Response

Successful operation - no content returned

400 Response

Bad request - invalid input

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