Share via

SP.WorkflowServices.WorkflowInstanceService.startWorkflowOnListItem Method (sp.workflowservices)

  • Article

Starts a Workflow Manager Client 1.0 instance of the specified WorkflowSubscription on the list item.

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

SP.WorkflowServices.WorkflowInstanceService.startWorkflowOnListItem(subscription, itemId, payload)

Return value

Returns the workflow instance to be started, with id of the list item on which to start.

Parameters

  • subscription
    The subscription associated with the workflow instance.

  • itemId
    The integer id of the list item on which to start the workflow instance.

  • payload
    The IDictionary object that contains name-value pairs of parameter names and values to pass into the workflow instance.