Publish a workflow

Publishes the specified workflow.

Request

Method Request URI HTTP Version
POST https://{baseURL}/api/v1/workflows/{id}/published HTTP/1.1

Request Parameters

Request Parameter Description

baseURL

Required. The base URL for the Nintex Workflow for Office 365 REST API. For more information about the base URL, see Base URL.

id

Required. A GUID that represents the identifier of the workflow to be published.

Request Headers

This operation uses only common request headers. For more information about common request headers, see Common headers.

Request Body

This operation does not use a request body.

Response

This operation returns an HTTP status code, response headers, and a response body.

Response Codes

This operation returns only common HTTP status codes. For more information about common HTTP status codes returned by all operations, see Common status and error codes.

Response Headers

This operation returns only common response headers. For more information about common response headers returned by all operations, see Common headers.

Response Body

If the operation was successful, the response body contains a Message object that represents the information returned by the operation about the published workflow. Otherwise, the response body contains an Error object, which provides information about the error response. For more information about the Message and Error objects, see Response bodies.

For a successful response, the id property of the Message object represents the identifier of the published workflow, and the _links property contains links to other relevant operations for the published workflow, relative to the SharePoint site.

Example

The following example demonstrates how to use this operation to publish an existing workflow.

Request

The following POST request attempts to publish the specified existing workflow.

https://crestan.nintexo365.com/api/v1/workflows/99777373-a65a-4f49-af7a-f28c2f33a0a8/published

Response

An HTTP 200 response code is returned, indicating that the existing workflow was successfully published.

Response Body

The response body contains the following Message object, in which the identifier for the published workflow is specified in the id property and the operations relevant to the published workflow are described in the _links property.

{
  "id": "99777373-a65a-4f49-af7a-f28c2f33a0a8",
  "_links": [
    {
      "rel": "self",
      "href": "/api/v1/workflows/99777373-a65a-4f49-af7a-f28c2f33a0a8/published",
      "isTemplated": false
    },
    {
      "rel": "workflow.package.export",
      "href": "/api/v1/workflows/packages/99777373-a65a-4f49-af7a-f28c2f33a0a8",
      "isTemplated": false
    }
  ]
}

Related Information

Publishing workflows

API Reference