Jump to

• Request
• Response

Withdraw Tasks

post

/process/api/v1/tasks/withdraw

Withdraw one or more 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
  Comment request object
• object properties

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommentRequest"
        },
        {
            "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

Comment request object

Show Source

• comment: string

{
    "type":"object",
    "properties":{
        "comment":{
            "type":"string"
        }
    },
    "description":"Comment request object"
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : BulkWithdrawResponse

Type: object

Show Source

• failedCount: integer
• items: array items
• sucessCount: integer
• totalCount: integer

{
    "type":"object",
    "properties":{
        "totalCount":{
            "type":"integer"
        },
        "sucessCount":{
            "type":"integer"
        },
        "failedCount":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BulkWithdrawResponseItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object BulkWithdrawResponseItem

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

Nested Schema : BulkWithdrawResponseItem

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