The Nintex Workflow for Office 365 REST API uses both common request and response headers, supported by all operations included in the REST API, and specific request and response headers, used only in certain operations. This section describes the common request and response headers used in the REST API. For more information about specific request and response headers used for a specific operation in the REST API, see the documentation for that operation.
The following request headers are supported by all operations included with the Nintex Workflow for Office 365 REST API.
| Header | Description |
|---|---|
| Accept |
Set to the following value: application/json |
| Authorization |
A cookie that contains the SharePoint site used by the REST operation and the SharePoint authentication cookie used to authenticate the REST operation for SharePoint. The cookie uses the following format, replacing <site> with the SharePoint site URL and <authcookie> with a valid SharePoint SPOIDCRL or FedAuth authentication cookie for the specified site, as needed, to authenticate the request with SharePoint. cookie <site> <authcookie> For more information, see Authentication and authorization. |
| Api-Key |
The API key for Nintex Workflow for Office 365 REST API. For more information, see Authentication and authorization. |
The following response headers are supported by all operations included with the Nintex Workflow for Office 365 REST API. Depending on SharePoint and ASP.NET configuration, other headers may also be returned.
| Response Header | Description |
|---|---|
| Content-Length | The length, in octlets, of the response body. |
| Content-Type |
The MIME type of the content in the response body. Unless specified by the operation, set to the following value: application/json; charset=utf-8 |
| Correlation-Identifier | The correlation ID of the operation. |
| Date | The date and time at which the response was sent by the server. |