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

> Sets the removal time to multiple historic decision instances asynchronously
(batch).

At least `historicDecisionInstanceIds` or
`historicDecisionInstanceQuery` has to be provided. If both are
provided, all instances matching query criterion and instances from the list
will be updated with a removal time.



## OpenAPI

````yaml POST /history/decision-instance/set-removal-time
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:
  /history/decision-instance/set-removal-time:
    post:
      tags:
        - Historic Decision Instance
      summary: Set Removal Time Async (POST)
      description: >-
        Sets the removal time to multiple historic decision instances
        asynchronously

        (batch).


        At least `historicDecisionInstanceIds` or

        `historicDecisionInstanceQuery` has to be provided. If both are

        provided, all instances matching query criterion and instances from the
        list

        will be updated with a removal time.
      operationId: setRemovalTimeAsyncHistoricDecisionInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SetRemovalTimeToHistoricDecisionInstancesDto
            examples:
              example-1:
                summary: POST `/history/decision-instance/set-removal-time`
                description: POST `/history/decision-instance/set-removal-time`
                value:
                  absoluteRemovalTime: 2019-05-05T11:56:24.725+0200
                  hierarchical: true
                  historicDecisionInstanceQuery:
                    evaluatedBefore: 2019-09-05T17:02:10.123+0200
                  historicDecisionInstanceIds:
                    - b4d2ad98-7240-11e9-98b7-be5e0f7575b7
                    - b4d2ad94-7240-11e9-98b7-be5e0f7575b7
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDto'
              examples:
                example-1:
                  summary: POST `/history/decision-instance/set-removal-time`
                  description: POST `/history/decision-instance/set-removal-time`
                  value:
                    id: 120b568d-724a-11e9-98b7-be5e0f7575b7
                    type: decision-set-removal-time
                    totalJobs: 12
                    batchJobsPerSeed: 100
                    jobsCreated: 10
                    invocationsPerBatchJob: 1
                    seedJobDefinitionId: 120b5690-724a-11e9-98b7-be5e0f7575b7
                    monitorJobDefinitionId: 120b568f-724a-11e9-98b7-be5e0f7575b7
                    batchJobDefinitionId: 120b568e-724a-11e9-98b7-be5e0f7575b7
                    suspended: false
                    tenantId: accounting
                    createUserId: demo-user
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Request was unsuccessfull due to a bad user request. This occurs if

            some of the query parameters are invalid, e. g. if neither

            historicDecisionInstances nor historicDecisionInstanceQuery is

            present or if no mode is specified.


            See the

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

            for the error response format.
