Jump to

• Request
• Response

Perform Bulk Action on Tasks

put

/bpm/api/4.0/tasks

Performs the action on multiple tasks 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 and ESCALATE. Custom Actions depend on the task definition.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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
  allowed values are Simple,Sequential and Parallel
• tasks: array tasks
  list of task numbers
• voterPercentage: integer
  applicable only when routingType is Parallel

{ "type":"object", "properties":{ "action":{ "$ref":"#/components/schemas/Action" }, "comment":{ "$ref":"#/components/schemas/Comment" }, "comments":{ "type":"string" }, "priority":{ "type":"integer", "format":"int32" }, "routingAction":{ "type":"string", "description":"Only applicable for ADHOC_ROUTE. Accepts the custom action to be performed before routing the task." }, "routingType":{ "type":"string", "description":"allowed values are Simple,Sequential and Parallel" }, "voterPercentage":{ "type":"integer", "description":"applicable only when routingType is Parallel" }, "defaultActionForGroupVote":{ "type":"string", "description":"applicable only when routingType is Parallel" }, "tasks":{ "type":"array", "description":"list of task numbers", "items":{ "type":"string" } } }, "xml":{ "name":"actions", "namespace":"http://xmlns.oracle.com/bpm/rest/payloads" } }

Nested Schema : action

Type: object

Show Source

• assignees: array assignees
• id: string
• type: string

{ "type":"object", "properties":{ "assignees":{ "type":"array", "items":{ "$ref":"#/components/schemas/Identity" } }, "id":{ "type":"string" }, "type":{ "type":"string" } }, "xml":{ "name":"action", "namespace":"http://xmlns.oracle.com/bpm/rest/processdef" } }

Nested Schema : comment

Type: object

Show Source

• commentStr: string

{ "type":"object", "properties":{ "commentStr":{ "type":"string" } }, "xml":{ "name":"comment", "namespace":"http://xmlns.oracle.com/bpm/rest/tasks" } }

Nested Schema : tasks

Type: array

list of task numbers

Show Source

• Array of: string

{ "type":"array", "description":"list of task numbers", "items":{ "type":"string" } }

Nested Schema : assignees

Type: array

Show Source

• Array of: object identity

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

Nested Schema : identity

Type: object

Show Source

• email: string
• firstName: string
• id: string
• identity: object link
• lastName: string
• middleName: string
• mobile: string
• type: string
• workPhone: string

{ "type":"object", "properties":{ "id":{ "type":"string" }, "type":{ "type":"string" }, "email":{ "type":"string" }, "identity":{ "$ref":"#/components/schemas/Link" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "middleName":{ "type":"string" }, "mobile":{ "type":"string" }, "workPhone":{ "type":"string" } }, "xml":{ "name":"identity", "namespace":"http://xmlns.oracle.com/bpm/rest/identities" } }

Nested Schema : link

Type: object

Show Source

• href: string (uri)
  href of the provided link
• rel: string
  relationship with the returned resource

  Example: self

{ "type":"object", "properties":{ "href":{ "type":"string", "description":"href of the provided link", "format":"uri" }, "rel":{ "type":"string", "description":"relationship with the returned resource", "example":"self" } }, "xml":{ "name":"link", "namespace":"http://xmlns.oracle.com/bpm/rest" } }

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Collection

Type: object

Show Source

• 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

{ "type":"object", "properties":{ "totalResult":{ "type":"boolean", "default":false }, "limit":{ "type":"integer", "format":"int32" }, "userLink":{ "$ref":"#/components/schemas/Link" }, "count":{ "type":"integer", "format":"int32" }, "offset":{ "type":"integer", "format":"int32" }, "hasMore":{ "type":"boolean", "default":false }, "items":{ "type":"array", "items":{ "type":"object", "properties":{ } } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } } }, "xml":{ "name":"Collection", "namespace":"http://xmlns.oracle.com/bpm/rest/v3/common/" } }

Nested Schema : items

Type: array

Show Source

• Array of: object items

{ "type":"array", "items":{ "type":"object", "properties":{ } } }

Nested Schema : links

Type: array

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string (uri)
  href of the provided link
• rel: string
  relationship with the returned resource

  Example: self

{ "type":"object", "properties":{ "href":{ "type":"string", "description":"href of the provided link", "format":"uri" }, "rel":{ "type":"string", "description":"relationship with the returned resource", "example":"self" } }, "xml":{ "name":"link", "namespace":"http://xmlns.oracle.com/bpm/rest" } }

Nested Schema : items

Type: object

Show Source

{ "type":"object", "properties":{ } }

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task list not found

500 Response

Internal Server Error

Back to Top