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

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

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

Show Source

• Array of: string

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