REST API for BPM–Start a BPD using POST Method in IBM BPM

Introduction:

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 resources in this IBM Business Process Manager resource set to develop client applications that you can use to work with business processes and tasks. These business processes and tasks are hosted by the business process definition (BPD) runtime environment.

Ø Business process definitions (BPD) and process instances

Ø External activities and services

Ø Tasks

Ø Users and groups

Ø Saved searches and custom searches

Ø Asset lists

Ø Process application settings

Ø Asset details

Ø Snapshot change histories

Ø Snapshot change history comparisons

Overview:

This IBM Business Process Manager resource is used to retrieve the list of installed process applications in the system and create new process applications. Here we are going to describe how to start a BPD using IBM BPM Rest API.

Sample URI:

POST /rest/bpm/wle/v1/process?action={string}&bpdId={string}[&snapshotId={string}][&branchId={string}][&processAppId={string}][&params={string}][&parts={string}][&mode={string}]

Parameters

Note: To identify the correct snapshot to be used, you must specify one of the snapshotId, branchId, or processAppId parameters.

The following precedence rules apply:

1) If the snapshotId parameter is specified, that specific snapshot is used and the branchId and processAppId parameters are ignored.

2) If the branchId parameter is specified, the tip (current) snapshot of the specified branch (track) is used and the processAppId parameter is ignored.

3) If the processAppId parameter is specified, the tip (current) snapshot of the default branch (track) within that process application is used.

Required parameters

Name

Value Type

Description

action

string

The action to perform on the process.

Value	Description
start	Start a new instance of a process.

bpdId

string

The identifier of the business process definition to be used.

Optional parameters

Name

Value Type

Description

snapshotId

string

The identifier of the snapshot that contains the business process definition. You must set one of the snapshotId, branchId, or processAppId parameters.

branchId

string

The identifier of the branch that contains the business process definition. If this parameter is specified, the tip snapshot of the specified branch is used. You must set one of the snapshotId, branchId, or processAppId parameters.

processAppId

string

The identifier of the process application that contains the business process definition. If this parameter is specified, the tip snapshot of the default branch within the specified process application is used. You must set one of the snapshotId, branchId, or processAppId parameters.

params

string

A string containing a JSON expression that contains one or more input parameter settings. Each of the variables in the context of the running process.

Example:

params={"orderNumber":"5","customerName":"Doe"}}

parts

string

A string indicating which parts of the response data should be returned. You can specify multiple part names by separating the values with the '|' character. You can use the following values:

header
summary
data
dataModel
diagram
executionTree
actions
relationships
excludeDocs
all (default)
none

mode

string

A string indicating whether the process should be started in run or debug mode.

Value	Description
run	Start a new instance of a process normally. If no parameter is specified, this is the default.
debug	Start a new instance of a process in debug mode.

Simple Example:

Please find the attached screenshots which shows starting a BPD using rest API.

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The process does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred, programmer's details are provided.

Download:

S. No	File Name	Size	Download
1	REST API for BPM – Start a BPD using POST Method in IBM BPM.pdf	900 KB	Download

Home