SP.WorkflowServices.WorkflowInstanceService object (sp.workflowservices)

Reads the SharePoint workflow instances from the external workflow host and manages the instance execution.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.WorkflowServices.WorkflowInstanceService()

Members

The WorkflowInstanceService object has the following members.

The WorkflowInstanceService object has the following constructor.

Constructor	Description
WorkflowInstanceService	Initializes a new instance of the WorkflowInstanceService object.

The WorkflowInstanceService object has the following methods.

Method	Description
cancelWorkflow	Sends a cancel message to the specified workflow instance and permits the instance to execute a cancellation scope.
countInstances	Retrieves a count of all the instances of the specified WorkflowSubscription.
countInstancesWithStatus	Retrieves a count of the instances of the specified WorkflowSubscription that have a specified status.
enumerate	Gets a workflow instance collection comprising the 100 most recent workflow instances started by a specified subscription.
enumerateInstancesForListItem	Retrieves all instances of the specified list item.
enumerateInstancesForListItemWithOffset
enumerateInstancesForSite	Retrieves the site-scope workflow instances for the current site.
enumerateInstancesForSiteWithOffset
enumerateWithOffset
getDebugInfo	Retrieves the debug information for the specified workflow instance in JSON format.
getInstance	Gets a workflow instance from external workflow instance store by specified id.
resumeWorkflow
startWorkflow	Starts a Workflow Manager Client 1.0 instance specified by the subscription and passes the supplied parameters.
startWorkflowOnListItem	Starts a Workflow Manager Client 1.0 instance of the specified WorkflowSubscription on the list item.
suspendWorkflow
terminateWorkflow	Terminate a workflow instance forcefully by deleting it from memory. The instance is not allowed to execute a cancellation scope.

The WorkflowInstanceService object has the following properties.