Previous Topic: The Process Manager Web Service

Next Topic: updateActor Operation

getInstancesByStatus

Description

Returns an array of instances for the process definition selected by status. This returns an array of process instances known by the process manager. Each array element is an XML document representing the Process Instance Descriptor, rather than an entire process instance. The format of a Process Instance Descriptor is shown under the description of getInstances.

Syntax
public java.lang.String  getInstancesByStatus (java.lang.String sessionID, java.lang.String definitionID, java.lang.Long from, java.lang.Long to, java.lang.int status)
throws PMServiceException
Parameters

Parameter

Type

Description

sessionID

string

Specifies the session ID returned by the login operation

definitionID

string

Specifies the process definition ID

from

long

Specifies the date from which to start listing instances

to

long

Specifies the date to which instances should be listed

status

int

Specifies the status that instances must have to be listed. See “Process Instance Status” that follows for more information

Return

An array of ProcessInstance objects expressed as XML documents

Exception Thrown

PMServiceException