REST Interface for Federated BPM Resources

Federated resources representing objects distributed over one or more multiple IBM Business Process Manager instances.

Introduction

This IBM Business Process Manager resource set provides generic federated resources for developing client applications working with IBM Business Process Manager, including

distributed resources such as resource lists, resource list metadata, or bulk resources, for which requests are
- distributed to multiple systems (using the "domain" URI parameter)
- routed to a single system (using the "systemID" parameter) to interact with the subset of the distributed resource hosted by that system
singular resources (all others, e.g., a task instance), for which requests are routed to the hosting system (using the "systemID" parameter)

The (federation) domain is a set of one or more systems (WebSphere Process Server, WebSphere Lombardi Edition, or both) configured at the federation endpoint providing access to the resource types mentioned above.

Available Since

7.5

Summary of all Methods

+ View Methods

REST Method	Description
GET .../v1/processTemplates/queries[?domain={string}\|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]	Use this method to retrieve a list of queries for process template data.
GET .../v1/processTemplates/query/{query}/attributes[?domain={string}\|systemID={string}][&processAppName={string}]	Use this method to retrieve a list of attributes of a query for process template data.
GET .../v1/processTemplates/query/{query}[?domain={string}\|systemID={string}][&selectedAttributes={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}]	Use this method to retrieve a list of process template entities via a query.
GET .../v1/processTemplates/query/{query}/count[?domain={string}\|systemID={string}][&queryFilter={string}][&processAppName={string}][&admin={boolean}]	Use this method to retrieve the number of process template entities in a query matching specified criteria.
GET .../v1/processes/queries[?domain={string}\|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]	Use this method to retrieve a list of queries for process instance data.
GET .../v1/processes/query/{query}/attributes[?domain={string}\|systemID={string}][&processAppName={string}]	Use this method to retrieve a list of attributes of a query for process instance data.
GET .../v1/processes/query/{query}[?domain={string}\|systemID={string}][&selectedAttributes={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]	Use this method to retrieve a list of process instance entities via a query.
GET .../v1/processes/query/{query}/count[?domain={string}\|systemID={string}][&queryFilter={string}][&processAppName={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]	Use this method to retrieve the number of process instance entities in a query matching specified criteria.
GET .../v1/process/{piid}?systemID={string}	Use this method to retrieve details of a specified process instance.
PUT .../v1/process/{piid}?systemID={string}&action={string}&activityName={string}	Use this method to skip the specified activity.
PUT .../v1/process/{piid}?systemID={string}&action={string}&activityName={string}	Use this method to cancel a previous skip request for the specified activity.
GET .../v1/activities/queries[?domain={string}\|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]	Use this method to retrieve a list of queries for activity instance data.
GET .../v1/activities/query/{query}/attributes[?domain={string}\|systemID={string}][&processAppName={string}]	Use this method to retrieve a list of attributes of a query for activity instance data.
GET .../v1/activities/query/{query}[?domain={string}\|systemID={string}][&selectedAttributes={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]	Use this method to retrieve a list of activity instance entities via a query.
GET .../v1/activities/query/{query}/count[?domain={string}\|systemID={string}][&queryFilter={string}][&processAppName={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]	Use this method to retrieve the number of activity instance entities in a query matching specified criteria.
GET .../v1/activity/{aiid}?systemID={string}	Use this method to retrieve details of a specified activity.
PUT .../v1/activity/{aiid}?systemID={string}&action={string}	Use this method to complete the human task associated with the specified activity instance and claim a subsequent human task.
PUT .../v1/activity/{aiid}?systemID={string}&action={string}	Use this method to skip the specified activity instance.
PUT .../v1/activity/{aiid}?systemID={string}&action={string}	Use this method to cancel a previous skip request for the specified activity instance.
PUT .../v1/activity/{aiid}?systemID={string}&action={string}&targetActivityName={string}	Use this method to skip the specified activity instance and jump to another activity.
PUT .../v1/activity/{aiid}?systemID={string}&action={string}&targetActivityName={string}	Use this method to complete the specified activity instance and jump to another activity.
GET .../v1/taskTemplates/queries[?domain={string}\|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]	Use this method to retrieve a list of queries for task template data.
GET .../v1/taskTemplates/query/{query}/attributes[?domain={string}\|systemID={string}][&processAppName={string}]	Use this method to retrieve a list of attributes of a query for task template data.
GET .../v1/taskTemplates/query/{query}[?domain={string}\|systemID={string}][&interactionFilter={string}][&selectedAttributes={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}]	Use this method to retrieve a list of task template entities via a query.
GET .../v1/taskTemplates/query/{query}/count[?domain={string}\|systemID={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&admin={boolean}]	Use this method to retrieve the number of task template entities in a query matching specified criteria.
GET .../v1/taskTemplate/{tktid}?systemID={string}	Use this method to retrieve a specific human task template.
GET .../v1/taskTemplate/{tktid}/input?systemID={string}	Use this method to retrieve an "empty" input for a task. This is useful when an input is prepared for a subsequent "create and start" scenario.
GET .../v1/taskTemplate/{tktid}/clientSettings/{type}?systemID={string}	Use this method to retrieve client settings for a human task template.
GET .../v1/taskTemplate/{tktid}/resource?systemID={string}&clientType={string}&resourceName={string}	Use this method to retrieve a client resource for a specified human task template.
GET .../v1/tasks/queries[?domain={string}\|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]	Use this method to retrieve a list of queries for task instance data.
GET .../v1/tasks/query/{query}/attributes[?domain={string}\|systemID={string}][&processAppName={string}]	Use this method to retrieve a list of attributes of a specified query for containing task instance data.
GET .../v1/tasks/query/{query}[?domain={string}\|systemID={string}][&selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]	Use this method to retrieve a list of task instance entities via a query.
GET .../v1/tasks/query/{query}/count[?domain={string}\|systemID={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]	Use this method to retrieve the number of task instance entities in a query matching specified criteria.
POST .../v1/task?systemID={string}&action={string}	Use this method to create an instance of a lean task.
PUT .../v1/task[?domain={string}\|systemID={string}]&action={string}&query={string}[&queryFilter={string}][&sortAttributes={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}][&maxRetryCount={integer}]	Use this method to claim the next task, selected based on filter criteria. If a task exists that are already claimed then this task is returned.
PUT .../v1/task[?domain={string}]&action={string}	Use this method to update the task properties, for example, the priority, category, or a custom property, for multiple task instances.
PUT .../v1/task[?domain={string}]&action={string}	Use this method to claim responsibility for multiple task instances.
PUT .../v1/task[?domain={string}]&action={string}	Use this method to release multiple claimed task instances.
PUT .../v1/task[?domain={string}]&action={string}[&deadline={string}][&duration={string}]	Use this method to suspend multiple task instances.
PUT .../v1/task[?domain={string}]&action={string}&keepTaskData={boolean}[&deadline={string}][&duration={string}]	Use this method to suspend one or more claimed tasks until a specified point in time or for a specified time period, and cancel the claim when the tasks are automatically resumed.
PUT .../v1/task[?domain={string}]&action={string}	Use this method to resume multiple suspended task instances.
GET .../v1/task/actions[?domain={string}]&taskIDs={string}[&actions={string}]	Retrieve available actions for human tasks.
PUT .../v1/task/role/{role}[?domain={string}]&action={string}[&toUser={string}][&fromUser={string}][&toGroup={string}][&fromGroup={string}]	Use this method to transfer multiple task instances.
GET .../v1/task/{tkiid}?systemID={string}	Use this method to retrieve details of a specified human task.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}	Use this method to update the properties of a task, for example, the priority, category, or a custom property.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}&mode={string}[&relation={string}][&parentTaskID={string}]	Use this method to start a new task using a synchronous (call) or asynchronous (start) operation.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}	Use this method to claim the responsibility for a task.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}	Use this method to release a claimed task.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}[&faultName={string}]	Use this method to complete a task with output or fault data.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}[&deadline={string}][&duration={string}]	Use this method to suspend a task until a specified point in time, for a specified time period, or indefinitely.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}&keepTaskData={boolean}[&deadline={string}][&duration={string}]	Use this method to suspend a claimed task until a specified point in time or for a specified time period, and cancel the claim when the task is automatically resumed.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}	Use this method to resume the processing of a suspended task.
PUT .../v1/task/{tkiid}?systemID={string}&action={string}	Use this method to terminate a task instance.
DELETE .../v1/task/{tkiid}?systemID={string}	Use this method to delete a task instance.
GET .../v1/task/{tkiid}/input?systemID={string}[&new={boolean}]	Use this method to retrieve the input for a task.
PUT .../v1/task/{tkiid}/input?systemID={string}	Use this method to set the input for a task.
GET .../v1/task/{tkiid}/output?systemID={string}[&new={boolean}]	Use this method to retrieve a task's output.
PUT .../v1/task/{tkiid}/output?systemID={string}	Use this method to set the output for a task. Note that this operation deletes any output or fault data that was previously set.
GET .../v1/task/{tkiid}/subtasks?systemID={string}	Use this method to retrieve a list of subtasks.
POST .../v1/task/{tkiid}/binaryCustomProperty/{name}?systemID={string}[&type={string}][&query={string}][&allowUpdate={boolean}]	Use this method to create a new binary custom property for a specified task.
GET .../v1/task/{tkiid}/binaryCustomProperty/{name}?systemID={string}	Use this method to retrieve the value of a binary custom property of a task.
PUT .../v1/task/{tkiid}/binaryCustomProperty/{name}?systemID={string}[&type={string}][&query={string}][&allowCreate={boolean}]	Use this method to set the value of a binary custom property of a task.
GET .../v1/task/{tkiid}/binaryCustomProperty/{name}/metadata?systemID={string}	Use this method to retrieve the metadata information of a binary custom property of a task.
GET .../v1/task/{tkiid}/role/{role}?systemID={string}	Use this method to retrieve user(s) or group(s) associated with a task's role.
PUT .../v1/task/{tkiid}/role/{role}?systemID={string}&action={string}[&toUser={string}][&fromUser={string}][&toGroup={string}][&fromGroup={string}]	Use this method to transfer a task to another user or group.
PUT .../v1/task/{tkiid}/role/{role}?systemID={string}&action={string}&newUser={string}	Use this method to assign a new user to a task role.
GET .../v1/task/{tkiid}/clientSettings/{type}?systemID={string}	Use this method to retrieve client settings for a human task instance.
GET .../v1/task/{tkiid}/history?systemID={string}[&newEventType={boolean}]	Use this method to retrieve the history of a human task instance.
GET .../v1/escalations/queries[?domain={string}\|systemID={string}][&all={boolean}][&processAppName={string}][&content={string}]	Use this method to retrieve a list of queries for escalation data.
GET .../v1/escalations/query/{query}/attributes[?domain={string}\|systemID={string}][&processAppName={string}]	Use this method to retrieve a list of attributes of a query for escalation data.
GET .../v1/escalations/query/{query}[?domain={string}\|systemID={string}][&selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}]	Use this method to retrieve a list of escalation entities via a query.
GET .../v1/escalations/query/{query}/count[?domain={string}\|systemID={string}][&queryFilter={string}][&processAppName={string}][&admin={boolean}]	Use this method to retrieve the number of escalation entities in a query matching specified criteria.
GET .../v1/escalation/actions[?domain={string}\|systemID={string}]&taskIDs={string}[&actions={string}]	Use this method to retrieve available actions for escalations.
GET .../v1/processApps[?domain={string}\|systemID={string}]	Use this method to retrieve the process applications that are installed in the system.
GET .../v1/processApps[?domain={string}\|systemID={string}]	Use this method to retrieve the process applications that are installed in the system.
GET .../v1/systems[?domain={string}\|systemID={string}]	Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
GET .../v1/systems[?domain={string}\|systemID={string}]	Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).

