swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SensorEvents API
schemes:
- https
tags:
- name: SensorEvents
paths:
  /sensor-events:
    get:
      tags:
      - SensorEvents
      description: Returns a list of sensor events data. Time span for query is limited to 90 days at a time.<br>Returns last 90 days events when startDateTime and endDateTime are not provided.
      operationId: microsoftAzureSensoreventsList
      produces:
      - application/json
      parameters:
      - in: query
        name: sensorId
        description: Id of the associated sensor.
        required: true
        type: string
      - in: query
        name: sensorPartnerId
        description: Id of the associated sensor partner.
        required: true
        type: string
      - in: query
        name: startDateTime
        description: "Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided."
        type: string
        format: date-time
      - in: query
        name: endDateTime
        description: "Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided."
        type: string
        format: date-time
      - in: query
        name: excludeDuplicateEvents
        description: 'Flag to exclude duplicate events and take the latest ones only (Default: true).'
        type: boolean
        default: true
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SensorEventListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        SensorEvents_List:
          $ref: ./examples/SensorEvents_List.json
      summary: Microsoft Azure Get Sensor Events
definitions:
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  SensorEvent:
    description: Sensor event response model.
    type: object
    properties:
      sensorId:
        description: Id of the sensor.
        type: string
      sensorPartnerId:
        description: Id of the sensor partner.
        type: string
      partyId:
        description: Id of the associated party.
        type: string
      boundaryId:
        description: Id of the associated boundary.
        type: string
      eventDateTime:
        format: date-time
        description: DateTime of sensor event observation.
        type: string
      ingestionDateTime:
        format: date-time
        description: DateTime of sensor event ingestion to data store.
        type: string
      measures:
        description: Sensor measures.
        type: object
        additionalProperties: {}
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  SensorEventListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/SensorEvent'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'