Microsoft Azure InsightAttachments API

openapi: 3.2.0
info:
  title: Microsoft Azure Insight Attachments API
  version: '1.0'
  description: 'Operations tagged InsightAttachments across 2 of this provider''s published API definitions: azure-agfoodplatform-data-plane-service-openapi-original.yml, microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml. Each path carries the servers of the definition it was published in.'
security:
- Bearer: []
tags:
- name: InsightAttachments
paths:
  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments:
    get:
      tags:
      - InsightAttachments
      description: Returns a paginated list of insight resources.
      operationId: microsoftAzureInsightattachmentsListbypartyidmodelidandresource
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: path
        name: modelId
        description: Id of the associated model.
        required: true
        schema:
          type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        schema:
          type: string
      - in: query
        name: insightIds
        description: List of insight IDs.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: ids
        description: Ids of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: names
        description: Names of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: propertyFilters
        description: 'Filters on key-value pairs within the Properties object.

          eg. "{testKey} eq {testValue}".'
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: statuses
        description: Statuses of the resource.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        schema:
          type: string
          format: date-time
      - in: query
        name: maxPageSize
        description: 'Maximum number of items needed (inclusive).

          Minimum = 10, Maximum = 1000, Default value = 50.'
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightAttachmentListResponse'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        InsightAttachments_ListByPartyIdModelIdAndResource:
          $ref: ./examples/InsightAttachments_ListByPartyIdModelIdAndResource.json
      summary: Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype…
  ? /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}
  : patch:
      tags:
      - InsightAttachments
      description: Creates or updates insight entity.
      operationId: microsoftAzureInsightattachmentsCreateorupdate
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: path
        name: modelId
        description: 'Id of the associated model.

          It can be either ''BiomassModelId'', ''SensorPlacementModelId'', ''SoilMoistureModelId'' or any solution id.'
        required: true
        schema:
          type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        schema:
          type: string
      - in: path
        name: insightAttachmentId
        description: Id of the insight resource.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightAttachment'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightAttachment'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        InsightAttachments_CreateOrUpdate:
          $ref: ./examples/InsightAttachments_CreateOrUpdate.json
      summary: Microsoft Azure Patch Parties Partyid Models Modelid Resource Types…
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: File to be uploaded.
                insightId:
                  type: string
                  description: InsightID for this InsightAttachment.
                originalFileName:
                  type: string
                  description: Original File Name for this attachment.
                id:
                  type: string
                  description: Unique id.
                status:
                  type: string
                  maxLength: 100
                  minLength: 0
                  description: Status of the resource.
                createdDateTime:
                  type: string
                  format: date-time
                  description: Date when resource was created.
                modifiedDateTime:
                  type: string
                  format: date-time
                  description: Date when resource was last modified.
                source:
                  type: string
                  maxLength: 100
                  minLength: 2
                  description: Source of the resource.
                name:
                  type: string
                  maxLength: 100
                  minLength: 0
                  description: Name to identify resource.
                description:
                  type: string
                  maxLength: 500
                  minLength: 0
                  description: Textual description of resource.
                createdBy:
                  type: string
                  description: Created by user/tenant id.
                modifiedBy:
                  type: string
                  description: Modified by user/tenant id.
              required:
              - insightId
    get:
      tags:
      - InsightAttachments
      description: Gets a specified insight resource under a particular party.
      operationId: microsoftAzureInsightattachmentsGet
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: path
        name: modelId
        description: 'Id of the associated model.

          It can be either ''BiomassModelId'', ''SensorPlacementModelId'', ''SoilMoistureModelId'' or any solution id.'
        required: true
        schema:
          type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        schema:
          type: string
      - in: path
        name: insightAttachmentId
        description: Id of the insight attachment resource.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightAttachment'
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        InsightAttachments_Get:
          $ref: ./examples/InsightAttachments_Get.json
      summary: Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype…
    delete:
      tags:
      - InsightAttachments
      description: Deletes a specified insight resource.
      operationId: microsoftAzureInsightattachmentsDelete
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: path
        name: modelId
        description: 'Id of the associated model.

          It can be either ''BiomassModelId'', ''SensorPlacementModelId'', ''SoilMoistureModelId'' or any solution id.'
        required: true
        schema:
          type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        schema:
          type: string
      - in: path
        name: insightAttachmentId
        description: Id of the insight attachment resource.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        InsightAttachments_Delete:
          $ref: ./examples/InsightAttachments_Delete.json
      summary: Microsoft Azure Delete Parties Partyid Models Modelid Resource Types…
  ? /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}/file
  : get:
      tags:
      - InsightAttachments
      description: Downloads and returns insight-attachment as response for the given input filePath.
      operationId: microsoftAzureInsightattachmentsDownload
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        schema:
          type: string
      - in: path
        name: modelId
        description: 'Id of the associated model.

          It can be either ''BiomassModelId'', ''SensorPlacementModelId'', ''SoilMoistureModelId'' or any solution id.'
        required: true
        schema:
          type: string
      - in: path
        name: resourceType
        description: Resource type associated with the record.
        required: true
        schema:
          type: string
      - in: path
        name: resourceId
        description: Id of the associated resource.
        required: true
        schema:
          type: string
      - in: path
        name: insightAttachmentId
        description: Id of the insight attachment resource.
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                format: binary
                type: string
            application/octet-stream:
              schema:
                format: binary
                type: string
        default:
          description: Error
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        InsightAttachments_Download:
          $ref: ./examples/InsightAttachments_Download.json
      summary: Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype…
