4.23 Modify Template History

This topic provides information on how to modify the application template's history/version number (api/templates/<history_pk>/history/<version>). See 4.22 Modify Template for information on how to modify the application template itself (api/templates/<id>).

The are two different methods that you can use to modify an application template history/version number:

  • PUT – Creates a copy of the selected application template history version and applies it as the current version for the application template (reverts the application template to a previous version's information).
  • PATCH – Lets you modify the version description for the selected application template history version, all other attributes, including the template version, remain unchanged.

In this topic:

4.23.1 PUT Method

In this section:

4.23.1.A URL

PUT /api/templates/<history_pk>/history/<version>/

4.23.1.B Parameters

Parameter Required Type Description Example
history_pk Yes String History ID of the application template b00ce08c-01ed-4a9d-a916-f587b9f1af44
version Yes Integer Version of the application template 2

4.23.1.C Example

This section provides an example of how to take an older application template's version and copy and save it as a new (current) version.

PUT /api/templates/b00ce08c-01ed-4a9d-a916-f587b9f1af44/history/1/

Response

4.23.2 PATCH Method

You must the correct content type when using the PATCH API. If not specified, the API will consider the type as 'text/html' which might cause side effects in the request processing code.

In this section:

4.23.2.A URL

PATCH /api/templates/<history_pk>/history/<version>/

4.23.2.B Parameters

Parameter Required Type Description Example
history_pk Yes String History ID of the application template b00ce08c-01ed-4a9d-a916-f587b9f1af44
version Yes Integer Version of the application template 2

4.23.2.C JSON Structure

The following table identifies the application template attributes that can be changed via PATCH call.

Name Required Type Description
version_description No String Description of changes in this application template's version.

Related Topics