Process Instances

Note: See also Processes and Process Templates.
Resource Description
Halted process instances
GET <baseurl>/process/query/halted/instance/<query>/<pagesize> List process instances that have halted (as a result of an activity failure) that match certain criteria. (See queryHaltedProcessInstances.)
PUT <baseurl>/process/ignore/instance/<processid> ignore the failed activity and resume execution of a process instance that has halted as a result of an activity failure. (See ignoreProcessInstance.)
PUT <baseurl>/process/ignore/instances/<module>/<process>/<version> Ignore failed activities and resume the execution of all halted process instances for one or more process templates. (See ignoreProcessInstances.)
PUT <baseurl>/process/resume/halted/<processid> Resume execution of a process instance that has halted as a result of an activity failure. (See resumeHaltedProcessInstance.)
PUT <baseurl>/process/resume/halted/<module>/<process>/<version> Resume execution of all process instances for one or more process templates, where those instances have halted as a result of an activity failure. (See resumeHaltedProcessInstances.)
GET <baseurl>/process/instance/variables/<processid> Get the details for all variables (or for a specific variable) that are available to the failed activity for a particular halted process instance. (See getAvailableProcessInstanceVariables.)
PUT <baseurl>/process/set/instance/variables/<processid> Set the value of one or more variables that are available to the failed activity for a particular halted process instance. (See setAvailableProcessInstanceVariables.)
PUT <baseurl>/process/retry/instance/<processid> Resume execution of a process instance that has halted as a result of an activity failure, retrying the activity that caused the process instance to fail. (See retryProcessInstance.)
PUT <baseurl>/process/retry/instances/<module>/<process>/<version> Resume the execution of all halted process instances for one or more process templates, in each case retrying the activity that caused the process instance to fail. (See retryProcessInstances.)
Process instances
DELETE <baseurl>/process/cancel/<processid> Cancel a specific process instance. (See cancelProcessInstance.)
DELETE <baseurl>/process/cancel/<module>/<process>/<version> Cancel all process instances for one or more process templates. (See cancelProcessInstances.)
POST <baseurl>/process/create/<module>/<process>/<version>/<operation> Create a process instance using a starter operation. (See createProcessInstance.)
POST <baseurl>/process/start/<modulename>/<processname>/<version> Start an instance of a process template that was published as a REST Service in TIBCO Business Studio. (See createProcessInstance.)
GET <baseurl>/process/list/instance/<module>/<process>/<version> List process instances for one or more process templates. (See listProcessInstances.)
PUT <baseurl>/process/resume/<processid> Resume a previously suspended process instance. (See resumeProcessInstance.)
PUT <baseurl>/process/resume/<module>/<process>/<version> Resume all process instances for one or more process templates. (See resumeProcessInstances.)
PUT <baseurl>/process/suspend/<processid> Suspend a process instance from being scheduled for execution. (See suspendProcessInstance.)
PUT <baseurl>/process/suspend/<module>/<process>/<version> Suspend all process instances for one or more process templates from being scheduled for execution. (See suspendProcessInstances.)
Process instance activity deadlines
PUT <baseurl>/process/set/deadline/<exptime>/<activityid> Change the deadline value for an activity. (See setDeadlineExpiration.)
Process instance attributes
GET <baseurl>/process/param/value/<processid>/<parameter> Get the value of a specific parameter (also referred to as "custom attributes") for a particular process instance. (See getParameterValue.)
GET <baseurl>/process/list/instanceattributes/<module>/<process>/<version> List process instance attributes for one or more process templates. (See listProcessInstanceAttributes.)
GET <baseurl>/process/list/instance/<module>/<process>/<version> List process instance attributes for a set of process templates. (See listProcessInstances.)
Process instance migration
DELETE <baseurl>/process/delete/migrationrules/<module>/<process>/<version> Clear all currently set process instance migration rules for one or more process templates. (See clearMigrationRules.)
GET <baseurl>/process/migrationpoints/<module>/<process>/<version> List the permissible process instance migration points for one or more process templates. (See getMigrationPoints.)
GET <baseurl>/process/isset/migrationrules/<module>/<process>/<version>/<task> Test whether any process instance migration rules are set for a particular qualified task name. (See isSetMigrationRule.)
GET <baseurl>/process/list/migrationrules/<module>/<process>/<version> List the process instance migration rules that are set for one or more process templates. (See listMigrationRules.)
POST <baseurl>/process/set/migrationrules Set one or more process instance migration rules. (See setMigrationRules.)
PUT <baseurl>/process/unset/migrationrules Unset one or more currently set process instance migration rules. (See unsetMigrationRules.)
Process instance priority
PUT <baseurl>/process/set/priority/<processid>/<priority> Change the scheduling priority for execution of a process instance. (See setPriority.)
Process instance queries
GET <baseurl>/process/count/instance/<query> Count the number of process instances that match certain criteria. (See queryProcessInstanceCount.)
GET <baseurl>/process/query/instance/<query>/<pagesize> Query information about process instances that match specified criteria. (See queryProcessInstances.)
GET <baseurl>/process/query/instancealt/<select>/<where>/<orderby>/<pagesize> Query information about process instances that match specified criteria. (See queryProcessInstancesAlt.)

Note: This is a variation of queryProcessInstances , in which the query string is divided into its constituent parts.

Process instance statuses
GET <baseurl>/process/activity/status/<processid>/<activity> Get the status of an activity for a particular process instance. (See getActivityInstanceStatus.)
GET <baseurl>/process/status/<processid> Get the status of a particular process instance. (See getProcessInstanceStatus.)
GET <baseurl>/process/summary/<processid> Get a full summary report on a specific process instance. (See getProcessInstanceSummary.)