process-instances

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmProcessInstanceDto>.

Field	Declared type	Nullable
Id	Guid	no
ProcessInstanceKey	long	no
BpmnProcessId	string	no
ProcessName	string	no
VersionNo	int	no
ProcessDefinitionKey	long	no
InstanceState	string	no
StartDate	DateTime?	yes
EndDate	DateTime?	yes
ProcessDefinitionId	Guid	no
ParentProcessInstanceKey	long	no
XmlResource	string	no
UsageType	int?	yes
ProcessPriority	int?	yes

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<ProcessInstanceStarterDto>.

Field	Declared type	Nullable
ProcessInstanceKey	long	no
CorrelationId	Guid	no
StarterUserCode	string	no
FormId	Guid	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
Id	id	Guid	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_BPM_24	400	PROCESS_INSTANCE_STARTER_ALREADY_EXISTS	Process Instance Starter already exists.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as BpmProcessInstanceDto.

Field	Declared type	Nullable
Id	Guid	no
ProcessInstanceKey	long	no
BpmnProcessId	string	no
ProcessName	string	no
VersionNo	int	no
ProcessDefinitionKey	long	no
InstanceState	string	no
StartDate	DateTime?	yes
EndDate	DateTime?	yes
ProcessDefinitionId	Guid	no
ParentProcessInstanceKey	long	no
XmlResource	string	no
UsageType	int?	yes
ProcessPriority	int?	yes

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmElementInstanceDto>.

Field	Declared type	Nullable
ElementInstanceKey	long	no
CreatedDate	DateTime	no
ElementState	string	no
FlowScopeKey	long	no
ElementId	string	no
BpmnElementType	string	no
StartDate	DateTime?	yes
EndDate	DateTime?	yes
JobType	string	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmProcessErrorDto>.

Field	Declared type	Nullable
ErrorEventPosition	long	no
CreatedDate	DateTime	no
ExceptionMessage	string	no
StackTrace	string	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmIncidentDto>.

Field	Declared type	Nullable
IncidentKey	long	no
ErrorMessage	string	no
ErrorType	string	no
ElementInstanceKey	long	no
JobKey	long	no
CreatedDate	DateTime	no
ResolvedDate	DateTime?	yes

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmJobDto>.

Field	Declared type	Nullable
Id	Guid	no
JobKey	long	no
StartDate	DateTime	no
EndDate	DateTime?	yes
ElementId	string	no
Worker	string	no
JobType	string	no
JobState	string	no
Retry	int	no
ElementInstanceKey	long	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmSubProcessDto>.

Field	Declared type	Nullable
ElementId	string	no
ElementInstanceKey	long	no
CalledProcessInstanceKey	long	no
CalledBpmnProcessId	string	no
CalledProcessInstanceState	string	no
ProcessDefinitionKey	long	no
ProcessId	Guid	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmTimerDto>.

Field	Declared type	Nullable
TimerKey	long	no
TimerState	string	no
Repetitions	int	no
CreatedDate	DateTime?	yes
DueDate	DateTime?	yes
ElementInstanceKey	long	no
ElementId	string	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmProcessVariableDto>.

Field	Declared type	Nullable
ElementId	string	no
ScopeKey	long	no
VariableState	string	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<BpmProcessVariableByFieldDto>.

Field	Declared type	Nullable
FieldCode	string	no
FieldValue	string	no
CreatedDate	DateTime	no

Member names are the service's declaration names.