> ## 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. # 获取可清理的流程实例报告 > Retrieves a report about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup)) so that you can tune the history time to live. These reports include the count of the finished historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Process Instance Report Count](https://docs.camunda.org/manual/7.22/reference/rest/history/process-definition/get-cleanable-process-instance-report-count/) method. ## OpenAPI ````yaml GET /history/process-definition/cleanable-process-instance-report 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/process-definition/cleanable-process-instance-report: get: tags: - Historic Process Definition summary: Get Cleanable Process Instance Report description: >- Retrieves a report about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup)) so that you can tune the history time to live. These reports include the count of the finished historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Process Instance Report Count](https://docs.camunda.org/manual/7.22/reference/rest/history/process-definition/get-cleanable-process-instance-report-count/) method. operationId: getCleanableHistoricProcessInstanceReport parameters: - name: processDefinitionIdIn in: query schema: type: string description: >- Filter by process definition ids. Must be a comma-separated list of process definition ids. - name: processDefinitionKeyIn in: query schema: type: string description: >- Filter by process definition keys. Must be a comma-separated list of process definition keys. - name: tenantIdIn in: query schema: type: string description: >- Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. - name: withoutTenantId in: query schema: type: boolean description: >- Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. - name: compact in: query schema: type: boolean description: >- Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. - name: sortBy in: query schema: enum: - finished type: string description: |- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. - name: sortOrder in: query schema: enum: - asc - desc type: string description: >- Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. - name: firstResult in: query schema: type: integer description: >- Pagination of results. Specifies the index of the first result to return. - name: maxResults in: query schema: type: integer description: >- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. responses: '200': content: application/json: schema: type: array items: $ref: >- #/components/schemas/CleanableHistoricProcessInstanceReportResultDto examples: example-1: summary: >- GET `/history/process-definition/cleanable-process-instance-report` description: >- GET `/history/process-definition/cleanable-process-instance-report` value: - processDefinitionId: invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e processDefinitionKey: invoice processDefinitionName: Invoice Receipt processDefinitionVersion: 1 historyTimeToLive: 5 finishedProcessInstanceCount: 100 cleanableProcessInstanceCount: 53 tenantId: aTenantId - processDefinitionId: invoice:2:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e processDefinitionKey: invoice processDefinitionName: Invoice Receipt v2.0 processDefinitionVersion: 2 historyTimeToLive: 5 finishedProcessInstanceCount: 1000 cleanableProcessInstanceCount: 13 tenantId: aTenantId description: Request successful. '500': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: >- See the [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling) for the error response format. components: schemas: CleanableHistoricProcessInstanceReportResultDto: type: object properties: processDefinitionId: type: string nullable: true description: The id of the process definition. processDefinitionKey: type: string nullable: true description: The key of the process definition. processDefinitionName: type: string nullable: true description: The name of the process definition. processDefinitionVersion: type: integer format: int32 nullable: true description: The version of the process definition. historyTimeToLive: type: integer format: int32 nullable: true description: The history time to live of the process definition. finishedProcessInstanceCount: type: integer format: int64 nullable: true description: The count of the finished historic process instances. cleanableProcessInstanceCount: type: integer format: int64 nullable: true description: >- The count of the cleanable historic process instances, referring to history time to live. tenantId: type: string nullable: true description: The tenant id of the process definition. 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 ````