Jump to

• Request
• Response

Update a Task Payload

put

/bpm/api/4.0/tasks/{id}/payload

Updates the payload of a task.

Request

Path Parameters

• id(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• text/html

200 Response

Payload successfully updated

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 not found

409 Response

Stale task object found

500 Response

Internal Server Error

Back to Top