REST API - listProcessInstances

Request

Format	GET <baseurl>/process/list/instance/<module>/<process>/<version>
Path parameters	module: Name of the module to which the process template belongs. process: Name of the process template whose instances are to be returned. version: OSGi-style version number of the process template. (This version number is the same as that of the module.) These parameters can be obtained from listProcessTemplates , queryProcessTemplates , and queryProcessTemplatesAlt .

Response

JSON	Returns a JSON representation of the content of the processInstances element.
XML	Returns the content of the processInstances element (from the ProcessManagement schema).

Example

Request

GET <baseurl>/process/list/instance/HelpDesk%2FProcess%20Packages%2FHelpDesk.xpdl/InternalHelpDeskA/1.0.0.201210231049

Response

{

  "proc:processInstance": {

    "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",

    "proc:processQName": {

      "proc:moduleName": "/HelpDesk/Process Packages/HelpDesk.xpdl",

      "proc:processName": "InternalHelpDeskA",

      "proc:version": "1.0.0.201210231049"

    },

    "proc:id": "pvm:0a12m",

    "proc:state": "ACTIVE",

    "proc:startTime": "2013-01-18T10:23:31.250-08:00",

    "proc:completionTime": {

      "@xsi:nil": "true",

      "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance"

    },

    "proc:waitingWorkCount": "1"

  }

}