Jump to

• Request
• Response

Complete Tasks

post

/process/api/v1/tasks/complete

Complete tasks

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match All

Show Source

• object schema
  Request for completing the task
• object properties

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CompleteRequest"
        },
        {
            "required":[
                "taskIds"
            ]
        },
        {
            "properties":{
                "taskIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "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."
                }
            }
        }
    ]
}

Nested 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"
}

Nested Schema : properties

Type: object

Show Source

• 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.
• taskIds: array taskIds

{
    "properties":{
        "taskIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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."
        }
    }
}

Nested Schema : taskIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example Complete one or more Tasks

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : BulkCompleteResponse

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BulkCompleteResponseItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object BulkCompleteResponseItem

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BulkCompleteResponseItem"
    }
}

Nested Schema : BulkCompleteResponseItem

Type: object

Show Source

• errorMessage: string
• status: string
  Allowed Values: [ "Success", "Failed" ]
• taskId: string

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Success",
                "Failed"
            ]
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

400 Response

Bad request - invalid input

401 Response

Unauthorized

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top