REST API for Oracle Cloud Infrastructure Process Automation

Create an Adhoc Task

post

/process/api/v1/tasks

Create an adhoc task.

Request

Header Parameters

oci-original-url:

Endpoint that the customer requested.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

addMembers: object UpdateMembers
assignees: object assignees

Assignees for the task.
category: string

Category for the task.
comment: string

Comment on new task
dueDate: string (date)

Due Date for the task in the format "yyyy-MM-dd'T'HH:mm:ss".
externalFormUrl: string

The reference to the external form associated with the adhoc task. Expressions are also supported. Example - https://myloanapp.com/loan/apply?loanId=${payload.prop('var1')}&applicant=${payload.prop('var2')} where payload have var1 and var2 variables. It will be compiled to - https://myloanapp.com/loan/apply?loanId=&applicant=&taskId=
joinAsMember: object joinAsMember

Join as member at the time of adhoc task creation
outcomes: array outcomes
parentTaskId: string

Parent task ID.
payload: object payload

Additional Properties Allowed: additionalProperties
priority: integer (int32)

Allowed Values: [ "1", "2", "3" ]

Priority of the task. This is provided as a number between 1 and 3, where 1 is the highest priority.
summary: string

Summary of the task.
tags: array tags
title: string

Title of the task.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Title of the task."
        },
        "summary":{
            "type":"string",
            "description":"Summary of the task."
        },
        "parentTaskId":{
            "type":"string",
            "description":"Parent task ID."
        },
        "joinAsMember":{
            "description":"Join as member at the time of adhoc task creation",
            "type":"object",
            "properties":{
                "level":{
                    "type":"string",
                    "enum":[
                        "INSPECT",
                        "READ",
                        "USE",
                        "MANAGE"
                    ],
                    "description":"The permission level of the member"
                },
                "label":{
                    "type":"string",
                    "description":"The label of the member"
                }
            }
        },
        "addMembers":{
            "description":"Add members to the adhoc task. (only if the creator did joinAsMember with MANAGE permission, adding members is allowed)",
            "type":"object",
            "$ref":"#/components/schemas/UpdateMembers"
        },
        "priority":{
            "type":"integer",
            "description":"Priority of the task. This is provided as a number between 1 and 3, where 1 is the highest priority.",
            "format":"int32",
            "enum":[
                "1",
                "2",
                "3"
            ]
        },
        "assignees":{
            "description":"Assignees for the task.",
            "type":"object",
            "properties":{
                "identities":{
                    "type":"array",
                    "description":"Only the ID of identity is considered and not the name.",
                    "items":{
                        "$ref":"#/components/schemas/Identity"
                    }
                }
            }
        },
        "dueDate":{
            "type":"string",
            "description":"Due Date for the task in the format \"yyyy-MM-dd'T'HH:mm:ss\".",
            "format":"date"
        },
        "category":{
            "type":"string",
            "description":"Category for the task."
        },
        "comment":{
            "type":"string",
            "description":"Comment on new task"
        },
        "outcomes":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Outcome for the task."
            }
        },
        "payload":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "externalFormUrl":{
            "type":"string",
            "description":"The reference to the external form associated with the adhoc task. Expressions are also supported. Example - https://myloanapp.com/loan/apply?loanId=${payload.prop('var1')}&applicant=${payload.prop('var2')} where payload have var1 and var2 variables. It will be compiled to - https://myloanapp.com/loan/apply?loanId=<var1_value>&applicant=<var2_value>&taskId=<taskId>"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Tag"
            }
        }
    }
}

Nested Schema : UpdateMembers

Type: object

Show Source

action: string

Example: addMembers(to add the list of members), updateMembers(to update the list of members), deleteAllMembers(to delete all the members), deleteMembers(to delete the list of members)
items: array items
overwrite: string

Default Value: always

Allowed Values: [ "always", "never", "upgradeOnly", "downgradeOnly", "upgradeonly", "downgradeonly" ]

Example: always(always add the member's permission), never (skips updating the already present members in list, updates the others), downgradeOnly (update permission if the existing permission is higher than specified), upgradeOnly (update permission if the existing permission is lower than specified)

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "example":"addMembers(to add the list of members), updateMembers(to update the list of members), deleteAllMembers(to delete all the members), deleteMembers(to delete the list of members)"
        },
        "overwrite":{
            "type":"string",
            "example":"always(always add the member's permission), never (skips updating the already present members in list, updates the others), downgradeOnly (update permission if the existing permission is higher than specified), upgradeOnly (update permission if the existing permission is lower than specified)",
            "enum":[
                "always",
                "never",
                "upgradeOnly",
                "downgradeOnly",
                "upgradeonly",
                "downgradeonly"
            ],
            "default":"always"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Member"
            }
        }
    }
}