components:
  schemas:
    SetRemovalTimeToHistoricDecisionInstancesDto:
      allOf:
        - type: object
          properties:
            hierarchical:
              type: boolean
              nullable: true
              description: >-
                Sets the removal time to all historic decision instances in the
                hierarchy.

                Value may only be `true`, as `false` is the default behavior.
            historicDecisionInstanceQuery:
              $ref: '#/components/schemas/HistoricDecisionInstanceQueryDto'
            historicDecisionInstanceIds:
              type: array
              nullable: true
              items:
                type: string
              description: >-
                The ids of the historic decision instances to set the removal
                time for.
        - $ref: '#/components/schemas/AbstractSetRemovalTimeDto'
    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).
    HistoricDecisionInstanceQueryDto:
      type: object
      description: >-
        A historic decision instance query which defines a list of historic
        decision instances
      properties:
        decisionInstanceId:
          type: string
          nullable: true
          description: Filter by decision instance id.
        decisionInstanceIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Filter by decision instance ids. Must be a comma-separated list of
            decision instance ids.
        decisionDefinitionId:
          type: string
          nullable: true
          description: Filter by the decision definition the instances belongs to.
        decisionDefinitionIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Filter by the decision definitions the instances belongs to. Must be
            a

            comma-separated list of decision definition ids.
        decisionDefinitionKey:
          type: string
          nullable: true
          description: >-
            Filter by the key of the decision definition the instances belongs
            to.
        decisionDefinitionKeyIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Filter by the keys of the decision definition the instances belongs
            to. Must be a comma-

            separated list of decision definition keys.
        decisionDefinitionName:
          type: string
          nullable: true
          description: >-
            Filter by the name of the decision definition the instances belongs
            to.
        decisionDefinitionNameLike:
          type: string
          nullable: true
          description: >-
            Filter by the name of the decision definition the instances belongs
            to, that the parameter

            is a substring of.
        processDefinitionId:
          type: string
          nullable: true
          description: Filter by the process definition the instances belongs to.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            Filter by the key of the process definition the instances belongs
            to.
        processInstanceId:
          type: string
          nullable: true
          description: Filter by the process instance the instances belongs to.
        caseDefinitionId:
          type: string
          nullable: true
          description: Filter by the case definition the instances belongs to.
        caseDefinitionKey:
          type: string
          nullable: true
          description: Filter by the key of the case definition the instances belongs to.
        caseInstanceId:
          type: string
          nullable: true
          description: Filter by the case instance the instances belongs to.
        activityIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: |-
            Filter by the activity ids the instances belongs to.
            Must be a comma-separated list of acitvity ids.
        activityInstanceIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: |-
            Filter by the activity instance ids the instances belongs to.
            Must be a comma-separated list of acitvity instance ids.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Filter by a comma-separated list of tenant ids. A historic decision
            instance must have one

            of the given tenant ids.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Only include historic decision instances that belong to no tenant.
            Value may only be

            `true`, as `false` is the default behavior.
        evaluatedBefore:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to instances that were evaluated 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`.
        evaluatedAfter:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to instances that were evaluated 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`.
        userId:
          type: string
          nullable: true
          description: Restrict to instances that were evaluated by the given user.
        rootDecisionInstanceId:
          type: string
          nullable: true
          description: |-
            Restrict to instances that have a given root decision instance id.
            This also includes the decision instance with the given id.
        rootDecisionInstancesOnly:
          type: boolean
          nullable: true
          description: >-
            Restrict to instances those are the root decision instance of an
            evaluation.

            Value may only be `true`, as `false` is the default behavior.
        decisionRequirementsDefinitionId:
          type: string
          nullable: true
          description: >-
            Filter by the decision requirements definition the instances belongs
            to.
        decisionRequirementsDefinitionKey:
          type: string
          nullable: true
          description: >-
            Filter by the key of the decision requirements definition the
            instances belongs to.
        includeInputs:
          type: boolean
          nullable: true
          description: |-
            Include input values in the result.
            Value may only be `true`, as `false` is the default behavior.
        includeOutputs:
          type: boolean
          nullable: true
          description: |-
            Include output values in the result.
            Value may only be `true`, as `false` is the default behavior.
        disableBinaryFetching:
          type: boolean
          nullable: true
          description: |-
            Disables fetching of byte array input and output values.
            Value may only be `true`, as `false` is the default behavior.
        disableCustomObjectDeserialization:
          type: boolean
          nullable: true
          description: >-
            Disables deserialization of input and output values that are custom
            objects.

            Value may only be `true`, as `false` is the default behavior.
    AbstractSetRemovalTimeDto:
      type: object
      properties:
        absoluteRemovalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date for which the instances shall be removed. Value may not be
            `null`.


            **Note:** Cannot be set in conjunction with `clearedRemovalTime` or
            `calculatedRemovalTime`.
        clearedRemovalTime:
          type: boolean
          nullable: true
          description: >-
            Sets the removal time to `null`. Value may only be `true`, as
            `false` is the default behavior.


            **Note:** Cannot be set in conjunction with `absoluteRemovalTime` or
            `calculatedRemovalTime`.
        calculatedRemovalTime:
          type: boolean
          nullable: true
          description: >-
            The removal time is calculated based on the engine's configuration
            settings. Value may only be `true`, as `false` is the default
            behavior.


            **Note:** Cannot be set in conjunction with `absoluteRemovalTime` or
            `clearedRemovalTime`.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````