GET /StartEvents

Gets available start events and metadata for creating instances.


VERB

Header

Resource/Id/Selector

Description

Parameters

Return data

GET

Ticket

/startevents

Lists all available startevents that the user can trigger

(Start(int))

(Max(int)) 

Total count (int)

Data (array):

Id (string)

Name (string)

Description (string)

ApplicationId (string)

ProcessId (string)

GET

Ticket

/startevents/{Id}

Fetches metadata for a specific startevent with information if about comments and assignable participants

Id (string)

Object:

Id (string)

Name (string)

Description (string)

ApplicationId (string)

ProcessId (string)

CanComment (bool)

MustComment (bool)

MustAssignPerformers (bool)

GET

Ticket

/startevents/{Id}/assignableparticipants

Lists the participants that must be assigned with performers when performing the action

Id (string)

(VersionId (string)) 

TotalCount (int):

Data (array):

Name (string)

Identifier (string)

GET

Ticket

/startevents/{Id}/assignableparticipants/{Id}

Lists available performers to choose and set to a specific participant

Id (string)

(VersionId (string)) 

TotalCount (int):

Data (array):

Name (string)

Identifier (string)

GET

Ticket

/startevents/{Id}/DataFormTemplates

Lists the data form templates that must be created when triggering the start event

Id (string)

(VersionId (string)) 

Array of data form template objects:

Id (string)

ReferenceId (string)

DataObjectId (string)

ObjectClass (string)

Name (string)

Description (string)

ViewMode (string)

GET

Ticket

/startevents/{Id}/DataFormTemplates/{Id}/fields

Lists all the fields for a dataformtemplate. The API will only return the fields that should be available for the user in the specific startevent depending on how the startevent and the dataformtemplate has been set up.

Id (string)

Data (array)

Id (string)

Name (string)

Description (string)

DataType (string)

FieldType (string)

FieldTypeNamespace (string)

ReadOnly (bool)

AllowBlank (bool)

Index (int)


POST /StartEvents

Starts a new process instance from a process applications specific start event.

To start an instance with a data form you have to use /apps.


VERB

Header

Resource/Id/Selector

Description

Parameters

Return data

POST

Ticket

/startevents/{Id}

Starts a new instance for the specific event


Clients must send the querystring instancename with a value that will be the name of the instance.


E.g.

POST /startevents/{Id}?instancename=name_of_instance


Assign participants with startevent


Participant assignment is set as a querystring in the /Startevents POST.


/startevents/{Id}

?participants=[{participant:'Id',securityIds:'Identifier'}]


Each participant that is to be assigned must be a separate JSON object in an array.


participant:'Id' is the Id of the participant to set which you get from /startevents/{Id}/assignableparticipants


securityIds:'Identifier' is the Id of the chosen performer to be set as a participant which you get from /startevents/{Id}/assignableparticipants/{Id}



Id (string)

instancename (string)

(instancedescription (string))

(Comment (string))

(Participant Assignments (array)) 

success (bool)

items (array)

success (bool)

ObjectClass (string)

Name (string)

Id (string)

ReferenceId (string)