Subtopics

The following subtopics describe the REST resources defined for this resource set:

Process Template Queries [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of queries for process template data.
Process Template Query Attributes [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of attributes of a query for process template data.
Process Template Query Entity List [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of process template entities obtained via a query.
Process Template Query Entity List Count [new in 7.5.1]

This IBM Business Process Manager federated resource represents the number of process template entities in a query meeting specified criteria.
Process Instance Queries

This IBM Business Process Manager federated resource represents a list of queries for process instance data.
Process Instance Query Attributes

This IBM Business Process Manager federated resource represents a list of attributes of a query for process instance data.
Process Instance Query Entity List

This IBM Business Process Manager federated resource represents a list of process instance entities obtained via a query.
Process Instance Query Entity List Count

This IBM Business Process Manager federated resource represents the number of process instance entities in a query meeting specified criteria.
Process Instance

This IBM Business Process Manager federated resource represents a process instance.
Activity Instance Queries [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of queries for activity instance data.
Activity Instance Query Attributes [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of attributes of a query for activity instance data.
Activity Instance Query Entity List [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of activity instance entities obtained via a query.
Activity Instance Query Entity List Count [new in 7.5.1]

This IBM Business Process Manager federated resource represents the number of activity instance entities in a query meeting specified criteria.
Activity Instance

This IBM Business Process Manager federated resource represents an activity instance.
Task Template Queries

This IBM Business Process Manager federated resource represents a list of queries for task template data.
Task Template Query Attributes

This IBM Business Process Manager federated resource represents a list of attributes of a query for task template data.
Task Template Query Entity List

This IBM Business Process Manager federated resource represents a list of task template entities obtained via a query.
Task Template Query Entity List Count

This IBM Business Process Manager federated resource represents the number of task template entities in a query meeting specified criteria.
Task Template

This IBM Business Process Manager federated resource represents a specific task template with all of its properties, for example, its description, the type of task, and the valid-from-time of the task.
Task Template Input

This IBM Business Process Manager federated resource represents a task's input.
Task Template Client Settings

This IBM Business Process Manager federated resource represents the client settings for a specific task template. For example, you can use this resource to return the settings for a Lotus Forms-based client.
Task Template Client Resource

This IBM Business Process Manager federated resource represents a client resource for a specific task template, for example, a Lotus Forms definition for a task template.
Task Instance Queries

This IBM Business Process Manager federated resource represents a list of queries for task instance data.
Task Instance Query Attributes

This IBM Business Process Manager federated resource represents a list of attributes of a query for task instance data.
Task Instance Query Entity List

This IBM Business Process Manager federated resource represents a list of task instance entities obtained via a query.
Task Instance Query Entity List Count

This IBM Business Process Manager federated resource represents the number of task instance entities in a query meeting specified criteria.
Task

This IBM Business Process Manager federated resource represents an abstract human task. It is used for creating task instances and performing bulk operations on multiple task instances.
Task Actions

This IBM Business Process Manager federated resource represents a list of actions that can be performed on task instances.
Task Role

This IBM Business Process Manager federated resource represents a human task role. It is used to perform bulk transfers of multiple task instances.
Task Instance

This IBM Business Process Manager federated resource represents a human task. It is used to view details of a task, check its status, roles, progress, priority etc., or to change task properties, such as its priority, its category or a custom property.
Task Instance Input Data

This IBM Business Process Manager federated resource represents a task's input.
Task Instance Output Data

This IBM Business Process Manager federated resource represents the output of a human task. Note that an output does not exist if the task's interface refers to a one-way operation.
Task Instance Subtask List

This IBM Business Process Manager federated resource represents a list of subtasks for a specified task instance.
Task Instance Binary Custom Property

This IBM Business Process Manager federated resource represents a binary custom properties for a task.
Task Instance Binary Custom Property Metadata

This IBM Business Process Manager federated resource represents the metadata of a binary custom property of a human task.
Task Instance Role

This IBM Business Process Manager federated resource represents a role for a human task. It supports the retrieval of user(s) or group(s) associated with a task role, and the management of these assignments.
Task Instance Client Settings

This IBM Business Process Manager federated resource represents the client settings for a specific task instance. For example, you can use this resource to return the settings for a Lotus Forms-based client.
Task Instance History

This IBM Business Process Manager federated resource represents the history log of a specific task instance, that is, a list of all operations performed for this task.
Escalation Queries [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of queries for escalation data.
Escalation Query Attributes [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of attributes of a query for escalation data.
Escalation Query Entity List [new in 7.5.1]

This IBM Business Process Manager federated resource represents a list of escalation entities obtained via a query.
Escalation Query Entity List Count [new in 7.5.1]

This IBM Business Process Manager federated resource represents the number of escalation entities in a query meeting specified criteria.
Escalation Actions [new in 7.5.1]

This IBM Business Process Manager resource represents a list of actions that can be performed on escalation instances.
Process Applications (Process Resources) [new in 7.5.1]

This IBM Business Process Manager resource is used to retrieve the list of installed process applications in the system.
Process Applications (Task Resources) [new in 7.5.1]

This IBM Business Process Manager resource is used to retrieve the list of installed process applications in the system.
Systems Metadata (Process Resources)

This IBM Business Process Manager federated resource represents one or more WebSphere Process Server installations (single server or cluster).
Systems Metadata (Task Resources)

This IBM Business Process Manager federated resource represents one or more WebSphere Process Server installations (single server or cluster).

Parent Topic: IBM Business Process Manager REST Interface