> ## 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.

# 清理历史记录(POST)

> Schedules asynchronous history cleanup (See
[History cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup)).

**Note:** This endpoint will return at most a single history cleanup job.
Since version `7.9.0` it is possible to configure multiple
[parallel history cleanup jobs](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#parallel-execution). Use
[`GET /history/cleanup/jobs`](https://docs.camunda.org/manual/7.22/reference/rest/history/history-cleanup/get-history-cleanup-jobs)
to find all the available history cleanup jobs.



## OpenAPI

````yaml POST /history/cleanup
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:
  /history/cleanup:
    post:
      tags:
        - History Cleanup
      summary: Clean up history (POST)
      description: >-
        Schedules asynchronous history cleanup (See

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


        **Note:** This endpoint will return at most a single history cleanup
        job.

        Since version `7.9.0` it is possible to configure multiple

        [parallel history cleanup
        jobs](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#parallel-execution).
        Use

        [`GET
        /history/cleanup/jobs`](https://docs.camunda.org/manual/7.22/reference/rest/history/history-cleanup/get-history-cleanup-jobs)

        to find all the available history cleanup jobs.
      operationId: cleanupAsync
      parameters:
        - name: immediatelyDue
          in: query
          schema:
            type: boolean
          description: >-
            When true the job will be scheduled for nearest future. When
            `false`, the job will be

            scheduled for next batch window start time. Default is `true`.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDto'
              examples:
                example-1:
                  summary: POST `/history/cleanup?immediatelyDue=false`
                  description: POST `/history/cleanup?immediatelyDue=false`
                  value:
                    id: 074bd92a-1a95-11e7-8ceb-34f39ab71d4e
                    jobDefinitionId: null
                    processInstanceId: null
                    processDefinitionId: null
                    processDefinitionKey: null
                    executionId: null
                    exceptionMessage: null
                    retries: 3
                    dueDate: 2017-04-06T13:57:45.000+0200
                    suspended: false
                    priority: 0
                    tenantId: null
                    createTime: 2017-04-01T09:45:15.039+0100
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if some of the query parameters are invalid or the engine

            does not participate in history cleanup. See

            [Cleanup Execution Participation per
            Node](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#cleanup-execution-participation-per-node).
components:
  schemas:
    JobDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the job.
        jobDefinitionId:
          type: string
          nullable: true
          description: The id of the associated job definition.
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: The date on which this job is supposed to be processed.
        processInstanceId:
          type: string
          nullable: true
          description: The id of the process instance which execution created the job.
        executionId:
          type: string
          nullable: true
          description: The specific execution id on which the job was created.
        processDefinitionId:
          type: string
          nullable: true
          description: The id of the process definition which this job belongs to.
        processDefinitionKey:
          type: string
          nullable: true
          description: The key of the process definition which this job belongs to.
        retries:
          type: integer
          format: int32
          nullable: true
          description: The number of retries this job has left.
        exceptionMessage:
          type: string
          nullable: true
          description: >-
            The message of the exception that occurred, the last time the job
            was executed. Is

            null when no exception occurred.
        failedActivityId:
          type: string
          nullable: true
          description: >-
            The id of the activity on which the last exception occurred, the
            last time the job

            was executed. Is null when no exception occurred.
        suspended:
          type: boolean
          nullable: true
          description: A flag indicating whether the job is suspended or not.
        priority:
          type: integer
          format: int64
          nullable: true
          description: The job's priority for execution.
        tenantId:
          type: string
          nullable: true
          description: The id of the tenant which this job belongs to.
        createTime:
          type: string
          format: date-time
          nullable: true
          description: The date on which this job has been created.
        batchId:
          type: string
          nullable: true
          description: >-
            The ID of the batch associated with this job. `null` if no batch is
            associated with this job. The

            following jobs are associated with batches:

            * Seed Jobs

            * Monitor Jobs

            * Batch Execution Jobs
    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

````