> ## 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 deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/7.22/reference/rest/deployment/get-query-count/) method. ## OpenAPI ````yaml GET /deployment 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: /deployment: get: tags: - Deployment summary: Get List description: >- Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/7.22/reference/rest/deployment/get-query-count/) method. operationId: getDeployments parameters: - name: id in: query schema: type: string description: Filter by deployment id - name: name in: query schema: type: string description: Filter by the deployment name. Exact match. - name: nameLike in: query schema: type: string description: >- Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). - name: source in: query schema: type: string description: Filter by the deployment source. - name: withoutSource in: query schema: default: false type: boolean description: Filter by the deployment source whereby source is equal to `null`. - name: tenantIdIn in: query schema: type: string description: >- Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. - name: withoutTenantId in: query schema: default: false type: boolean description: >- Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. - name: includeDeploymentsWithoutTenantId in: query schema: default: false type: boolean description: >- Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. - name: after in: query schema: type: string format: date-time description: >- Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. - name: before in: query schema: type: string format: date-time description: >- Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. - name: sortBy in: query schema: enum: - id - name - deploymentTime - 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/DeploymentDto' examples: example-1: summary: GET `/deployment?name=deploymentName` value: - id: someId name: deploymentName source: process application tenantId: null deploymentTime: 2013-04-23T13:42:43.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`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling) for the error response format. components: schemas: DeploymentDto: allOf: - type: object properties: id: type: string nullable: true description: The id of the deployment. tenantId: type: string nullable: true description: The tenant id of the deployment. deploymentTime: type: string format: date-time nullable: true description: The time when the deployment was created. source: type: string nullable: true description: The source of the deployment. name: type: string nullable: true description: The name of the deployment. - $ref: '#/components/schemas/LinkableDto' 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). LinkableDto: type: object properties: links: type: array nullable: true items: $ref: '#/components/schemas/AtomLink' description: >- The links associated to this resource, with `method`, `href` and `rel`. AtomLink: type: object properties: rel: type: string nullable: true description: The relation of the link to the object that belongs to. href: type: string nullable: true description: The url of the link. method: type: string nullable: true description: The http method. securitySchemes: basicAuth: type: http scheme: basic ````