> ## 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.

# 根据Id设置激活/挂起Job定义

> Activates or suspends a given job definition by id.



## OpenAPI

````yaml PUT /job-definition/{id}/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-definition/{id}/suspended:
    put:
      tags:
        - Job Definition
      summary: Activate/Suspend Job Definition By Id
      description: Activates or suspends a given job definition by id.
      operationId: updateSuspensionStateJobDefinition
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the job definition to activate or suspend.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobDefinitionSuspensionStateDto'
            examples:
              example-1:
                summary: PUT `/job-definition/aJobDefinitionId/suspended`
                value:
                  suspended: true
                  includeJobs: true
                  executionDate: 2013-11-21T10:49:45.000+0200
      responses:
        '204':
          description: Request successful. This method returns no content.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if some of the request parameters are invalid, for example
            if the provided

            `executionDate` parameter doesn't have the expected format. See the

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

            for the error response format.
components:
  schemas:
    JobDefinitionSuspensionStateDto:
      allOf:
        - type: object
          properties:
            includeJobs:
              type: boolean
              nullable: true
              description: >-
                A `Boolean` value which indicates whether to activate or suspend
                also all jobs of

                the referenced job definitions. When the value is set to `true`,
                all jobs

                of the provided job definitions will be activated or suspended
                and

                when the value is set to `false`, the suspension state of all
                jobs

                of the provided job definitions will not be updated.
            executionDate:
              type: string
              nullable: true
              description: >-
                The date on which the referenced job definitions will be
                activated or suspended. If null,

                the suspension state of the given job definitions is updated

                immediately. 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`.
        - $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

````