When your organization uses a subscription license for Nintex Forms for Office 365, development forms are available in addition to production forms.
Development forms look and behave differently from production forms. When you view or edit a development form, you can see a development form watermark on the designer canvas in the Forms designer.
When you publish a form on a tenant using a subscription license, the form settings-configured publish type is used: either development or production.
The assigneduse endpoint allows you to change the entitlement value of the form from development to production, or back from production to development. Change the assigned use of a Nintex form that has been saved to a SharePoint list. You can use the end point by specifying the list ID or the list ID and the content type ID.
Note: This API supports forms designed using the Classic Forms and Responsive Forms designers. Forms designed using the New Responsive Forms designer are not supported.
| Method | Request URI | HTTP Version |
|---|---|---|
| Put | {baseURL}/api/v1/forms/{listId},{contentTypeId}/assigneduse | HTTP/1.1 |
| Request Parameter | Description |
|---|---|
| endpointURL | Required. The endpoint URL for the REST API. For more information about the endpoint URL, see "Endpoint URL" above. |
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
| Content-Type | Required. application/json |
| X-RequestDigest | Required. SharePoint form digest value, used to authenticate the request. |
An object, serialized in JavaScript Object Notation (JSON), which contains the following properties:
| Property | Data type | Description |
|---|---|---|
| contentTypeId | string | Optional. The name or identifier of the SharePoint content type. If a value is not specified, the first content type defined for the list specified in listId is used. |
| listId | string | Required. The name or identifier of the SharePoint list or document library. |
|
value |
string |
Entitlement has two valid values:
|
The response includes an HTTP status code, response headers, and a response body.
| Code | Description |
|---|---|
| 200 | The specified form's entitlement was updated. |
| 400 | An invalid operation has occurred. |
| 401 | Unauthorized. |
| 404 | The specified list or contentType could not be found. |
| 500 | Internal error. |
The following table describes response headers returned by a successful response. Other header values may also be returned, depending on SharePoint and ASP.NET configurations.
| Request Header | Description |
|---|---|
| Content-Type | application/xml; charset=utf-8 |
| Content-Type | The length, in characters, of the response body. |
| Cache-Control | private |
If the method was successful, a JSON-serialized object is returned that contains the following properties:
| Property | Data type | Description |
|---|---|---|
| { } | string | If the assigned use was form was successfully updated, a response body is returned. |
|
value |
string |
Entitlement has two valid values:
|
Otherwise, depending on the error, the method returns additional information about the error. For example, if the value of the listId property in the request body is set to a name or identifier that cannot be found on the SharePoint site, the response returns an HTTP 400 status code and a Request Error web page in which the error indicates that a list with the specified name does not exist.
The following example demonstrates how to use this operation to change the assigned use for a Nintex form for a SharePoint list.
The following PUT request attempts to change the assigned use for a Nintex form.
https://crestan.nintexo365.com/api/v1/forms/DB0ECEE6-117D-4519-986E-020A9BE6A7E3,0x01004D9A51C2B8B8C341B3E3F2E268B4D00F/assigneduse
The following request body contains a JSON object in which the listId property is set to the identifier of the SharePoint list from where to publish the form definition. The contentTypeId property is not specified.
{
"value": "production"
}
An HTTP 200 response code is returned, indicating that the assigned use for the form was successfully changed.
The following response body is empty; you can verify the change by loading the form and seeing if the watermark is present or absent.
{}