> ## 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 jobs matching the given criterion.
This can only be on of:
* `jobDefinitionId`
* `processDefinitionId`
* `processInstanceId`
* `processDefinitionKey`



## OpenAPI

````yaml PUT /job/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:
  /job/suspended:
    put:
      tags:
        - Job
      summary: Activate/Suspend Jobs
      description: |-
        Activates or suspends jobs matching the given criterion.
        This can only be on of:
        * `jobDefinitionId`
        * `processDefinitionId`
        * `processInstanceId`
        * `processDefinitionKey`
      operationId: updateSuspensionStateBy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobSuspensionStateDto'
            examples:
              example-1:
                summary: >-
                  Activates or suspends jobs with the given job definition id.
                  PUT `/job/suspended`
                value:
                  jobDefinitionId: aJobDefinitionId
                  suspended: true
              example-2:
                summary: >-
                  Activates or suspends jobs with the given process definition
                  id. PUT `/job/suspended`
                value:
                  processDefinitionId: aProcessDefinitionId
                  suspended: true
              example-3:
                summary: >-
                  Activates or suspends jobs with the given process instance id.
                  PUT `/job/suspended`
                value:
                  processInstanceId: aProcessInstanceId
                  suspended: true
              example-4:
                summary: >-
                  Activates or suspends jobs with the given process definition
                  key. PUT `/job/suspended`
                value:
                  processDefinitionKey: aProcessDefinitionKey
                  suspended: true
      responses:
        '204':
          description: Request successful. This method returns no content.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if the request parameters are invalid, for example, if
            `jobDefinitionId` and

            `processDefinitionId` are both specified.

            See the
            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)

            for the error response format.
components:
  schemas:
    JobSuspensionStateDto:
      allOf:
        - type: object
          description: >-
            Defines by which selection criterion to activate or suspend jobs.

            This selection criterion are mutually exclusive and can only be on
            of:

            * `jobDefinitionId`

            * `processDefinitionId`

            * `processInstanceId`

            * `processDefinitionKey`
          properties:
            jobDefinitionId:
              type: string
              nullable: true
              description: The job definition id of the jobs to activate or suspend.
            processDefinitionId:
              type: string
              nullable: true
              description: The process definition id of the jobs to activate or suspend.
            processInstanceId:
              type: string
              nullable: true
              description: The process instance id of the jobs to activate or suspend.
            processDefinitionKey:
              type: string
              nullable: true
              description: The process definition key of the jobs to activate or suspend.
            processDefinitionTenantId:
              type: string
              nullable: true
              description: >-
                Only activate or suspend jobs of a process definition which
                belongs to a tenant

                with the given id. Works only when selecting with
                `processDefinitionKey`.
            processDefinitionWithoutTenantId:
              type: boolean
              nullable: true
              description: >-
                Only activate or suspend jobs of a process definition which
                belongs to no tenant.

                Value may only be `true`, as `false` is the default behavior.
                Works only when selecting with `processDefinitionKey`.
        - $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).
    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.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````