fhunth

Nintex Workflow Web Service Methods

Blog Post created by fhunth Champion on Jan 6, 2017

Web Service Reference

The following section provides an overview, and describes the service operations and data types, of the Workflow web service included with Nintex Workflow 2013.

The Workflow web service provides administrative functionality for Nintex Workflow 2013. You can perform many of the functions normally managed for NintexWorkflow 2013 through SharePoint Central Administration and the Workflow designer, including:

  • Exporting, saving, and publishing workflows

  • Starting and terminating workflows

  • Scheduling workflows

  • Retrieving information about running workflow tasks

  • Processing and delegating task responses for workflow tasks, including Flexi task tasks.

  • Retrieving workflow history for workflows

Service endpoint

The following URL represents the service endpoint for the Workflow web service, where <site> represents the SharePoint site used to establish context for the service operations provided by the endpoint.

http://<site>/_vti_bin/NintexWorkflow/Workflow.asmx

The value specified for <site> is important, in that it both defines and limits the execution context of the service operations for the Workflow web service. For example, if you want to export a site workflow associated with the SharePoint site collection, you must specify the root URL of the site collection in <site>.

Invoking service operations

You can use any invocation method supported by Simple Object Access Protocol (SOAP) 1.2 to invoke the service operations provided by the Workflow web service. For example, you can generate a Windows Communication Foundation (WCF) client in Visual Studio, which in turn can be used to create a WCF client channel and communicate with the service operations provided by the Workflow web service, or you can add a service reference to the service endpoint for the Workflow web service in a Visual Studio project, which automatically generates a WCF client that you can use to access the Workflow web service.

A detailed discussion of SOAP invocation and WCF client implementation is beyond the scope of this document. However you can find a code sample and basic implementation of a WCF client that communicates with the Nintex Workflow endpoints, at Export and publish a workflow with the Nintex Workflow SOAP Web Service.

For more information about WCF client implementation in Visual Studio, see Windows Communication Foundation Services and WCF Data Services in Visual Studio, on Microsoft Developer Network.

Service operation examples

The examples provided for each service operation represent the SOAP envelope for each request and response, in its native XML structure, for the purposes of readability.

Service operations

AddLongTermDelegationRule

AddWorkflowSchedule

AddWorkflowScheduleOnListItem

CheckGlobalReuseStatus

CheckInForms

DelegateAllTasks

DelegateTask

DeleteLongTermDelegationRule

DeleteSnippet

DeleteWorkflow

ExportWorkflow

FixWorkflowsInSiteFromTemplate

GetFolders

GetItemsPendingMyApproval

GetListContentTypes

GetOutcomesForFlexiTask

GetRunningWorkflowTasks

GetRunningWorkflowTasksCollection

GetRunningWorkflowTasksForCurrentUser

GetRunningWorkflowTasksForCurrentUserForListItem

GetRunningWorkflowTasksForListItem

GetTaskDetailsUsingStub

GetTaskStubsForCurrentUser

GetWorkflowHistory

GetWorkflowHistoryForListItem

GetWorkflowXoml

HideTaskForApprover

HideWorkflow

ProcessFlexiTaskResponse

ProcessFlexiTaskResponse2

ProcessTaskResponse

ProcessTaskResponse2

ProcessTaskResponse3

ProcessTaskResponseUsingToken

PublishFromNWF

PublishFromNWFNoOverwrite

PublishFromNWFSkipValidation

PublishFromNWFSkipValidationNoOverwrite

PublishFromNWFXml

PublishFromNWFXmlNoOverwrite

PublishFromNWFXmlSkipValidation

PublishFromNWFXmlSkipValidationNoOverwrite

PublishWorkflow

QueryForMessages

RemoveWorkflowSchedule

RemoveWorkflowScheduleOnListItem

SaveFromNWF

SaveFromNWFNoOverwrite

SaveFromNWFXml

SaveFromNWFNoOverwrite

SaveSnippet

SaveTemplate

SaveTemplate2

SaveWorkflow

SnippetExists

StartSiteWorkflow

StartWorkflow

StartWorkflowOnListItem

TemplateExists

TerminateWorkflow

TerminateWorkflowByName

TerminateWorkflowByNameForListItem

WorkflowExists

WorkflowFormProductSelected

Data types

ContentType

Folder

ItemsPendingApproval

ProcessTaskResponseResult

WorkflowTaskDetail

 

Outcomes