List workflows
Lists name, id and basic details for all workflows in a site.
Request
| Method | Request URI | HTTP Version |
|---|---|---|
| GET | https://{baseURL}/api/v1/workflows | 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. |
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 site workflows:
- The data property represents the information about the site workflows.
- The _links property contains links to other relevant operations for the workflows, relative to the SharePoint site.
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.
Example
The following example demonstrates how to use this operation to provide a list of the workflows on the SharePoint site.
Request
The following GET request attempts to request the list of workflows.
https://crestan.nintexo365.com/api/v1/workflows
Response
An HTTP 200 response code is returned, indicating that the request was successful.
Response Body
The response body contains the following Message object, in which the details of the site workflows are specified in the data property and the operations relevant to the workflows are described in the _links property.
{
"data":[
{
"name":"Example Workflow",
"description":"This is a workflow",
"id":"b0b037d8-ae5e-4894-b987-f61f9bf8a011",
"isPublished":false,
"workflowType":"List",
"listId":"c84fc918-6aa8-4a5d-83c1-933e38e8aebd",
"region":"West US",
"assignedUse":"Production"
}
],
"_links":[
{
"rel":"workflow.package.export",
"href":"/api/v1/workflows/packages/{id}",
"isTemplated":true
}, ,
{
"rel":"workflow.package.importput",
"href":"/api/v1/workflows/packages/{id}",
"isTemplated":true
},
{
"rel":"workflow.publish",
"href":"/api/v1/workflows/{id}/published",
"isTemplated":true
},
{
"rel":"workflow.save",
"href":"/api/v1/workflows/{id}",
"isTemplated":true
}
]
}