RemoveWorkflowScheduleOnListItem

Removes a workflow schedule for a reusable or list workflow from a list item in a SharePoint list.

Syntax

public bool RemoveWorkflowScheduleOnListItem(
	int itemId,
	string listName,
	string workflowName
)

Parameters

itemId
Type: System.Int32

Required. The identifier of the SharePoint list item.

listName
Type: System.String

Optional. The name of the SharePoint list.

workflowName
Type: System.String

Optional. The name of the reusable or list workflow.

Returns

Type: Boolean

true if the workflow schedule was successfully removed; otherwise, false if the workflow schedule was not found.

Remarks

If the workflow specified in workflowName does not exist, the method returns an error. Otherwise, the method returns true if an existing workflow schedule for the specified workflow is found and removed, or false if an existing workflow schedule for the specified workflow cannot be found.

Example

The following example demonstrates how to use this operation to remove a workflow schedule for a list workflow from a list item in a list.

Request

The following SOAP request attempts to remove a workflow schedule for the Test Workflow list workflow on the TestContacts1 list, for the list item with an identifier of 2.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:nin="http://nintex.com">
   <soap:Header/>
   <soap:Body>
      <nin:RemoveWorkflowScheduleOnListItem>
         <nin:itemId>2</nin:itemId>
         <nin:listName>TestContacts1</nin:listName>
         <nin:workflowName>Test Workflow</nin:workflowName>
      </nin:RemoveWorkflowScheduleOnListItem>
   </soap:Body>
</soap:Envelope>

Response

The following SOAP response indicates that a workflow schedule for the specified list workflow was found and removed from the specified list item.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <RemoveWorkflowScheduleOnListItemResponse xmlns="http://nintex.com">
         <RemoveWorkflowScheduleOnListItemResult>true</RemoveWorkflowScheduleOnListItemResult>
      </RemoveWorkflowScheduleOnListItemResponse>
   </soap:Body>
</soap:Envelope>

See Also

Concepts

Workflows

Operations

Managing workflow schedules

Reference

RemoveWorkflowSchedule

Web Service Reference