Retrieve a Task
get
/bpm/api/4.0/tasks/{id}
Retrieves a task by task ID (The task number).
Request
Path Parameters
-
id(required): string
Task ID (Internally known as the task number)
Query Parameters
-
expand(required): string
Value of all fields that are to be expanded (detailed) - All, comments, attachments, history, payload. If not specified Links to each of the fields is returned.Default Value:
-
metadataFlag(required): boolean
Metadata - true or falseDefault Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : task
Type:
Show Source
object
-
actionList: array
actionList
-
applicationContext: string
-
applicationName: string
-
assignedDate: string
-
assignees: object
Collection
-
attachments: array
attachments
-
comments: object
comments
-
createdBy: string
-
createdDate: string
-
detailsURL: object
Link
-
dueDate: string
-
externalUIURL: string
-
formMetadata: string
-
fromUserDisplayName: string
-
fromUserName: string
-
getcListURL: object
Link
-
groupByName: string
-
groupByValue: string
-
hasSubTasksFlag: boolean
Default Value:
false
-
history: object
taskHistories
-
href(required): string
(uri)
-
hreflang: string
-
identificationKey: string
-
length: integer
(int32)
-
linkId: string
-
links: array
links
-
mediaType(required): string
-
number: integer
(int32)
-
outcome: string
-
ownerGroup: string
-
ownerRole: string
-
ownerUser: string
-
payload: object
payload
-
permissions: array
permissions
-
priority: integer
(int32)
-
rel(required): string
-
rootTaskNumber: string
-
startDate: string
-
state: string
-
taskDefinitionName: string
-
taskId: string
-
taskNamespace: string
-
title: string
-
titlePrefix: string
shown only for current assignee or creator of task
-
type: string
-
updatedDate: string
Nested Schema : Collection
Type:
Show Source
object
-
count: integer
(int32)
-
hasMore: boolean
Default Value:
false
-
items: array
items
-
limit: integer
(int32)
-
links: array
links
-
offset: integer
(int32)
-
totalResult: boolean
Default Value:
false
-
userLink: object
Link
Nested Schema : Link
Type:
Show Source
object
-
href(required): string
-
rel(required): string
Allowed Values:
[ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]
400 Response
Bad request
401 Response
Unauthorized
404 Response
Task not found for given ID.
500 Response
Internal Server Error