API usage examples

Triggering a start event via the API


Common API calls

These examples are meant to illustrate how a few common API calls can look. Please study the API Documentation section for a complete description of each API method. Note that the examples refer to Id’s that are fictional.


API Call Description

POST /API/v1.0/Authenticate

Authenticates against the service using the POST parameters:

APIKey={API_KEY}&Username={USER_NAME}&Password={PASSWORD}

POST /API/v1.0/Apps/{process application id}

Starts a new process instance by sending a HTTP POST to the {process application id} process application. Create new objects in the instance by specifying object entry/entries in the request body. See the Applications API for more information.

GET /API/v1.0/Instances

Gets a list of all available instances (An instance is the same as a Workflow/Case)

GET /API/v1.0/Instances/cabda881-8412-47a8-b48d-158b4de54304

Gets info for the instance with Id=cabda881-8412-47a8-b48d-158b4de54304

GET /API/v1.0/Instances/cabda881-8412-47a8-b48d-158b4de54304/Objects

Gets a list of all objects stored in the instance with Id=cabda881-8412-47a8-b48d-158b4de54304, such as forms, files and folders

GET /API/v1.0/Objects/4d82ad9b-60db-403c-94eb-b98a15990f1f 

Gets info for the object with Id=4d82ad9b-60db-403c-94eb-b98a15990f1f

GET /API/v1.0/Objects/4d82ad9b-60db-403c-94eb-b98a15990f1f/Fields

Gets all fields for the object with Id=4d82ad9b-60db-403c-94eb-b98a15990f1f