Perform Action on Task
put
/bpm/api/4.0/tasks/{id}
Performs the action on a specific task identifier, based on the payload. The following actions are available and the actions depend on the application: APPROVE, REJECT, REASSIGN, DELEGATE, WITHDRAW, SUSPEND, RESUME, DELETE, PURGE, ACQUIRE, RELEASE, PUSHBACK, ERROR, ADHOC_ROUTE, INFO_REQUEST, INFO_SUBMIT, SKIP_CURRENT_ASSIGNMENT, SAVE and ESCALATE. Custom Actions depend on the task definition.
Request
Path Parameters
-
id(required): string
Task ID
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
action: object
action
-
comment: object
comment
-
comments: string
-
defaultActionForGroupVote: string
applicable only when routingType is Parallel
-
priority: integer
(int32)
-
routingAction: string
Only applicable for ADHOC_ROUTE. Accepts the custom action to be performed before routing the task.
-
routingType: string
Only applicable for ADHOC_ROUTE.Accepts the type of routing to be performed. Allowed values are Simple,Sequential and Parallel
-
votersPercentage: integer
applicable only when routingType is Parallel.Default value is 0
Nested Schema : Link
Type:
Show Source
object
-
href(required): string
-
rel(required): string
Allowed Values:
[ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]
Response
Supported Media Types
- application/json
200 Response
Success . In case of PURGE, a title specifying task id successfully purged will be returned.
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
The tasknumber is invalid.No action will be performed.
401 Response
Unauthorized
404 Response
Task not found.
409 Response
Conflict.
500 Response
Internal Server Error