Nested Schema : assignees

Type: object

Assignees for the task.

Show Source

identities: array identities

Only the ID of identity is considered and not the name.

{
    "description":"Assignees for the task.",
    "type":"object",
    "properties":{
        "identities":{
            "type":"array",
            "description":"Only the ID of identity is considered and not the name.",
            "items":{
                "$ref":"#/components/schemas/Identity"
            }
        }
    }
}

Nested Schema : joinAsMember

Type: object

Join as member at the time of adhoc task creation

Show Source

label: string

The label of the member
level: string

Allowed Values: [ "INSPECT", "READ", "USE", "MANAGE" ]

The permission level of the member

{
    "description":"Join as member at the time of adhoc task creation",
    "type":"object",
    "properties":{
        "level":{
            "type":"string",
            "enum":[
                "INSPECT",
                "READ",
                "USE",
                "MANAGE"
            ],
            "description":"The permission level of the member"
        },
        "label":{
            "type":"string",
            "description":"The label of the member"
        }
    }
}

Nested Schema : outcomes

Type: array

Show Source

Array of: string

Outcome for the task.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Outcome for the task."
    }
}

Nested Schema : payload

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : tags

Type: array

Show Source

Array of: string

Tag

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

Nested Schema : items

Type: array

Show Source

Array of: object Member

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

Nested Schema : Member

Type: object

Show Source

identityId: string

The identity ID of the member
identityName: string

The identity name of the member
identityType: string

The identity type of the member
label: string

The label of the member
level: string

Allowed Values: [ "INSPECT", "READ", "USE", "MANAGE" ]

The permission level of the member

{
    "type":"object",
    "properties":{
        "identityId":{
            "type":"string",
            "description":"The identity ID of the member"
        },
        "level":{
            "type":"string",
            "enum":[
                "INSPECT",
                "READ",
                "USE",
                "MANAGE"
            ],
            "description":"The permission level of the member"
        },
        "label":{
            "type":"string",
            "description":"The label of the member"
        },
        "identityType":{
            "type":"string",
            "description":"The identity type of the member"
        },
        "identityName":{
            "type":"string",
            "description":"The identity name of the member"
        }
    }
}

Nested Schema : identities

Type: array

Only the ID of identity is considered and not the name.

Show Source

Array of: Identity

{
    "type":"array",
    "description":"Only the ID of identity is considered and not the name.",
    "items":{
        "$ref":"#/components/schemas/Identity"
    }
}

Nested Schema : Identity

Match All

Show Source

object IdentityCommon
object Identity-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "GROUP",
                        "ROLE"
                    ]
                }
            }
        }
    ]
}

Nested Schema : IdentityCommon

Type: object

Show Source

displayName: string
id: string
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : Identity-allOf[1]

Type: object

Show Source

type: string

Allowed Values: [ "USER", "GROUP", "ROLE" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "GROUP",
                "ROLE"
            ]
        }
    }
}

Nested Schema : additionalProperties

Type: object

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : Task

Match All

Show Source

