Jump to

• Request
• Response

Get a Task

get

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

Get task detail by ID

Request

Path Parameters

• id(required): string
  Task ID

Query Parameters

• totalResultsGrouped: boolean
  Boolean flag to fetch total, open, closed, and overdue count of child tasks.

  Default Value: false

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Endpoint that the customer requested.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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
• title: string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string"
        },
        "actionId":{
            "type":"string"
        }
    }
}

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

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