> ## 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 the number of process instances that fulfill given parameters. ## OpenAPI ````yaml GET /process-instance/count 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-instance/count: get: tags: - Process Instance summary: Get List Count description: >- Queries for the number of process instances that fulfill given parameters. operationId: getProcessInstancesCount parameters: - name: processInstanceIds in: query schema: type: string description: Filter by a comma-separated list of process instance ids. - name: businessKey in: query schema: type: string description: Filter by process instance business key. - name: businessKeyLike in: query schema: type: string description: >- Filter by process instance business key that the parameter is a substring of. - name: caseInstanceId in: query schema: type: string description: Filter by case instance id. - name: processDefinitionId in: query schema: type: string description: Filter by the deployment the id belongs to. - name: processDefinitionKey in: query schema: type: string description: Filter by the key of the process definition the instances run on. - name: processDefinitionKeyIn in: query schema: type: string description: >- Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. - name: processDefinitionKeyNotIn in: query schema: type: string description: >- Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. - name: deploymentId in: query schema: type: string description: Filter by the deployment the id belongs to. - name: superProcessInstance in: query schema: type: string description: >- Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. - name: subProcessInstance in: query schema: type: string description: >- Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. - name: superCaseInstance in: query schema: type: string description: >- Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. - name: subCaseInstance in: query schema: type: string description: >- Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. - name: active in: query schema: default: false type: boolean description: |- Only include active process instances. Value may only be true, as false is the default behavior. - name: suspended in: query schema: default: false type: boolean description: |- Only include suspended process instances. Value may only be true, as false is the default behavior. - name: withIncident in: query schema: default: false type: boolean description: >- Filter by presence of incidents. Selects only process instances that have an incident. - name: incidentId in: query schema: type: string description: Filter by the incident id. - name: incidentType in: query schema: type: string description: >- Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/incidents/#incident-types) for a list of incident types. - name: incidentMessage in: query schema: type: string description: Filter by the incident message. Exact match. - name: incidentMessageLike in: query schema: type: string description: Filter by the incident message that the parameter is a substring of. - name: tenantIdIn in: query schema: type: string description: >- Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. - name: withoutTenantId in: query schema: default: false type: boolean description: Only include process instances which belong to no tenant. - name: processDefinitionWithoutTenantId in: query schema: default: false type: boolean description: >- Only include process instances which process definition has no tenant id. - name: activityIdIn in: query schema: type: string description: >- Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. - name: rootProcessInstances in: query schema: default: false type: boolean description: >- Restrict the query to all process instances that are top level process instances. - name: leafProcessInstances in: query schema: default: false type: boolean description: >- Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). - name: variables in: query schema: type: string description: >- Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. - name: variableNamesIgnoreCase in: query schema: default: false type: boolean description: |- Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. - name: variableValuesIgnoreCase in: query schema: default: false type: boolean description: |- Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. responses: '200': content: application/json: schema: $ref: '#/components/schemas/CountResultDto' examples: example-1: summary: Status 200 response description: >- Response for GET `/process-instance/count?variables=myVariable_eq_camunda` value: count: 1 description: Request successful. '400': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: >- Bad Request Returned if some of the query parameters are invalid, for example an invalid operator for variable comparison is used. components: schemas: CountResultDto: type: object properties: count: type: integer format: int64 description: The number of matching instances. 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 ````