WebSphere Representational State Transfer (REST) APIs

WebSphere business process management servers provide a set of APIs that are implemented using the Representational State Transfer (REST) services. The Uniform Resource Identifiers (URIs) in these APIs are a set of REST services that access business process and task data.

The following REST APIs can be used with Business Space widgets.

Table 1. User Membership REST interface for all business process management servers
REST resource Description
User Attributes Collection of attribute definitions for users.
User Attribute Definition Definition for a specified user attribute.
Group Attributes Collection of attribute definitions for groups.
Group Attribute Definition Definition for a specified group attribute.
Current User Profile Access to the profile information for the current authenticated user, per WebSphere Application Server authentication.
User Profiles Provides access to the collection of user profiles within the user registry. The parameters memberOf, searchAttributes, and identifier are mutually exclusive.
Group Profiles Provides access to the collection of group profiles within the user registry. The parameters memberOf, searchAttributes, and identifier are mutually exclusive.
User Profile A profile for an individual user, identified by the supplied unique ID.
Group Profile A profile for an individual group, identified by the supplied unique ID.
Group Membership For User Group membership for a given user or group ID. This corresponds to all groups to which the specified user or group belongs.
Table 2. WebSphere Business Monitor REST interface and Event Emitter REST interface for WebSphere Business Monitor
REST resource Description
WebSphere Business Monitor WebSphere Business Monitor resources representing deployed monitor models, Scalable Vector Graphics (SVG) diagrams, monitoring context instances, cube dimensions, alert subscriptions, Key Performance Indicators (KPIs) and business situation alerts.
WebSphere Business Monitor Event Emitter A public API to send events that can be consumed by WebSphere Business Monitor. You must define the XSD that describes the structure of the business information. The API handles generating the event and forwarding it to WebSphere Business Monitor.
Table 3. WebSphere Process Server REST interface for WebSphere Process Server
REST resource Description
Business Flow Manager Business Process Choreographer resources representing process templates, process instances, or related objects.
Human Task Manager Business Process Choreographer resources representing task templates, task instances, or related objects.
Business Calendar Business calendar resources to manage timetables.