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

# 设置作业重试异步(POST)

> Create a batch to set retries of jobs asynchronously.



## OpenAPI

````yaml POST /job/retries
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/retries:
    post:
      tags:
        - Job
      summary: Set Job Retries Async (POST)
      description: Create a batch to set retries of jobs asynchronously.
      operationId: setJobRetriesAsyncOperation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetJobRetriesDto'
            examples:
              example-1:
                summary: POST `/job/retries`
                value:
                  retries: 5
                  dueDate: 2017-04-06T13:57:45.000+0200
                  jobIds:
                    - aJob
                    - secondJob
                  jobQuery:
                    dueDates:
                      - operator: gt
                        value: 2012-07-17T17:00:00.000+0200
                      - operator: lt
                        value: 2012-07-17T18:00:00.000+0200
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDto'
              examples:
                example-1:
                  summary: Status 200 OK
                  description: POST `/job/retries`
                  value:
                    id: aBatchId
                    type: aBatchType
                    totalJobs: 10
                    batchJobsPerSeed: 100
                    jobsCreated: 10
                    invocationsPerBatchJob: 1
                    seedJobDefinitionId: aSeedJobDefinitionId
                    monitorJobDefinitionId: aMonitorJobDefinitionId
                    batchJobDefinitionId: aBatchJobDefinitionId
                    suspened: false
                    tenantId: aTenantId
                    createUserId: userId
          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
            neither

            processInstanceIds nor processInstanceQuery is present. Or if the

            retry count is not specified. See the

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

            for the error response format.
