swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Insights API
schemes:
- https
tags:
- name: Insights
paths:
  /insights/cascade-delete/{jobId}:
    put:
      tags:
      - Insights
      description: Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.
      operationId: microsoftAzureInsightsCreatecascadedeletejob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Job ID supplied by end user.
        required: true
        type: string
      - in: query
        name: partyId
        description: ID of the associated party.
        required: true
        type: string
      - in: query
        name: modelId
        description: Id of the associated model.
        required: true
        type: string
      - in: query
        name: resourceType
        description: Resource Type.
        required: true
        type: string
      - in: query
        name: resourceId
        description: Id of the associated resource.
        required: true
        type: string
      - in: query
        name: insightId
        description: Insight id.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        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-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Insights_CreateCascadeDeleteJob:
          $ref: ./examples/Insights_CreateCascadeDeleteJob.json
      summary: Microsoft Azure Put Insights Cascade Delete Jobid
    get:
      tags:
      - Insights
      description: Get a cascade delete job for specified insight.
      operationId: microsoftAzureInsightsGetcascadedeletejobdetails
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        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:
        Insights_GetCascadeDeleteJobDetails:
          $ref: ./examples/Insights_GetCascadeDeleteJobDetails.json
      summary: Microsoft Azure Get Insights Cascade Delete Jobid
  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights:
    get:
      tags:
      - Insights
      description: Returns a paginated list of insight resources.
      operationId: microsoftAzureInsightsListbypartyidmodelidandresource
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: path
        name: modelId
        description: Id of the associated model.
        required: true
        type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        type: string
      - in: query
        name: minInsightStartDateTime
        description: 'Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        format: date-time
      - in: query
        name: maxInsightStartDateTime
        description: 'Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        format: date-time
      - in: query
        name: minInsightEndDateTime
        description: 'Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        format: date-time
      - in: query
        name: maxInsightEndDateTime
        description: 'Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        format: date-time
      - in: query
        name: measurementFilters
        description: "Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object.\r\neg. \"measureKey.unit eq {testValue}\" where testValue is string.\r\neg. \"measureKey.value eq {testValue}\" where testValue = double."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/InsightListResponse'
        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-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Insights_ListByPartyIdModelIdAndResource:
          $ref: ./examples/Insights_ListByPartyIdModelIdAndResource.json
      summary: Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insights
  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}:
    patch:
      tags:
      - Insights
      description: Creates or updates insight entity.
      operationId: microsoftAzureInsightsCreateorupdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: path
        name: modelId
        description: "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id."
        required: true
        type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        type: string
      - in: path
        name: insightId
        description: Id of the insight resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: insightData
        description: Insight data.
        required: true
        schema:
          $ref: '#/definitions/Insight'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Insight'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Insight'
        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:
        Insights_CreateOrUpdate:
          $ref: ./examples/Insights_CreateOrUpdate.json
      summary: Microsoft Azure Patch Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insights Insightid
    get:
      tags:
      - Insights
      description: Gets a specified insight resource under a particular party.
      operationId: microsoftAzureInsightsGet
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: path
        name: modelId
        description: "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id."
        required: true
        type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        type: string
      - in: path
        name: insightId
        description: Id of the insight resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Insight'
        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:
        Insights_Get:
          $ref: ./examples/Insights_Get.json
      summary: Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insights Insightid
    delete:
      tags:
      - Insights
      description: Deletes a specified insight resource.
      operationId: microsoftAzureInsightsDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: path
        name: modelId
        description: "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id."
        required: true
        type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        type: string
      - in: path
        name: insightId
        description: Id of the insight resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        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:
        Insights_Delete:
          $ref: ./examples/Insights_Delete.json
      summary: Microsoft Azure Delete Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insights Insightid
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
  Measure:
    description: Schema for storing measurement reading and unit.
    type: object
    properties:
      unit:
        description: Data unit.
        maxLength: 50
        minLength: 1
        type: string
      value:
        format: double
        description: Data value.
        type: number
  InsightListResponse:
    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/Insight'
      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
  CascadeDeleteJob:
    description: Schema of cascade delete job.
    required:
    - partyId
    - resourceId
    - resourceType
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      resourceId:
        description: The id of the resource.
        minLength: 1
        type: string
      resourceType:
        description: The type of the resource.
        minLength: 1
        type: string
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        enum:
        - Waiting
        - Running
        - Succeeded
        - Failed
        - Cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
  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'
  Insight:
    description: Schema of insight resource.
    type: object
    properties:
      partyId:
        description: Id of the associated party.
        type: string
        readOnly: true
      modelId:
        description: Id of the associated model.
        type: string
        readOnly: true
      resourceType:
        description: Resource type associated with the record.
        enum:
        - Party
        - Farm
        - Field
        - SeasonalField
        - Boundary
        type: string
        readOnly: true
        x-ms-enum:
          name: FarmHierarchyResourceType
          modelAsString: true
      resourceId:
        description: Id of the associated resource.
        type: string
        readOnly: true
      modelVersion:
        description: Version of the associated model.
        type: string
      attachmentsLink:
        description: Gets link for attachments.
        type: string
        readOnly: true
      insightStartDateTime:
        format: date-time
        description: Start date to which the insight is related.
        type: string
      insightEndDateTime:
        format: date-time
        description: End date to which the insight is related.
        type: string
      measurements:
        description: Measures to capture insights results.
        type: object
        additionalProperties:
          $ref: '#/definitions/Measure'
      id:
        description: Id of the resource.
        type: string
        readOnly: true
      status:
        description: Status of the resource.
        maxLength: 100
        minLength: 0
        type: string
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'