> ## 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. # 获取列表 > Queries for historic batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the [Get Historic Batch Count](https://docs.camunda.org/manual/7.22/reference/rest/history/batch/get-query-count/) method. ## OpenAPI ````yaml GET /history/batch 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/batch: get: tags: - Historic Batch summary: Get Historic Batches description: >- Queries for historic batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the [Get Historic Batch Count](https://docs.camunda.org/manual/7.22/reference/rest/history/batch/get-query-count/) method. operationId: getHistoricBatches parameters: - name: batchId in: query schema: type: string description: Filter by batch id. - name: type in: query schema: type: string description: >- Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types. - name: completed in: query schema: type: boolean description: |- Filter completed or not completed batches. If the value is `true`, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is `false`, only running batches, i.e., end time is null, are returned. - name: tenantIdIn in: query schema: type: string description: >- Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids. - name: withoutTenantId in: query schema: type: boolean description: >- Only include batches which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior. - name: sortBy in: query schema: enum: - batchId - startTime - endTime - tenantId 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/HistoricBatchDto' examples: example-1: summary: Status 200. description: >- GET `/history/batch?type=aBatchType&completed=true&sortBy=batchId&sortOrder=asc` value: - id: aBatchId type: aBatchType totalJobs: 10 batchJobsPerSeed: 100 invocationsPerBatchJob: 1 seedJobDefinitionId: aSeedJobDefinitionId monitorJobDefinitionId: aMonitorJobDefinitionId batchJobDefinitionId: aBatchJobDefinitionId tenantId: aTenantId createUserId: aUserId startTime: 2016-04-12T15:29:33.000+0200 endTime: 2016-04-12T16:23:34.000+0200 removalTime: 2016-04-15T16:23:34.000+0200 description: Request successful. '400': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: > Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`. See the [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling) for the error response format. components: schemas: HistoricBatchDto: type: object properties: id: type: string nullable: true description: The id of the batch. type: type: string nullable: true description: >- The type of the batch. See the [User Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types. totalJobs: type: integer format: int32 nullable: true description: | The total jobs of a batch is the number of batch execution jobs required to complete the batch. batchJobsPerSeed: type: integer format: int32 nullable: true description: | The number of batch execution jobs created per seed job invocation. The batch seed job is invoked until it has created all batch execution jobs required by the batch (see `totalJobs` property). invocationsPerBatchJob: type: integer format: int32 nullable: true description: | Every batch execution job invokes the command executed by the batch `invocationsPerBatchJob` times. E.g., for a process instance migration batch this specifies the number of process instances which are migrated per batch execution job. seedJobDefinitionId: type: string nullable: true description: The job definition id for the seed jobs of this batch. monitorJobDefinitionId: type: string nullable: true description: The job definition id for the monitor jobs of this batch. batchJobDefinitionId: type: string nullable: true description: The job definition id for the batch execution jobs of this batch. tenantId: type: string nullable: true description: The tenant id of the batch. createUserId: type: string nullable: true description: The batch creator's user id. startTime: type: string format: date-time nullable: true description: >- The time the batch was started. Default format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please see the [documentation](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/) executionStartTime: type: string format: date-time nullable: true description: >- The time the batch execution was started, i.e., at least one batch job has been executed. Default format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/) endTime: type: string format: date-time nullable: true description: >- The time the batch ended. Default format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please see the [documentation](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/) removalTime: type: string format: date-time nullable: true description: >- The time after which the historic batch should be removed by the History Cleanup job. Default format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please see the [documentation](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/) 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 ````