Update history time to live

Updates history time to live for case definition with given id. The field is used within History cleanup.

Method

PUT /case-definition/{id}/history-time-to-live

PUT /case-definition/key/{key}/history-time-to-live (updates the latest version of the case definition which belongs to no tenant)

PUT /case-definition/key/{key}/tenant-id/{tenant-id}/history-time-to-live (updates the latest version of the case definition for tenant)

Parameters

Path Parameters

Name Description
id The id of the case definition to change history time to live.
key The key of the case definitions to change history time to live.
tenant-id The id of the tenant the case definitions belong to.

Request Body

A JSON object with the following properties:

Name Description
historyTimeToLive New value for historyTimeToLive field of case definition. Can be null.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Returned if some of the request parameters are invalid.
404 application/json case definition with given id does not exist. See the Introduction for the error response format.

Example

Request

PUT /case-definition/aCaseDefinitionId/history-time-to-live

    {
      "historyTimeToLive" : 5
    }

Response

Status 204. No content.

On this Page: