BPM OData Service for Accessing BPM Processes

With the BPM OData service you can easily implement a custom UI with remote access to BPM processes.

You can perform the following operations:
  • Read an active process definition
  • Read a process instance
  • Read a collection of processes
  • Cancel a process
  • Suspend a process
  • Resume a process

Entity Model

A number of entities are used in the BPM Processes OData service to store process-related information.

The definition of an active process is represented as an ActiveProcessDefinition entity with the following properties:
Property Description

vendor

Development component vendor name of the process definition

dcName

Development component name of the process definition

processTechnicalName

Technical name of the process definition

id

Unique identifier of the process definition

modelId

Unique identifier of the process model

name

Name of the process definition

isConditionalStart

Indicates whether the process definition is implementing a conditional start pattern

Information about process instances is stored as a ProcessInstance entity, which contains the following properties:
Property Description

InstanceId

Unique identifier of the process instance

Name

Name of the process instance

Subject

Subject of the process instance

StartDate

Time when the process instance was started

EndDate

Time when the process instance was ended

ModelId

Unique identifier of the process model

DefinitionId

Unique identifier of the process definition

Status

Status of the process instance

ParentProcessInstanceId

Unique identifier of the parent process instance

RootProcessInstanceId

Unique identifier of the root process instance

ProcessInitiatorName

Name of the user who initiated the creation of the process instance