> ## 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 identity link logs that fulfill given parameters.
The size of the result set can be retrieved by using the
[Get Identity-Link-Log Count](https://docs.camunda.org/manual/7.22/reference/rest/history/identity-links/get-identity-link-query-count/)
method.



## OpenAPI

````yaml GET /history/identity-link-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/identity-link-log:
    get:
      tags:
        - Historic Identity Link Log
      summary: Get Identity Link Logs
      description: >-
        Queries for historic identity link logs that fulfill given parameters.

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

        [Get Identity-Link-Log
        Count](https://docs.camunda.org/manual/7.22/reference/rest/history/identity-links/get-identity-link-query-count/)

        method.
      operationId: getHistoricIdentityLinks
      parameters:
        - name: type
          in: query
          schema:
            type: string
          description: >-
            Restricts to identity links that have the given type
            (candidate/assignee/owner).
        - name: userId
          in: query
          schema:
            type: string
          description: Restricts to identity links that have the given user id.
        - name: groupId
          in: query
          schema:
            type: string
          description: Restricts to identity links that have the given group id.
        - name: dateBefore
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Restricts to identity links that have the time before the given
            time.
        - name: dateAfter
          in: query
          schema:
            type: string
            format: date-time
          description: Restricts to identity links that have the time after the given time.
        - name: taskId
          in: query
          schema:
            type: string
          description: Restricts to identity links that have the given task id.
        - name: processDefinitionId
          in: query
          schema:
            type: string
          description: >-
            Restricts to identity links that have the given process definition
            id.
        - name: processDefinitionKey
          in: query
          schema:
            type: string
          description: >-
            Restricts to identity links that have the given process definition
            key.
        - name: operationType
          in: query
          schema:
            type: string
          description: >-
            Restricts to identity links that have the given operationType
            (add/delete).
        - name: assignerId
          in: query
          schema:
            type: string
          description: Restricts to identity links that have the given assigner id.
        - name: tenantIdIn
          in: query
          schema:
            type: string
          description: Filter by a comma-separated list of tenant ids.
        - name: withoutTenantId
          in: query
          schema:
            type: boolean
          description: >-
            Only include historic identity links that belong to no tenant. Value
            may only be

            `true`, as `false` is the default behavior.
        - name: sortBy
          in: query
          schema:
            enum:
              - time
              - type
              - userId
              - groupId
              - taskId
              - processDefinitionId
              - processDefinitionKey
              - operationType
              - assignerId
              - 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/HistoricIdentityLinkLogDto'
              examples:
                example-1:
                  summary: GET `/history/identity-link-log?taskId=aTaskId`
                  description: GET `/history/identity-link-log?taskId=aTaskId`
                  value:
                    - id: '1'
                      time: 2014-03-01T08:00:00.000+0200
                      type: candidate
                      userId: aUserId
                      groupId: aGroupId
                      taskId: aTaskId
                      processDefinitionId: '12'
                      operationType: add
                      assignerId: aAssignerId
                      processDefinitionKey: oneTaskProcess
                      tenantId: tenant1
                      removalTime: 2018-02-10T14:33:19.000+0200
                      rootProcessInstanceId: aRootProcessInstanceId
                    - id: '2'
                      time: 2014-03-05T10:00:00.000+0200
                      type: candidate
                      userId: aUserId
                      groupId: aGroupId
                      taskId: aTaskId
                      processDefinitionId: '12'
                      operationType: delete
                      assignerId: aAssignerId
                      processDefinitionKey: oneTaskProcess
                      tenantId: tenant1
                      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:
    HistoricIdentityLinkLogDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: Id of the Historic identity link entry.
        time:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time when the identity link is logged. 

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        type:
          type: string
          nullable: true
          description: The type of identity link (candidate/assignee/owner).
        userId:
          type: string
          nullable: true
          description: The id of the user/assignee.
        groupId:
          type: string
          nullable: true
          description: The id of the group.
        taskId:
          type: string
          nullable: true
          description: The id of the task.
        processDefinitionId:
          type: string
          nullable: true
          description: The id of the process definition.
        processDefinitionKey:
          type: string
          nullable: true
          description: The key of the process definition.
        operationType:
          type: string
          nullable: true
          description: Type of operation (add/delete).
        assignerId:
          type: string
          nullable: true
          description: The id of the assigner.
        tenantId:
          type: string
          nullable: true
          description: The id of the tenant.
        removalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time after which the identity link should be removed by the
            History Cleanup job. 

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        rootProcessInstanceId:
          type: string
          nullable: true
          description: >-
            The process instance id of the root process instance that initiated
            the process

            containing this identity link.
    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

````