object CommonModel
object Task-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "title":{
                    "type":"string"
                },
                "summary":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "isAdhoc":{
                    "type":"boolean",
                    "description":"Specifies whether it is an adhoc task or not."
                },
                "priority":{
                    "type":"integer",
                    "format":"int32",
                    "enum":[
                        "1",
                        "2",
                        "3"
                    ]
                },
                "isSuspended":{
                    "type":"boolean",
                    "description":"This will be true if the process is suspended."
                },
                "state":{
                    "$ref":"#/components/schemas/State"
                },
                "substate":{
                    "$ref":"#/components/schemas/Substate"
                },
                "isEscalated":{
                    "type":"boolean",
                    "description":"This will be true if the Task got Escalated."
                },
                "reason":{
                    "$ref":"#/components/schemas/Reason",
                    "description":"JSON object which contains all the attributes for the latest life-cycle operation for this task with user provided comment(as applicable)."
                },
                "reasonText":{
                    "type":"string",
                    "description":"Single line description of the latest life-cycle operation for this task with user provided comment if applicable."
                },
                "assignee":{
                    "$ref":"#/components/schemas/User"
                },
                "originalAssignee":{
                    "$ref":"#/components/schemas/User"
                },
                "parentTask":{
                    "$ref":"#/components/schemas/ParentTaskDetail"
                },
                "totalResultsGrouped":{
                    "$ref":"#/components/schemas/TaskTotalResultsGrouped"
                },
                "outcome":{
                    "type":"string"
                },
                "fromUser":{
                    "$ref":"#/components/schemas/UserOrAppClient"
                },
                "createdBy":{
                    "$ref":"#/components/schemas/UserOrAppClient"
                },
                "createdDate":{
                    "type":"string",
                    "description":"The time the task was created in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                    "format":"date"
                },
                "dueDate":{
                    "type":"string",
                    "description":"Due date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                    "format":"date"
                },
                "lastUpdatedDate":{
                    "type":"string",
                    "description":"Last updated date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                    "format":"date"
                },
                "finishedDate":{
                    "type":"string",
                    "description":"Time when the task was deleted or completed in format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                    "format":"date"
                },
                "completedDate":{
                    "type":"string",
                    "description":"Time when the task was deleted or completed in format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                    "format":"date"
                },
                "assignedDate":{
                    "type":"string",
                    "description":"Assigned date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                    "format":"date"
                },
                "processName":{
                    "type":"string"
                },
                "processDefinitionTitle":{
                    "type":"string"
                },
                "processDefinitionDescription":{
                    "type":"string"
                },
                "activityInstanceId":{
                    "type":"string"
                },
                "processInstanceId":{
                    "type":"string"
                },
                "processDefinitionId":{
                    "type":"string"
                },
                "processDefinitionKey":{
                    "type":"string"
                },
                "processExecutionId":{
                    "type":"string"
                },
                "rootInstanceId":{
                    "type":"string"
                },
                "rootProcessId":{
                    "type":"string"
                },
                "dpName":{
                    "type":"string"
                },
                "dpDefinitionTitle":{
                    "type":"string"
                },
                "dpDefinitionDescription":{
                    "type":"string"
                },
                "dpInstanceId":{
                    "type":"string"
                },
                "dpDefinitionId":{
                    "type":"string"
                },
                "dpDefinitionKey":{
                    "type":"string"
                },
                "dpExecutionId":{
                    "type":"string"
                },
                "taskDefinitionKey":{
                    "type":"string"
                },
                "applicationName":{
                    "type":"string"
                },
                "applicationTitle":{
                    "type":"string"
                },
                "formURL":{
                    "type":"string"
                },
                "businessKey":{
                    "type":"string"
                },
                "externalFormUrl":{
                    "type":"string"
                },
                "candidateUsers":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/User"
                    }
                },
                "candidateGroups":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/GroupAndRole"
                    }
                },
                "availableActions":{
                    "$ref":"#/components/schemas/taskActions"
                },
                "expirationDate":{
                    "type":"string",
                    "description":"Expiry date in the format yyyy-MM-dd'T'HH:mm:ss.",
                    "format":"date"
                },
                "tags":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "description":"Tag"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

Nested Schema : Task-allOf[1]

Type: object

Show Source

activityInstanceId: string
applicationName: string
applicationTitle: string
assignedDate: string (date)

Assigned date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z
assignee: User
availableActions: object taskActions
businessKey: string
candidateGroups: array candidateGroups
candidateUsers: array candidateUsers
completedDate: string (date)

Time when the task was deleted or completed in format YYYY-MM-DDTHH:MM:SS[.sss]Z
createdBy: UserOrAppClient
createdDate: string (date)

The time the task was created in the format YYYY-MM-DDTHH:MM:SS[.sss]Z
description: string
dpDefinitionDescription: string
dpDefinitionId: string
dpDefinitionKey: string
dpDefinitionTitle: string
dpExecutionId: string
dpInstanceId: string
dpName: string
dueDate: string (date)

Due date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z
expirationDate: string (date)

Expiry date in the format yyyy-MM-dd'T'HH:mm:ss.
externalFormUrl: string
finishedDate: string (date)

Time when the task was deleted or completed in format YYYY-MM-DDTHH:MM:SS[.sss]Z
formURL: string
fromUser: UserOrAppClient
id: string
isAdhoc: boolean

Specifies whether it is an adhoc task or not.
isEscalated: boolean

This will be true if the Task got Escalated.
isSuspended: boolean

This will be true if the process is suspended.
lastUpdatedDate: string (date)

Last updated date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z
originalAssignee: User
outcome: string
parentTask: object ParentTaskDetail
priority: integer (int32)

Allowed Values: [ "1", "2", "3" ]
processDefinitionDescription: string
processDefinitionId: string
processDefinitionKey: string
processDefinitionTitle: string
processExecutionId: string
processInstanceId: string
processName: string
reason: object Reason
reasonText: string

