This topic applies only to the IBM Business Process Manager Advanced configuration.

REST resources provided by the IBM BPM REST APIs

The IBM® Business Process Manager resources are BPD-related, BPEL-related, or federated resources.

The following resources are provided by the IBM BPM REST APIs.
Table 1. REST resources provided by the IBM BPM REST APIs
Resource categories Description
BPD-related resources Resources for developing client applications for working with processes and tasks that run on the business process definition (BPD) engine. These resources include:
  • Business process definitions and instances
  • External activities and services
  • Tasks
  • Users and groups
  • Saved searches and custom searches
BPEL-related resources Resources for developing client applications for working with processes and tasks that run on the Business Process Choreographer engine. These resources include:
  • Process template lists and details of individual process templates
  • Activities, including start activities, associated with process templates
  • Process instance lists and details of individual process instances
  • Activities, including waiting activities, associated with process instances
  • Variables associated with process instances
  • Input, output, and fault data associated with process and activity instances
  • Task template lists and details of individual task templates
  • Task instance lists and details of individual task instances
  • Roles and associated users and groups for task instances
  • Input, output, and fault data associated with task instances
  • Binary custom properties associated with task instances
  • Subtasks associated with task instances the history of events associated with task instances
  • Work basket lists
  • Details of individual work baskets
  • Business category lists details of individual business categories
Federated resources Resources for developing client applications for working with both BPD-related, and BPEL-related resources. These resources can be distributed or singular resources.
Distributed resources
These are resources for which requests are distributed to one or more systems in the domain. These resources include:
  • Systems: Metadata for one or more systems hosting REST resources, and a list of domains.
  • Queries: Metadata for one or more queries across the systems of a domain.
  • Query attributes: Metadata for attributes of a specified query.
  • Query entity list: The result set that is returned for a specified query.
  • Query entity list count: The size of the result set that is returned for a specified query.
  • Bulk resources: The set of resources for which a specified operation is performed.
Singular resources
These are resources for which the requests are routed to a specific system in a domain. These resources include all other resources, such as process or task instances.