swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GetAccessReviewHistoryDefinitionInstances API
schemes:
- https
tags:
- name: GetAccessReviewHistoryDefinitionInstances
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}/instances
  : get:
      tags:
      - GetAccessReviewHistoryDefinitionInstances
      operationId: microsoftAzureAccessreviewhistorydefinitioninstancesList
      x-ms-examples:
        GetAccessReviewHistoryDefinitionInstances:
          $ref: ./examples/GetAccessReviewHistoryDefinitionInstances.json
      description: Get access review history definition instances by definition Id
      parameters:
      - name: historyDefinitionId
        in: path
        required: true
        type: string
        description: The id of the access review history definition.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Describe the result of a successful operation.
          schema:
            $ref: '#/definitions/AccessReviewHistoryDefinitionInstanceListResult'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/ErrorDefinition'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Authorization Accessreviewhistorydefinitions Historydefinitionid Instances
definitions:
  ErrorDefinition:
    type: object
    title: Error
    description: Error description and code explaining why an operation failed.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinitionProperties'
        description: Error of the list gateway status.
  AccessReviewHistoryInstance:
    x-ms-azure-resource: true
    type: object
    properties:
      id:
        type: string
        readOnly: true
        description: The access review history definition instance id.
      name:
        type: string
        readOnly: true
        description: The access review history definition instance unique id.
      type:
        type: string
        readOnly: true
        description: The resource type.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewHistoryInstanceProperties'
        description: Access Review History Definition Instance properties.
    description: Access Review History Definition Instance.
  AccessReviewHistoryDefinitionInstanceListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/AccessReviewHistoryInstance'
        description: Access Review History Definition's Instance list.
      nextLink:
        type: string
        description: The URL to use for getting the next set of results.
    description: List of Access Review History Instances.
  ErrorDefinitionProperties:
    type: object
    title: Error
    description: Error description and code explaining why an operation failed.
    properties:
      message:
        type: string
        readOnly: true
        description: Description of the error.
      code:
        type: string
        description: Error code of list gateway.
  AccessReviewHistoryInstanceProperties:
    type: object
    properties:
      reviewHistoryPeriodStartDateTime:
        type: string
        format: date-time
        readOnly: false
        description: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
      reviewHistoryPeriodEndDateTime:
        type: string
        format: date-time
        readOnly: false
        description: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
      displayName:
        type: string
        description: The display name for the parent history definition.
      status:
        type: string
        readOnly: true
        description: Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
        enum:
        - Requested
        - InProgress
        - Done
        - Error
        x-ms-enum:
          name: AccessReviewHistoryDefinitionStatus
          modelAsString: true
      runDateTime:
        type: string
        format: date-time
        description: Date time when the history data report is scheduled to be generated.
        x-nullable: true
      fulfilledDateTime:
        type: string
        format: date-time
        description: Date time when the history data report is scheduled to be generated.
        x-nullable: true
      downloadUri:
        readOnly: true
        type: string
        description: Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
      expiration:
        type: string
        format: date-time
        description: Date time when history data report expires and the associated data is deleted.
        x-nullable: true
    description: Access Review History Definition Instance properties.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The ID of the target subscription.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'