> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eorion.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 通过Id更新历史记录生存时间

> Updates history time to live for process definition.
The field is used within [History cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup).
The value of the update is mandatory by default and does not allow `null` values. To enable them, please
set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties]
(https://docs.camunda.org/manual/7.22/reference/deployment-descriptors/tags/process-engine#configuration-properties)



## OpenAPI

````yaml PUT /process-definition/{id}/history-time-to-live
openapi: 3.0.2
info:
  title: ORION Platform REST API
  description: OpenApi Spec for ORION Camunda Platform REST API.
  version: 7.22.6-ee
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ORION Rest API
  url: https://docs.eorion.com
paths:
  /process-definition/{id}/history-time-to-live:
    put:
      tags:
        - Process Definition
      summary: Update History Time to Live
      description: >-
        Updates history time to live for process definition.

        The field is used within [History
        cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup).

        The value of the update is mandatory by default and does not allow
        `null` values. To enable them, please

        set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in
        [Configuration Properties]

        (https://docs.camunda.org/manual/7.22/reference/deployment-descriptors/tags/process-engine#configuration-properties)
      operationId: updateHistoryTimeToLiveByProcessDefinitionId
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the process definition to change history time to live.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoryTimeToLiveDto'
            examples:
              example-1:
                summary: >-
                  PUT
                  `/process-definition/aProcessDefinitionId/history-time-to-live`
                value:
                  historyTimeToLive: 5
      responses:
        '204':
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if some of the request parameters are invalid. See the

            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)

            for the error response format.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Process definition with given id does not exist. See the

            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)

            for the error response format.
components:
  schemas:
    HistoryTimeToLiveDto:
      type: object
      properties:
        historyTimeToLive:
          type: integer
          format: int32
          nullable: true
          minimum: 0
          description: >-
            New value for historyTimeToLive field of the definition.

            Can be `null` if `enforceHistoryTimeToLive` is configured to
            `false`.

            Cannot be negative.
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/error-handling/#exception-codes).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````