> ## 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. # 在组中激活/挂起 > Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery` ## OpenAPI ````yaml PUT /process-instance/suspended 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/suspended: put: tags: - Process Instance summary: Activate/Suspend In Group description: |- Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery` operationId: updateSuspensionState requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcessInstanceSuspensionStateDto' examples: example-1: summary: PUT `/process-instance/suspended` description: Suspend Process Instance By Process Definition Id value: processDefinitionId: aProcDefId suspended: true example-2: summary: PUT `/process-instance/suspended` description: Suspend Process Instance By Process Definition Key value: processDefinitionKey: aProcDefKey suspended: true example-3: summary: PUT `/process-instance/suspended` description: Suspend Process Instance In Group value: processInstanceIds: - processInstanceId1 - processInstanceIdN suspended: true responses: '204': description: Request successful. '400': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: >- Bad Request Returned if some of the request parameters are invalid, for example if the provided processDefinitionId or processDefinitionKey parameter is null. components: schemas: ProcessInstanceSuspensionStateDto: allOf: - type: object properties: processDefinitionId: type: string nullable: true description: >- The process definition id of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`. processDefinitionKey: type: string nullable: true description: >- The process definition key of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionTenantId`, and `processDefinitionWithoutTenantId`. processDefinitionTenantId: type: string nullable: true description: >- Only activate or suspend process instances of a process definition which belongs to a tenant with the given id. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionWithoutTenantId`. processDefinitionWithoutTenantId: type: boolean nullable: true description: >- Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionTenantId`. processInstanceIds: type: array nullable: true items: type: string description: >- A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation. **Note**: This parameter can be used only with combination of `suspended`, `processInstanceQuery`, and `historicProcessInstanceQuery`. processInstanceQuery: $ref: '#/components/schemas/ProcessInstanceQueryDto' historicProcessInstanceQuery: $ref: '#/components/schemas/HistoricProcessInstanceQueryDto' - $ref: '#/components/schemas/SuspensionStateDto' 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). ProcessInstanceQueryDto: type: object description: A process instance query which defines a group of process instances properties: deploymentId: type: string nullable: true description: Filter by the deployment the id belongs to. processDefinitionId: type: string nullable: true description: Filter by the process definition the instances run on. processDefinitionKey: type: string nullable: true description: Filter by the key of the process definition the instances run on. processDefinitionKeyIn: type: array nullable: true items: type: string description: >- Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of Strings. processDefinitionKeyNotIn: type: array nullable: true items: type: string description: >- Exclude instances by a list of process definition keys. A process instance must not have one of the given process definition keys. Must be a JSON array of Strings. businessKey: type: string nullable: true description: Filter by process instance business key. businessKeyLike: type: string nullable: true description: >- Filter by process instance business key that the parameter is a substring of. caseInstanceId: type: string nullable: true description: Filter by case instance id. superProcessInstance: type: string nullable: true description: >- Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. subProcessInstance: type: string nullable: true description: >- Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. superCaseInstance: type: string nullable: true description: >- Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. subCaseInstance: type: string nullable: true description: >- Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. active: type: boolean nullable: true description: >- Only include active process instances. Value may only be true, as false is the default behavior. suspended: type: boolean nullable: true description: >- Only include suspended process instances. Value may only be true, as false is the default behavior. processInstanceIds: type: array nullable: true items: type: string description: >- Filter by a list of process instance ids. Must be a JSON array of Strings. withIncident: type: boolean nullable: true description: >- Filter by presence of incidents. Selects only process instances that have an incident. incidentId: type: string nullable: true description: Filter by the incident id. incidentType: type: string nullable: true description: >- Filter by the incident type. See the User Guide for a list of incident types. incidentMessage: type: string nullable: true description: Filter by the incident message. Exact match. incidentMessageLike: type: string nullable: true description: Filter by the incident message that the parameter is a substring of. tenantIdIn: type: array nullable: true items: type: string description: >- Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of Strings. withoutTenantId: type: boolean nullable: true description: |- Only include process instances which belong to no tenant. Value may only be true, as false is the default behavior. processDefinitionWithoutTenantId: type: boolean nullable: true description: >- Only include process instances which process definition has no tenant id. activityIdIn: type: array nullable: true items: type: string description: >- Filter by a list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. rootProcessInstances: type: boolean nullable: true description: >- Restrict the query to all process instances that are top level process instances. leafProcessInstances: type: boolean nullable: true description: >- Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances) variables: type: array nullable: true items: $ref: '#/components/schemas/VariableQueryParameterDto' description: >- A JSON array to only include process instances that have variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (String) is the variable name, `operator` (String) is the comparison operator to be used and `value` the variable value. The `value` may be String, Number or Boolean. 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`. variableNamesIgnoreCase: type: boolean nullable: true description: |- Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. variableValuesIgnoreCase: type: boolean nullable: true description: |- Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. orQueries: type: array nullable: true items: $ref: '#/components/schemas/ProcessInstanceQueryDto' description: >- A JSON array of nested process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query (Conjunctive Normal Form). All process instance query properties can be used except for: `sorting` See the [User guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries. sorting: type: array nullable: true description: Apply sorting of the result items: type: object properties: sortBy: type: string nullable: true enum: - instanceId - definitionId - definitionKey - businessKey - tenantId description: |- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. sortOrder: type: string nullable: true enum: - asc - desc 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. HistoricProcessInstanceQueryDto: type: object description: >- A historic process instance query which defines a group of historic process instances properties: processInstanceId: type: string nullable: true description: Filter by process instance id. processInstanceIds: type: array nullable: true items: type: string description: Filter by process instance ids. Must be a JSON array of `Strings`. processDefinitionId: type: string nullable: true description: Filter by the process definition the instances run on. processDefinitionKey: type: string nullable: true description: Filter by the key of the process definition the instances run on. processDefinitionKeyIn: type: array nullable: true items: type: string description: >- Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of `Strings`. processDefinitionName: type: string nullable: true description: Filter by the name of the process definition the instances run on. processDefinitionNameLike: type: string nullable: true description: >- Filter by process definition names that the parameter is a substring of. processDefinitionKeyNotIn: type: array nullable: true items: type: string description: >- Exclude instances that belong to a set of process definitions. Must be a JSON array of `Strings`. processInstanceBusinessKey: type: string nullable: true description: Filter by process instance business key. processInstanceBusinessKeyIn: type: array nullable: true items: type: string description: >- Filter by a list of business keys. A process instance must have one of the given business keys. Must be a JSON array of `Strings` processInstanceBusinessKeyLike: type: string nullable: true description: >- Filter by process instance business key that the parameter is a substring of. rootProcessInstances: type: boolean nullable: true description: >- Restrict the query to all process instances that are top level process instances. finished: type: boolean nullable: true description: >- Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. unfinished: type: boolean nullable: true description: >- Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. withIncidents: type: boolean nullable: true description: >- Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. withRootIncidents: type: boolean nullable: true description: >- Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. incidentIdIn: type: array nullable: true items: type: string description: >- Restrict to instances that have an incident with one of the given ids. Must be a JSON array of `Strings` incidentType: type: string nullable: true 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. incidentStatus: type: string nullable: true enum: - open - resolved description: >- Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. incidentMessage: type: string nullable: true description: Filter by the incident message. Exact match. incidentMessageLike: type: string nullable: true description: Filter by the incident message that the parameter is a substring of. startedBefore: type: string format: date-time nullable: true description: >- Restrict to instances that were started 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`. startedAfter: type: string format: date-time nullable: true description: >- Restrict to instances that were started 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`. finishedBefore: type: string format: date-time nullable: true description: >- Restrict to instances that were finished 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`. finishedAfter: type: string format: date-time nullable: true description: >- Restrict to instances that were finished 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`. executedActivityAfter: type: string format: date-time nullable: true description: >- Restrict to instances that executed an activity after the given date (inclusive). 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`. executedActivityBefore: type: string format: date-time nullable: true description: >- Restrict to instances that executed an activity before the given date (inclusive). 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`. executedJobAfter: type: string format: date-time nullable: true description: >- Restrict to instances that executed an job after the given date (inclusive). 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`. executedJobBefore: type: string format: date-time nullable: true description: >- Restrict to instances that executed an job before the given date (inclusive). 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`. startedBy: type: string nullable: true description: Only include process instances that were started by the given user. superProcessInstanceId: type: string nullable: true description: >- Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. subProcessInstanceId: type: string nullable: true description: >- Restrict query to one process instance that has a sub process instance with the given id. superCaseInstanceId: type: string nullable: true description: >- Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. subCaseInstanceId: type: string nullable: true description: >- Restrict query to one process instance that has a sub case instance with the given id. caseInstanceId: type: string nullable: true description: >- Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. tenantIdIn: type: array nullable: true items: type: string description: >- Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of `Strings` withoutTenantId: type: boolean nullable: true description: >- Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. activityIdIn: type: array nullable: true items: type: string description: >- Restrict to instances with an active activity with one of the given ids. In contrast to the `activeActivityIdIn` filter, it can query for async and incident activities. Must be a JSON array of `Strings` executedActivityIdIn: type: array nullable: true items: type: string description: >- Restrict to instances that executed an activity with one of given ids. Must be a JSON array of `Strings` activeActivityIdIn: type: array nullable: true items: type: string description: >- Restrict to instances that have an active activity with one of given ids. Must be a JSON array of `Strings` active: type: boolean nullable: true description: Restrict to instances that are active. suspended: type: boolean nullable: true description: Restrict to instances that are suspended. completed: type: boolean nullable: true description: Restrict to instances that are completed. externallyTerminated: type: boolean nullable: true description: Restrict to instances that are externallyTerminated. internallyTerminated: type: boolean nullable: true description: Restrict to instances that are internallyTerminated. variables: type: array nullable: true items: $ref: '#/components/schemas/VariableQueryParameterDto' description: > A JSON array to only include process instances that have/had variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (`String`) is the variable name, `operator` (`String`) is the comparison operator to be used and `value` the variable value. Value may be `String`, `Number` or `Boolean`. 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`. variableNamesIgnoreCase: type: boolean nullable: true description: >- Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. variableValuesIgnoreCase: type: boolean nullable: true description: >- Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. orQueries: type: array nullable: true items: $ref: '#/components/schemas/HistoricProcessInstanceQueryDto' description: >- A JSON array of nested historic process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query ([Conjunctive Normal Form](https://en.wikipedia.org/wiki/Conjunctive_normal_form)). All process instance query properties can be used except for: `sorting` See the [User Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries. sorting: type: array nullable: true description: Apply sorting of the result items: type: object properties: sortBy: type: string nullable: true enum: - instanceId - definitionId - definitionKey - definitionName - definitionVersion - businessKey - startTime - endTime - duration - tenantId description: |- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. sortOrder: type: string nullable: true enum: - asc - desc 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. SuspensionStateDto: type: object properties: suspended: type: boolean nullable: true description: >- A Boolean value which indicates whether to activate or suspend a given instance (e.g. process instance, job, job definition, or batch). When the value is set to true, the given instance will be suspended and when the value is set to false, the given instance will be activated. VariableQueryParameterDto: allOf: - type: object properties: name: type: string nullable: true description: Variable name - $ref: '#/components/schemas/ConditionQueryParameterDto' ConditionQueryParameterDto: type: object properties: operator: type: string nullable: true enum: - eq - neq - gt - gteq - lt - lteq - like - notLike description: >- Comparison operator to be used. `notLike` is not supported by all endpoints. value: $ref: '#/components/schemas/AnyValue' AnyValue: description: |- Can be any value - string, number, boolean, array or object. **Note**: Not every endpoint supports every type. securitySchemes: basicAuth: type: http scheme: basic ````