Single line description of the latest life-cycle operation for this task with user provided comment if applicable.
rootInstanceId: string
rootProcessId: string
state: string

Allowed Values: [ "ASSIGNED", "UNASSIGNED", "WITHDRAWN", "COMPLETED", "DELEGATED", "FAULTED" ]
substate: string

Allowed Values: [ "INITIATED", "CLAIMED", "RELEASED", "INFO_REQUESTED", "INFO_SUBMITTED", "REASSIGNED", "ESCALATED", "WITHDRAWN", "WITHDRAWN_TERMINATION", "EXPIRED" ]
summary: string
tags: array tags
taskDefinitionKey: string
title: string
totalResultsGrouped: object TaskTotalResultsGrouped

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isAdhoc":{
            "type":"boolean",
            "description":"Specifies whether it is an adhoc task or not."
        },
        "priority":{
            "type":"integer",
            "format":"int32",
            "enum":[
                "1",
                "2",
                "3"
            ]
        },
        "isSuspended":{
            "type":"boolean",
            "description":"This will be true if the process is suspended."
        },
        "state":{
            "$ref":"#/components/schemas/State"
        },
        "substate":{
            "$ref":"#/components/schemas/Substate"
        },
        "isEscalated":{
            "type":"boolean",
            "description":"This will be true if the Task got Escalated."
        },
        "reason":{
            "$ref":"#/components/schemas/Reason",
            "description":"JSON object which contains all the attributes for the latest life-cycle operation for this task with user provided comment(as applicable)."
        },
        "reasonText":{
            "type":"string",
            "description":"Single line description of the latest life-cycle operation for this task with user provided comment if applicable."
        },
        "assignee":{
            "$ref":"#/components/schemas/User"
        },
        "originalAssignee":{
            "$ref":"#/components/schemas/User"
        },
        "parentTask":{
            "$ref":"#/components/schemas/ParentTaskDetail"
        },
        "totalResultsGrouped":{
            "$ref":"#/components/schemas/TaskTotalResultsGrouped"
        },
        "outcome":{
            "type":"string"
        },
        "fromUser":{
            "$ref":"#/components/schemas/UserOrAppClient"
        },
        "createdBy":{
            "$ref":"#/components/schemas/UserOrAppClient"
        },
        "createdDate":{
            "type":"string",
            "description":"The time the task was created in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
            "format":"date"
        },
        "dueDate":{
            "type":"string",
            "description":"Due date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
            "format":"date"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"Last updated date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
            "format":"date"
        },
        "finishedDate":{
            "type":"string",
            "description":"Time when the task was deleted or completed in format YYYY-MM-DDTHH:MM:SS[.sss]Z",
            "format":"date"
        },
        "completedDate":{
            "type":"string",
            "description":"Time when the task was deleted or completed in format YYYY-MM-DDTHH:MM:SS[.sss]Z",
            "format":"date"
        },
        "assignedDate":{
            "type":"string",
            "description":"Assigned date in the format YYYY-MM-DDTHH:MM:SS[.sss]Z",
            "format":"date"
        },
        "processName":{
            "type":"string"
        },
        "processDefinitionTitle":{
            "type":"string"
        },
        "processDefinitionDescription":{
            "type":"string"
        },
        "activityInstanceId":{
            "type":"string"
        },
        "processInstanceId":{
            "type":"string"
        },
        "processDefinitionId":{
            "type":"string"
        },
        "processDefinitionKey":{
            "type":"string"
        },
        "processExecutionId":{
            "type":"string"
        },
        "rootInstanceId":{
            "type":"string"
        },
        "rootProcessId":{
            "type":"string"
        },
        "dpName":{
            "type":"string"
        },
        "dpDefinitionTitle":{
            "type":"string"
        },
        "dpDefinitionDescription":{
            "type":"string"
        },
        "dpInstanceId":{
            "type":"string"
        },
        "dpDefinitionId":{
            "type":"string"
        },
        "dpDefinitionKey":{
            "type":"string"
        },
        "dpExecutionId":{
            "type":"string"
        },
        "taskDefinitionKey":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "applicationTitle":{
            "type":"string"
        },
        "formURL":{
            "type":"string"
        },
        "businessKey":{
            "type":"string"
        },
        "externalFormUrl":{
            "type":"string"
        },
        "candidateUsers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/User"
            }
        },
        "candidateGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GroupAndRole"
            }
        },
        "availableActions":{
            "$ref":"#/components/schemas/taskActions"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiry date in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Tag"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Defines Link

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

Nested Schema : Link

Type: object

Defines Link

Show Source

code: integer

Minimum Value: 100

Maximum Value: 600
href(required): string
hreflang: string
length: integer (int32)
mediaType: string
message: string
rel(required): string
title: string
type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":"100",
            "maximum":"600"
        }
    }
}