components:
  schemas:
    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: '#/components/schemas/Error'
        innererror:
          $ref: '#/components/schemas/InnerError'
    InsightAttachment:
      description: Schema of insight attachment resource.
      required:
      - insightId
      type: object
      properties:
        insightId:
          description: InsightID for this InsightAttachment.
          minLength: 1
          type: string
        modelId:
          description: ModelID for this InsightAttachment.
          type: string
          readOnly: true
        resourceType:
          description: Associated Resource type for this attachment.
          enum:
          - Party
          - Farm
          - Field
          - SeasonalField
          - Boundary
          type: string
          readOnly: true
          x-ms-enum:
            name: FarmHierarchyResourceType
            modelAsString: true
        resourceId:
          description: Associated Resource id for this attachment.
          type: string
          readOnly: true
        originalFileName:
          description: Original File Name for this attachment.
          type: string
          readOnly: true
        partyId:
          description: PartyId id for this attachment.
          type: string
          readOnly: true
        id:
          description: Unique id.
          type: string
          readOnly: true
        status:
          description: Status of the resource.
          maxLength: 100
          minLength: 0
          type: string
        createdDateTime:
          format: date-time
          description: Date when resource was created.
          type: string
          readOnly: true
        modifiedDateTime:
          format: date-time
          description: Date when resource was last modified.
          type: string
          readOnly: true
        source:
          description: Source of the resource.
          maxLength: 100
          minLength: 2
          type: string
        name:
          description: Name to identify resource.
          maxLength: 100
          minLength: 0
          type: string
        description:
          description: Textual description of 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
        eTag:
          description: The ETag value to implement optimistic concurrency.
          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: '#/components/schemas/InnerError'
    InsightAttachmentListResponse:
      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: '#/components/schemas/InsightAttachment'
        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
    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: '#/components/schemas/Error'
        traceId:
          description: Unique trace Id.
          type: string
    InsightAttachment_2:
      description: Schema of insight attachment resource.
      required:
      - insightId
      type: object
      properties:
        insightId:
          description: InsightID for this InsightAttachment.
          minLength: 1
          type: string
        modelId:
          description: ModelID for this InsightAttachment.
          type: string
          readOnly: true
        resourceType:
          description: Associated Resource type for this attachment.
          enum:
          - Party
          - Farm
          - Field
          - SeasonalField
          type: string
          readOnly: true
          x-ms-enum:
            name: FarmHierarchyResourceType
            modelAsString: true
        resourceId:
          description: Associated Resource id for this attachment.
          type: string
          readOnly: true
        originalFileName:
          description: Original File Name for this attachment.
          type: string
          readOnly: true
        partyId:
          description: PartyId id for this attachment.
          type: string
          readOnly: true
        id:
          description: Unique id.
          type: string
          readOnly: true
        status:
          description: Status of the resource.
          maxLength: 100
          minLength: 0
          type: string
        createdDateTime:
          format: date-time
          description: Date when resource was created.
          type: string
          readOnly: true
        modifiedDateTime:
          format: date-time
          description: Date when resource was last modified.
          type: string
          readOnly: true
        source:
          description: Source of the resource.
          maxLength: 100
          minLength: 2
          type: string
        name:
          description: Name to identify resource.
          maxLength: 100
          minLength: 0
          type: string
        description:
          description: Textual description of 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
        eTag:
          description: The ETag value to implement optimistic concurrency.
          type: string
          readOnly: true
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.
x-refined-from:
- azure-agfoodplatform-data-plane-service-openapi-original.yml
- microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'