Get instance information: GET /Instances

Get all instances and instance metadata


VERB
Header
Resource/Id/Selector
Description
Parameters
Return data
GET
Ticket
/Instances

List available process instances. Filter active and completed instances by Status ['completed', 'active', 'ready', 'cancelled', 'aborted']

(Status (string))

(Start (int))

(Max (int)) 

Totalcount (int)

Data (array):

Id (string)

Name (string)

Description (string)

Status (string)

(Milestone (string))

StartDate (date)

StartedBy (string)

CompletedDate (date)

ApplicationName (string)


On error:

If no instances are available then an empty array is returned.

GET
Ticket
/Instances/{Id}
Get metadata for a process instance
Id (string)

Object:

Id (string)

Name (string)

Description (string)

Status (string)

(Milestone (string))

StartDate (date)

StartedBy (string)

StartedByUserId (string)

CompletedDate (date)

Priority (string)

PlannedDate (date)

DeadlineDate (date)

ApplicationId (string)

ApplicationName (string)

ParentInstanceName (string)

ParentInstanceId (string)

GET
Ticket
/Instances/{Id}/Objects
Lists available objects in an instance, such as typed objects, files and folders

Id (string)

(Start (int))

(Max (int)) 

Totalcount (int)

Data (array):

Id (string)

Name (string)

Description (string)

ObjectClass (string)

Container (bool)

(FileType (string))


On error:

If no objects are available then an empty array is returned.

GET
Ticket
/Instances/{Id}/Objects/{ObjectId}

Gets metadata for an object in an instance, such as a typed object, a file or a folder.


The /Objects API should be used for most operations on objects in instances. 

Id (string)

ObjectId (string)

(VersionId (string)) 

Object:

Id (string)

Name (string)

Description (string)

ObjectClass (string)

Container (bool)

(FileType (string))

GET
Ticket
/Instances/{Id}/Tasks
Lists available tasks in an instance.

Id (string)

(Start (int))

(Max (int))

(Status (string))

Totalcount (int)

Data (array):

Id (string)

Name (string)

Description (string)

Status (string)

CreatedDate (date)

CompletedDate (date)

CompletedBy (string)

InstanceName (string)

ApplicationName (string)

Participants (string)

Locked (bool)

PerformPermission (bool)


On error:

If no tasks are available then an empty array is returned.

GET
Ticket
/Instances/{Id}/Tasks/{TaskId}
Gets metadata for a task in an instance  

Id (string)

TaskId (string) 

Object:

Id (string)

Name (string)

Description (string)

Status (string)

CreatedDate (date)

CompletedDate (date)

CompletedBy (string)

CompletedByUserId (string)

InstanceName (string)

InstanceId (string)

ApplicationName (string)

ApplicationId (string)

Locked (bool)

PerformPermission (bool)

GET
Ticket
/Instances/{Id}/Image
Get the image rendition for a process model with extra information about the running instance.

Id (string)

(ZoomFactor (float))

(Width (int))

(Height (int)) 

Binary data:

PNG image


Send information to instances: POST /Instances

Get all instances and instance metadata


VERB
Header
Resource/Id/Selector
Description
Parameters
Return data
POST
Ticket
/Instances/{Id}/Objects
Adds/uploads a file, folder or form to an instance folder (to the root folder of the instance)

Type (string)

Name (string)

TemplateId (string)

Fields (array)

(Data (object/binary)) 

Object:

Success (bool)

Id (string)

POST
Ticket
/Instances/{Id}
Sends a named message to a process instance to trigger an intermediate event. The message must be named by using the Message parameter. The Success return value will return True if the message was sent successfully. Use the Objects and Instances API to update data in running instances.

If you want to post to a Boundary Intermediate Event you must add the message parameter as a querystring with your POST (e.g. /Instances/{Id}?message={Message}).

Boundary events cannot receive Data.

Id (string)

Message (string) 

(Data (object/binary))


Object:

Success (bool)


Delete an Instance: DELETE /Instances/{Id}

Delete an instance and all content such as tasks, forms, uploaded files.


VERB
Header
Resource/Id/Selector
Description
Parameters
Return data
DELETE
Ticket
/Instances/{Id}

Deletes an existing instance by sending a HTTP DELETE to an existing resource URL. It is currently not possible to delete multiple instances at the same time.


Warning! If an instance is deleted all objects within the instance will also be deleted, such as typed objects, files and folders. 

Id (string)

Object:

success (bool)