Nested Schema : User

Match All

Show Source

object IdentityCommon

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        }
    ]
}

Nested Schema : taskActions

Type: object

Show Source

custom(required): array custom
system(required): array system

{
    "type":"object",
    "required":[
        "system",
        "custom"
    ],
    "properties":{
        "system":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/taskAction"
            }
        },
        "custom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/taskAction"
            }
        }
    }
}

Nested Schema : candidateGroups

Type: array

Show Source

Array of: GroupAndRole

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

Nested Schema : candidateUsers

Type: array

Show Source

Array of: User

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

Nested Schema : UserOrAppClient

Match All

Show Source

object IdentityCommon
object Discriminator: type

Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "discriminator":{
                "propertyName":"type"
            },
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "APPCLIENT"
                    ]
                }
            }
        }
    ]
}

Nested Schema : ParentTaskDetail

Type: object

Show Source

id: string
summary: string
title: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        }
    }
}

Nested Schema : Reason

Type: object

Show Source

action: string

Allowed Values: [ "INITIATE", "CLAIM", "RELEASE", "REASSIGN", "INFO_REQUEST", "INFO_SUBMIT", "COMPLETE", "WITHDRAW", "ESCALATE", "EXPIRED" ]
assignee: User
candidateGroups: array candidateGroups
candidateUsers: array candidateUsers
comment: string
date: string (date)

Date in the format yyyy-MM-dd'T'HH:mm:ssZ.
errorMessage: string
outcome: string
subaction: string

Allowed Values: [ "TERMINATED", "FAULTED" ]
user: User

{
    "type":"object",
    "properties":{
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "assignee":{
            "$ref":"#/components/schemas/User"
        },
        "candidateUsers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/User"
            }
        },
        "candidateGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GroupAndRole"
            }
        },
        "action":{
            "$ref":"#/components/schemas/TaskActionENUM"
        },
        "subaction":{
            "$ref":"#/components/schemas/TaskSubActionENUM"
        },
        "errorMessage":{
            "type":"string"
        },
        "outcome":{
            "type":"string"
        },
        "date":{
            "type":"string",
            "description":"Date in the format yyyy-MM-dd'T'HH:mm:ssZ.",
            "format":"date"
        },
        "comment":{
            "type":"string"
        }
    }
}

Nested Schema : tags

Type: array

Show Source

Array of: string

Tag

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

Nested Schema : TaskTotalResultsGrouped

Type: object

Show Source

closed: integer (int32)
open: integer (int32)
overdue: integer (int32)
total: integer (int32)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int32"
        },
        "open":{
            "type":"integer",
            "format":"int32"
        },
        "closed":{
            "type":"integer",
            "format":"int32"
        },
        "overdue":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : IdentityCommon

Type: object

Show Source

displayName: string
id: string
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : custom

Type: array

Show Source

Array of: object taskAction

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

Nested Schema : system

Type: array

Show Source

Array of: object taskAction

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

Nested Schema : taskAction

Type: object

Show Source

actionId: string
isCommentMandatory: boolean

Default Value: false

Specifies if comment is mandatory while performing task action.
title: string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string"
        },
        "actionId":{
            "type":"string"
        },
        "isCommentMandatory":{
            "type":"boolean",
            "default":false,
            "description":"Specifies if comment is mandatory while performing task action."
        }
    }
}

Nested Schema : GroupAndRole

Match All

Show Source

object IdentityCommon
object Discriminator: type

Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "discriminator":{
                "propertyName":"type"
            },
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "GROUP",
                        "ROLE"
                    ]
                }
            }
        }
    ]
}

Nested Schema : Discriminator: type

Type: object

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "GROUP",
                "ROLE"
            ]
        }
    }
}

Show Source

type: string

Allowed Values: [ "GROUP", "ROLE" ]

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "GROUP",
                "ROLE"
            ]
        }
    }
}

Nested Schema : Discriminator: type

Type: object

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

Show Source

type: string

Allowed Values: [ "USER", "APPCLIENT" ]

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

Nested Schema : candidateGroups

Type: array

Show Source

Array of: GroupAndRole

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

Nested Schema : candidateUsers

Type: array

Show Source

Array of: User

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

Examples

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