Edit

getProcessInstances (Client API reference)

  • Article

Returns all the process instances for the table record that the calling user has access to.

Syntax

formContext.data.process.getProcessInstances(callbackFunction(object));

Parameter

Name Type Required Description
callbackFunction Function Yes The callback function is passed an object with the following columns and their corresponding values as the key: value pair. All returned values are of String type except for CreatedOnDate, which is of Date type.
- CreatedOn (deprecated)
- CreatedOnDate
- ProcessDefinitionID
- ProcessDefinitionName
- ProcessInstanceID
- ProcessInstanceName
- StatusCodeName

The process instances are filtered according to the user's privileges.

setActiveProcessInstance
formContext.data.process