URIs for Starting BPM Processes

Get metadata of the process start data

GET /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/$metadata

The response body provides metadata of the process start data. The returned metadata provides information about the structure of the process start data.

Get information about a process that is to be started

GET /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/StartData

GET /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/StartData(vendor='<vendor>',dcName='<dc-name>',processTechnicalName=<process-technical-name>')

The response body provides information about the process definition of the vendor with the name <vendor>, located in the development component with the name <dc-name>, and with the name <process-technical-name>.

Get process start data

GET /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/StartData?$expand=ProcessStartEvent/<start_data_type_name>

GET /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/StartData(vendor='<vendor>',dcName='<dc-name>',processTechnicalName=<process-technical-name>')?$expand=ProcessStartEvent/<start_data_type_name>

The response body provides the process start data that is needed to start a process for the specific process definition. It contains the process start event and an empty version of the data that is needed to start the process.

<start_data_type_name> is the name of the XSD type that was defined for the process start data at design time.

Start a process

POST /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/StartData

Request Body:

{
	"ProcessStartEvent": {
		"<start_data_type_name>": {
			<JSON object for start data entity>
		}
	}
}

*

The request body should contain an entity for the StartData entity type.

The response body contains the process start data of the started process along with the unique identifier of the process instance (ProcessInstanceId) started by the OData service.

Start a process

POST /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/ProcessStartEvent

Request Body:

{
	"<start_data_type_name>": {
		<JSON object for start data entity>
	}
}

*

The request body should contain an entity for the ProcessStartEvent entity type.

The response body contains the process start data of the started process.

Start a process

POST /bpmodata/startprocess.svc/<vendor>/<dc-name>/<process-technical-name>/<start_data_type_name>

Request Body:

{
	<JSON object for start data entity>
}

*

The request body should contain an entity for the <start_data_type_name> entity type.

The response body contains the process start data of the started process.