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

# 获取列表

> Queries for historic external task logs that fulfill the given parameters.
The size of the result set can be retrieved by using the
[Get External Task Log Count](https://docs.camunda.org/manual/7.22/reference/rest/history/external-task-log/get-external-task-log-query-count/)
method.



## OpenAPI

````yaml GET /history/external-task-log
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/external-task-log:
    get:
      tags:
        - Historic External Task Log
      summary: Get External Task Logs
      description: >-
        Queries for historic external task logs that fulfill the given
        parameters.

        The size of the result set can be retrieved by using the

        [Get External Task Log
        Count](https://docs.camunda.org/manual/7.22/reference/rest/history/external-task-log/get-external-task-log-query-count/)

        method.
      operationId: getHistoricExternalTaskLogs
      parameters:
        - name: logId
          in: query
          schema:
            type: string
          description: Filter by historic external task log id.
        - name: externalTaskId
          in: query
          schema:
            type: string
          description: Filter by external task id.
        - name: topicName
          in: query
          schema:
            type: string
          description: Filter by an external task topic.
        - name: workerId
          in: query
          schema:
            type: string
          description: >-
            Filter by the id of the worker that the task was most recently
            locked by.
        - name: errorMessage
          in: query
          schema:
            type: string
          description: Filter by external task exception message.
        - name: activityIdIn
          in: query
          schema:
            type: string
          description: >-
            Only include historic external task logs which belong to one of the
            passed activity ids.
        - name: activityInstanceIdIn
          in: query
          schema:
            type: string
          description: >-
            Only include historic external task logs which belong to one of the
            passed activity

            instance ids.
        - name: executionIdIn
          in: query
          schema:
            type: string
          description: >-
            Only include historic external task logs which belong to one of the
            passed execution ids.
        - name: processInstanceId
          in: query
          schema:
            type: string
          description: Filter by process instance id.
        - name: processDefinitionId
          in: query
          schema:
            type: string
          description: Filter by process definition id.
        - name: processDefinitionKey
          in: query
          schema:
            type: string
          description: Filter by process definition key.
        - name: tenantIdIn
          in: query
          schema:
            type: string
          description: >-
            Only include historic external task log entries which belong to one
            of the passed and

            comma-separated tenant ids.
        - name: withoutTenantId
          in: query
          schema:
            type: boolean
          description: >-
            Only include historic external task log entries that belong to no
            tenant. Value may only

            be `true`, as `false` is the default behavior.
        - name: priorityLowerThanOrEquals
          in: query
          schema:
            type: integer
            format: int64
          description: >-
            Only include logs for which the associated external task had a
            priority lower than or

            equal to the given value. Value must be a valid `long` value.
        - name: priorityHigherThanOrEquals
          in: query
          schema:
            type: integer
            format: int64
          description: >-
            Only include logs for which the associated external task had a
            priority higher than or

            equal to the given value. Value must be a valid `long` value.
        - name: creationLog
          in: query
          schema:
            type: boolean
          description: >-
            Only include creation logs. Value may only be `true`, as `false` is
            the default behavior.
        - name: failureLog
          in: query
          schema:
            type: boolean
          description: >-
            Only include failure logs. Value may only be `true`, as `false` is
            the default behavior.
        - name: successLog
          in: query
          schema:
            type: boolean
          description: >-
            Only include success logs. Value may only be `true`, as `false` is
            the default behavior.
        - name: deletionLog
          in: query
          schema:
            type: boolean
          description: >-
            Only include deletion logs. Value may only be `true`, as `false` is
            the default behavior.
        - name: sortBy
          in: query
          schema:
            enum:
              - timestamp
              - externalTaskId
              - topicName
              - workerId
              - retries
              - priority
              - activityId
              - activityInstanceId
              - executionId
              - processInstanceId
              - processDefinitionId
              - processDefinitionKey
              - tenantId
            type: string
          description: |-
            Sort the results lexicographically by a given criterion.
            Must be used in conjunction with the sortOrder parameter.
        - name: sortOrder
          in: query
          schema:
            enum:
              - asc
              - desc
            type: string
          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.
        - name: firstResult
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the index of the first result to
            return.
        - name: maxResults
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the maximum number of results to
            return.

            Will return less results if there are no more results left.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricExternalTaskLogDto'
              examples:
                example-1:
                  summary: >-
                    GET
                    `/history/external-task-log?externalTaskId=anExternalTaskId`
                  description: >-
                    GET
                    `/history/external-task-log?externalTaskId=anExternalTaskId`
                  value:
                    - id: someId
                      timestamp: 2017-01-15T15:22:20.000+0200
                      externalTaskId: anExternalTaskId
                      topicName: aTopicName
                      workerId: aWorkerId
                      retries: 3
                      priority: 5
                      errorMessage: An error occured!
                      activityId: externalServiceTask
                      activityInstanceId: externalServiceTask:15
                      executionId: anExecutionId
                      processInstanceId: aProcessInstanceId
                      processDefinitionId: aProcessDefinitionId
                      processDefinitionKey: aProcessDefinitionKey
                      tenantId: null
                      creationLog: false
                      failureLog: true
                      successLog: false
                      deletionLog: false
                      removalTime: 2018-02-10T14:33:19.000+0200
                      rootProcessInstanceId: aRootProcessInstanceId
          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
            a `sortOrder`

            parameter is supplied, but no `sortBy`. See the

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

            for the error response format.
components:
  schemas:
    HistoricExternalTaskLogDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the log entry.
        externalTaskId:
          type: string
          nullable: true
          description: The id of the external task.
        timestamp:
          type: string
          format: date-time
          nullable: true
          description: The time when the log entry has been written.
        topicName:
          type: string
          nullable: true
          description: The topic name of the associated external task.
        workerId:
          type: string
          nullable: true
          description: The id of the worker that posessed the most recent lock.
        retries:
          type: integer
          format: int32
          nullable: true
          description: The number of retries the associated external task has left.
        priority:
          type: integer
          format: int64
          nullable: true
          description: >-
            The execution priority the external task had when the log entry was
            created.
        errorMessage:
          type: string
          nullable: true
          description: >-
            The message of the error that occurred by executing the associated
            external task.
        activityId:
          type: string
          nullable: true
          description: >-
            The id of the activity on which the associated external task was
            created.
        activityInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the activity instance on which the associated external
            task was created.
        executionId:
          type: string
          nullable: true
          description: The execution id on which the associated external task was created.
        processInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the process instance on which the associated external task
            was created.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            The id of the process definition which the associated external task
            belongs to.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            The key of the process definition which the associated external task
            belongs to.
        tenantId:
          type: string
          nullable: true
          description: >-
            The id of the tenant that this historic external task log entry
            belongs to.
        creationLog:
          type: boolean
          nullable: true
          description: >-
            A flag indicating whether this log represents the creation of the
            associated

            external task.
        failureLog:
          type: boolean
          nullable: true
          description: >-
            A flag indicating whether this log represents the failed execution
            of the

            associated external task.
        successLog:
          type: boolean
          nullable: true
          description: >-
            A flag indicating whether this log represents the successful
            execution of the

            associated external task.
        deletionLog:
          type: boolean
          nullable: true
          description: >-
            A flag indicating whether this log represents the deletion of the
            associated

            external task.
        removalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time after which this log should be removed by the History
            Cleanup job. 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/)
        rootProcessInstanceId:
          type: string
          nullable: true
          description: >-
            The process instance id of the root process instance that initiated
            the process

            containing this log.
    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).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````