Jump to

• Request
• Response

Retrieve a Custom Task List

get

/bpm/api/4.0/tasks/views/{viewname}

Retrieves a custom task list by name.

Request

Path Parameters

• viewname(required): string
  View Name

Query Parameters

• action: boolean
  Action
• assignment: string
  Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN

  Default Value: MY_AND_GROUP
• dueDateFrom: string
  Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• dueDateTo: string
  End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• fromuser: array[string]
  Previous task assignee
• groupBy: string
  Groups tasks by the selected task attribute
• keyword: string
  Keyword in task title
• limit: integer(int32)
  Maximum number of items per page, between 1 and 100, default 25

  Default Value: 25
• metadataFlag: boolean
  Metadata - true or false(default)

  Default Value: false
• offset: integer(int32)
  Index for the first item on a page of list items, default 1

  Default Value: 0
• pattern: string
  Includes only to-do tasks if set to ToDo
• priority: array[string]
  Task priority from 1 (highest) to 5 (lowest) or Any (default)
• showPermission: boolean
  Permission - true or false
• since: string
  Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• status: array[string]
  Task status - ASSIGNED (default), SUSPENDED, WITHDRAWN, EXPIRED, ERROR, ALERTED
• totalResults: boolean
  Total Result - true (default) or false

  Default Value: true
• until: string
  Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z

There's no request body for this operation.

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 for view

500 Response

Internal Server Error

Back to Top