Get process application information: GET /Apps

Get metadata and information for process applications.


VERB
Header
Resource/Id/Selector
Description
Parameters
Return data
GET
Ticket
/Apps
Lists available process applications
(Start (int))
(Max (int))
TotalCount (int)

Data (array):
Id (string)
Name (string)
Description (string)
Status (string)
InstancesCount (int)
GET
Ticket
/Apps/{Id}
Gets metadata for a process application
Id (string)Object:
Id (string)
Name (string)
Description (string)
Status (string)
InstancesCount (int)
GET
Ticket
/Apps/{Id}/Instances

Lists available process instances in a process application. Filter instances by Status ['completed', 'active', 'ready', 'cancelled', 'aborted']

Id (string)
(Start (int))

(Max (int)) (Status (string))

Totalcount (int)

Data (array):
Id (string)
Name (string)
Description (string)
Status (string)
StartDate (date)
StartedBy (string)


Start a new process instance: POST /Apps

Trigger a process applications specific start event to start a new process instance of the process application


EXAMPLE HTTP REQUEST:

POST /api/v1.0/apps/{PROCESS APPLICATION ID}

Content-Type: application/x-www-form-urlencoded

template={TEMPLATE}&message={START EVENT MESSAGEREF NAME}&field1=201-1101&field2=Barium+AB


VERB
Header
Resource/Id/Selector
Description
Parameters
Return data
POST
Ticket
/Apps/{Id}
Sends a named message to a process application to trigger a start event. The message must be named by using the Message parameter (otherwise the default message name will be "START"). The message name corresponds to a Message Start Event with the MessageRef.Name property. Also, if form data is sent when starting an instance the parameter "template" (the template associated to the start event in the process model) cannot be empty, it can be set as anything. Most commonly, the data form object ID is used.


All HTTP POST-requests except for file uploads must include the HTTP Header "Content-Type" set to "application/x-www-form-urlencoded"
All HTTP POST parameters except for file uploads must be URL-encoded as "x-www-form-urlencoded"


Field sent as HTTP POST parameters and are separated by ampersand character:
field1=201-1101&field2=Barium+AB
Id (string)
Message (string)
Template (string)
(Data (object))
Object:

Success (bool)
(InstanceId (string))