This guide takes you through the REST resources and operations included with the Nintex Workflow for Office 365 REST API, providing examples that you can use in Visual Studio 2013.
Representational State Transfer (REST) is a methodology for implementing scalable web services. REST emphasizes a stateless, cacheable implementation with a uniform interface, typically accessed using Hypertext Transfer Protocol (HTTP). The REST service decouples the client from the server, by providing access to REST resources, each of which is accessed by using a Universal Resource Identifier (URI) that identifies that particular REST resource.
A REST resource is typically accessed by using HTTP methods, such as GET and PUT, to send and receive self-descriptive messages between the client and the REST service. These messages are typically expressed using Hypertext Markup Language (HTML), Expressive Markup Language (XML), or JavaScript Object Notation (JSON). The messages are self-descriptive in that each message includes enough information to describe how to process the message, and contains representations of information with which the client or the REST resource can interact. For example, the NintexWorkflow for Office 365 REST API does not connect a client directly to NintexWorkflow for Office 365, but instead serves as an intermediary between the two, interacting with representations of information, such as workflows and export files, exchanged in such messages.
The combination of a REST resource and an HTTP method typically identifies a specific operation that can be performed for the information represented by that REST resource. Multiple HTTP methods are often used with a particular REST resource to represent different operations that can be performed for the information represented by that REST resource.
For example, to export an existing workflow from Nintex Workflow for Office 365 to a client for a fictional customer named Crestan, the following REST resource is invoked, using the HTTP GET method:
https://crestan.nintexo365.com/api/v1/workflows/packages/fd4f1cd2-7ea7-4b62-9751-0ff83ab609f7
However, invoking the very same REST resource and using the HTTP PUT method allows the client to import an export file, overwriting that very workflow in Nintex Workflow 2013. HTTP methods allow REST to avoid ambiguity when interacting with REST resources.
The REST API includes the following REST resources:
This REST resource manages interaction with export files for Nintex Workflow for Office 365. You'll use this resource to perform the following operations:
You can use this operation to export existing workflows as export files, which can be used in Nintex Workflow for Office 365, in either the Workflow designer or the REST API, to import or migrate workflows to other SharePoint lists or sites.
This operation creates a new workflow from an export file. If the export file contains a list workflow, you can optionally migrate the workflow to a different SharePoint list, allowing Nintex Workflow for Office 365 to update the metadata from the workflow to match the new destination.
Importing into existing workflows
This operation overwrites an existing workflow from an export file. If the export file contains a list workflow, you can optionally migrate the workflow to a different SharePoint list, allowing Nintex Workflow for Office 365 to update the metadata from the workflow to match the new destination.
This REST resource manages interaction with workflows for Nintex Workflow for Office 365. You'll use this resource to perform the following operations:
You can use this operation to overwrite an existing site workflow or list workflow from an export file.
Use this operation to publish an unpublished workflow on Nintex Workflow for Office 365.