components:
  schemas:
    SetJobRetriesDto:
      allOf:
        - type: object
          description: |-
            Defines the number of retries for a selection of jobs.
            Please note that if both jobIds and jobQuery are provided,
            then retries will be set on the union of these sets.
          properties:
            jobIds:
              type: array
              nullable: true
              items:
                type: string
              description: A list of job ids to set retries for.
            jobQuery:
              $ref: '#/components/schemas/JobQueryDto'
        - $ref: '#/components/schemas/JobRetriesDto'
    BatchDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the batch.
        type:
          type: string
          nullable: true
          description: >-
            The type of the batch.

            See the [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/batch/#creating-a-batch)

            for more information about batch types.
        totalJobs:
          type: integer
          format: int32
          nullable: true
          description: >-
            The total jobs of a batch is the number of batch execution jobs
            required to complete the batch.
        jobsCreated:
          type: integer
          format: int32
          nullable: true
          description: The number of batch execution jobs already created by the seed job.
        batchJobsPerSeed:
          type: integer
          format: int32
          nullable: true
          description: >-
            The number of batch execution jobs created per seed job invocation.

            The batch seed job is invoked until it has created all batch
            execution jobs required by the batch

            (see `totalJobs` property).
        invocationsPerBatchJob:
          type: integer
          format: int32
          nullable: true
          description: >-
            Every batch execution job invokes the command executed by the batch
            `invocationsPerBatchJob` times.

            E.g., for a process instance migration batch this specifies the
            number of process instances which are migrated per batch execution
            job.
        seedJobDefinitionId:
          type: string
          nullable: true
          description: The job definition id for the seed jobs of this batch.
        monitorJobDefinitionId:
          type: string
          nullable: true
          description: The job definition id for the monitor jobs of this batch.
        batchJobDefinitionId:
          type: string
          nullable: true
          description: The job definition id for the batch execution jobs of this batch.
        suspended:
          type: boolean
          nullable: true
          description: Indicates whether this batch is suspended or not.
        tenantId:
          type: string
          nullable: true
          description: The tenant id of the batch.
        createUserId:
          type: string
          nullable: true
          description: The id of the user that created the batch.
        startTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time the batch was started. Default format
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information,

            please see the [documentation]
            (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
        executionStartTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time the batch execution was started, i.e., at least one batch
            job has been executed. Default

            format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please
            see the [documentation]

            (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
    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).
    JobQueryDto:
      type: object
      description: A Job instance query which defines a list of Job instances
      properties:
        jobId:
          type: string
          nullable: true
          description: Filter by job id.
        jobIds:
          type: array
          nullable: true
          items:
            type: string
          description: Filter by a  list of job ids.
        jobDefinitionId:
          type: string
          nullable: true
          description: Only select jobs which exist for the given job definition.
        processInstanceId:
          type: string
          nullable: true
          description: Only select jobs which exist for the given process instance.
        processInstanceIds:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Only select jobs which exist for the given  list of process instance
            ids.
        executionId:
          type: string
          nullable: true
          description: Only select jobs which exist for the given execution.
        processDefinitionId:
          type: string
          nullable: true
          description: Filter by the id of the process definition the jobs run on.
        processDefinitionKey:
          type: string
          nullable: true
          description: Filter by the key of the process definition the jobs run on.
        activityId:
          type: string
          nullable: true
          description: Only select jobs which exist for an activity with the given id.
        withRetriesLeft:
          type: boolean
          nullable: true
          description: >-
            Only select jobs which have retries left. Value may only be `true`,
            as `false` is the

            default behavior.
        executable:
          type: boolean
          nullable: true
          description: >-
            Only select jobs which are executable, i.e., retries > 0 and due
            date is `null` or due

            date is in the past. Value may only be `true`, as `false` is the
            default

            behavior.
        timers:
          type: boolean
          nullable: true
          description: >-
            Only select jobs that are timers. Cannot be used together with
            `messages`. Value may only

            be `true`, as `false` is the default behavior.
        messages:
          type: boolean
          nullable: true
          description: >-
            Only select jobs that are messages. Cannot be used together with
            `timers`. Value may only

            be `true`, as `false` is the default behavior.
        dueDates:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/JobConditionQueryParameterDto'
          description: >
            Only select jobs where the due date is lower or higher than the
            given date.
        createTimes:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/JobConditionQueryParameterDto'
          description: |
            Only select jobs created before or after the given date.
        withException:
          type: boolean
          nullable: true
          description: >-
            Only select jobs that failed due to an exception. Value may only be
            `true`, as `false` is

            the default behavior.
        exceptionMessage:
          type: string
          nullable: true
          description: >-
            Only select jobs that failed due to an exception with the given
            message.
        failedActivityId:
          type: string
          nullable: true
          description: >-
            Only select jobs that failed due to an exception at an activity with
            the given id.
        noRetriesLeft:
          type: boolean
          nullable: true
          description: >-
            Only select jobs which have no retries left. Value may only be
            `true`, as `false` is the

            default behavior.
        active:
          type: boolean
          nullable: true
          description: >-
            Only include active jobs. Value may only be `true`, as `false` is
            the default behavior.
        suspended:
          type: boolean
          nullable: true
          description: >-
            Only include suspended jobs. Value may only be `true`, as `false` is
            the default behavior.
        priorityLowerThanOrEquals:
          type: integer
          format: int64
          nullable: true
          description: >-
            Only include jobs with a priority lower than or equal to the given
            value. Value must be a

            valid `long` value.
        priorityHigherThanOrEquals:
          type: integer
          format: int64
          nullable: true
          description: >-
            Only include jobs with a priority higher than or equal to the given
            value. Value must be a

            valid `long` value.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: Only include jobs which belong to one of the passed  tenant ids.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Only include jobs which belong to no tenant. Value may only be
            `true`, as `false` is the

            default behavior.
        includeJobsWithoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Include jobs which belong to no tenant. Can be used in combination
            with `tenantIdIn`.

            Value may only be `true`, as `false` is the default behavior.
        sorting:
          type: array
          nullable: true
          description: >-
            An array of criteria to sort the result by. Each element of the
            array is
                                   an object that specifies one ordering. The position in the array
                                   identifies the rank of an ordering, i.e., whether it is primary, secondary,
                                   etc. Does not have an effect for the `count` endpoint.
          items:
            type: object
            properties:
              sortBy:
                type: string
                nullable: true
                enum:
                  - jobId
                  - executionId
                  - processInstanceId
                  - processDefinitionId
                  - processDefinitionKey
                  - jobPriority
                  - jobRetries
                  - jobDueDate
                  - 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.
    JobRetriesDto:
      allOf:
        - type: object
          properties:
            dueDate:
              type: string
              format: date-time
              nullable: true
              description: >-
                The due date to set for the job. A due date indicates when this
                job is ready for execution.

                Jobs with due dates in the past will be scheduled for execution.
        - $ref: '#/components/schemas/RetriesDto'
    JobConditionQueryParameterDto:
      type: object
      properties:
        operator:
          type: string
          nullable: true
          enum:
            - gt
            - lt
          description: Comparison operator to be used.
        value:
          type: string
          format: date-time
          nullable: true
          description: Date value to compare with.
    RetriesDto:
      type: object
      properties:
        retries:
          type: integer
          format: int32
          nullable: true
          description: >-
            The number of retries to set for the resource.  Must be >= 0. If
            this is 0, an incident is created

            and the task, or job, cannot be fetched, or acquired anymore unless
            the retries are increased again.

            Can not be null.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````