The Microsoft Azure Ag Food Platform Data Plane Service is designed to provide farmers and agricultural businesses with a comprehensive solution for managing and analyzing their data. This service allows users to collect, store, and process data from various sources, such as sensors, drones, and satellite imagery, in order to gain valuable insights that can improve crop yield, optimize resource allocation, and enhance overall operations.
swagger: '2.0'
info:
title: Microsoft Azure Azure AgFoodPlatform Data Plane Service
description: APIs documentation for Azure AgPlatform DataPlane Service.
version: 2022-11-01-preview
paths:
/application-data:
get:
tags:
- ApplicationData
description: >-
Returns a paginated list of application data resources across all
parties.
operationId: microsoftAzureApplicationdataList
produces:
- application/json
parameters:
- in: query
name: minAvgMaterial
description: >-
Minimum average amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: maxAvgMaterial
description: >-
Maximum average amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: minTotalMaterial
description: >-
Minimum total amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: maxTotalMaterial
description: >-
Maximum total amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: sources
description: Sources of the operation data.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: associatedBoundaryIds
description: Boundary IDs associated with operation data.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: minOperationStartDateTime
description: >-
Minimum start date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: maxOperationStartDateTime
description: >-
Maximum start date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: minOperationEndDateTime
description: >-
Minimum end date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: maxOperationEndDateTime
description: >-
Maximum end date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: minOperationModifiedDateTime
description: >-
Minimum modified date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: maxOperationModifiedDateTime
description: >-
Maximum modified date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: minArea
description: Minimum area for which operation was applied (inclusive).
type: number
format: double
- in: query
name: maxArea
description: Maximum area for which operation was applied (inclusive).
type: number
format: double
- 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/ApplicationDataListResponse'
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:
ApplicationData_List:
$ref: ./examples/ApplicationData_List.json
summary: Microsoft Azure Get Application Data
/application-data/cascade-delete/{jobId}:
put:
tags:
- ApplicationData
description: Create cascade delete job for application data resource.
operationId: microsoftAzureApplicationdataCreatecascadedeletejob
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 party.
required: true
type: string
- in: query
name: applicationDataId
description: Id of the application data.
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:
ApplicationData_CreateCascadeDeleteJob:
$ref: ./examples/ApplicationData_CreateCascadeDeleteJob.json
summary: Microsoft Azure Put Application Data Cascade Delete Jobid
get:
tags:
- ApplicationData
description: Get cascade delete job for application data resource.
operationId: microsoftAzureApplicationdataGetcascadedeletejobdetails
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:
ApplicationData_GetCascadeDeleteJobDetails:
$ref: ./examples/ApplicationData_GetCascadeDeleteJobDetails.json
summary: Microsoft Azure Get Application Data Cascade Delete Jobid
/parties/{partyId}/application-data:
get:
tags:
- ApplicationData
description: >-
Returns a paginated list of application data resources under a
particular party.
operationId: microsoftAzureApplicationdataListbypartyid
produces:
- application/json
parameters:
- in: path
name: partyId
description: ID of the associated party.
required: true
type: string
- in: query
name: minAvgMaterial
description: >-
Minimum average amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: maxAvgMaterial
description: >-
Maximum average amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: minTotalMaterial
description: >-
Minimum total amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: maxTotalMaterial
description: >-
Maximum total amount of material applied during the application
(inclusive).
type: number
format: double
- in: query
name: sources
description: Sources of the operation data.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: associatedBoundaryIds
description: Boundary IDs associated with operation data.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: minOperationStartDateTime
description: >-
Minimum start date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: maxOperationStartDateTime
description: >-
Maximum start date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: minOperationEndDateTime
description: >-
Minimum end date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: maxOperationEndDateTime
description: >-
Maximum end date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: minOperationModifiedDateTime
description: >-
Minimum modified date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: maxOperationModifiedDateTime
description: >-
Maximum modified date-time of the operation data, sample format:
yyyy-MM-ddTHH:mm:ssZ (inclusive).
type: string
format: date-time
- in: query
name: minArea
description: Minimum area for which operation was applied (inclusive).
type: number
format: double
- in: query
name: maxArea
description: Maximum area for which operation was applied (inclusive).
type: number
format: double
- 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/ApplicationDataListResponse'
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:
ApplicationData_ListByPartyId:
$ref: ./examples/ApplicationData_ListByPartyId.json
summary: Microsoft Azure Get Parties Partyid Application Data
/parties/{partyId}/application-data/{applicationDataId}:
get:
tags:
- ApplicationData
description: Get a specified application data resource under a particular party.
operationId: microsoftAzureApplicationdataGet
produces:
- application/json
parameters:
- in: path
name: partyId
description: ID of the associated party resource.
required: true
type: string
- in: path
name: applicationDataId
description: ID of the application data 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/ApplicationData'
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:
ApplicationData_Get:
$ref: ./examples/ApplicationData_Get.json
summary: Microsoft Azure Get Parties Partyid Application Data Applicationdataid
patch:
tags:
- ApplicationData
description: >-
Creates or updates an application data resource under a particular
party.
operationId: microsoftAzureApplicationdataCreateorupdate
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: applicationDataId
description: ID of the application data resource.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
- in: body
name: applicationData
description: Application data resource payload to create or update.
required: true
schema:
$ref: '#/definitions/ApplicationData'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ApplicationData'
'201':
description: Created
schema:
$ref: '#/definitions/ApplicationData'
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:
ApplicationData_CreateOrUpdate:
$ref: ./examples/ApplicationData_CreateOrUpdate.json
summary: Microsoft Azure Patch Parties Partyid Application Data Applicationdataid
delete:
tags:
- ApplicationData
description: Deletes a specified application data resource under a particular party.
operationId: microsoftAzureApplicationdataDelete
produces:
- application/json
parameters:
- in: path
name: partyId
description: ID of the associated party resource.
required: true
type: string
- in: path
name: applicationDataId
description: ID of the application data.
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:
ApplicationData_Delete:
$ref: ./examples/ApplicationData_Delete.json
summary: Microsoft Azure Delete Parties Partyid Application Data Applicationdataid
/parties/{partyId}/attachments:
get:
tags:
- Attachments
description: >-
Returns a paginated list of attachment resources under a particular
party.
operationId: microsoftAzureAttachmentsListbypartyid
produces:
- application/json
parameters:
- in: path
name: partyId
description: Id of the associated party.
required: true
type: string
- in: query
name: resourceIds
description: Resource Ids of the resource.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: resourceTypes
description: "Resource Types of the resource.\r\ni.e. Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis."
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/AttachmentListResponse'
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:
Attachments_ListByPartyId:
$ref: ./examples/Attachments_ListByPartyId.json
summary: Microsoft Azure Get Parties Partyid Attachments
/parties/{partyId}/attachments/{attachmentId}:
get:
tags:
- Attachments
description: Gets a specified attachment resource under a particular party.
operationId: microsoftAzureAttachmentsGet
produces:
- application/json
parameters:
- in: path
name: partyId
description: Id of the associated party.
required: true
type: string
- in: path
name: attachmentId
description: Id of the attachment.
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/Attachment'
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:
Attachments_Get:
$ref: ./examples/Attachments_Get.json
summary: Microsoft Azure Get Parties Partyid Attachments Attachmentid
patch:
tags:
- Attachments
description: Creates or updates an attachment resource under a particular party.
operationId: microsoftAzureAttachmentsCreateorupdate
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- in: path
name: partyId
description: Id of the associated party resource.
required: true
type: string
- in: path
name: attachmentId
description: Id of the attachment resource.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
- in: formData
name: file
type: file
format: binary
description: File to be uploaded.
- in: formData
name: resourceId
description: Associated Resource id for this attachment.
type: string
- in: formData
name: resourceType
description: Associated Resource type for this attachment.
type: string
- in: formData
name: originalFileName
description: Original File Name for this attachment.
type: string
- in: formData
name: id
description: Unique id.
type: string
- in: formData
name: status
description: Status of the resource.
type: string
maxLength: 100
minLength: 0
- in: formData
name: createdDateTime
description: Date when resource was created.
type: string
format: date-time
- in: formData
name: modifiedDateTime
description: Date when resource was last modified.
type: string
format: date-time
- in: formData
name: source
description: Source of the resource.
type: string
maxLength: 100
minLength: 2
- in: formData
name: name
description: Name to identify resource.
type: string
maxLength: 100
minLength: 0
- in: formData
name: description
description: Textual description of resource.
type: string
maxLength: 500
minLength: 0
- in: formData
name: createdBy
description: Created by user/tenant id.
type: string
- in: formData
name: modifiedBy
description: Modified by user/tenant id.
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Attachment'
'201':
description: Created
schema:
$ref: '#/definitions/Attachment'
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:
Attachments_CreateOrUpdate:
$ref: ./examples/Attachments_CreateOrUpdate.json
summary: Microsoft Azure Patch Parties Partyid Attachments Attachmentid
delete:
tags:
- Attachments
description: Deletes a specified attachment resource under a particular party.
operationId: microsoftAzureAttachmentsDelete
produces:
- application/json
parameters:
- in: path
name: partyId
description: Id of the party.
required: true
type: string
- in: path
name: attachmentId
description: Id of the attachment.
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:
Attachments_Delete:
$ref: ./examples/Attachments_Delete.json
summary: Microsoft Azure Delete Parties Partyid Attachments Attachmentid
/parties/{partyId}/attachments/{attachmentId}/file:
get:
tags:
- Attachments
description: >-
Downloads and returns attachment as response for the given input
filePath.
operationId: microsoftAzureAttachmentsDownload
produces:
- application/json
- application/octet-stream
parameters:
- in: path
name: partyId
description: Id of the associated party.
required: true
type: string
- in: path
name: attachmentId
description: Id of attachment to be downloaded.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
responses:
'200':
description: Success
schema:
format: binary
type: file
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:
Attachments_Download:
$ref: ./examples/Attachments_Download.json
summary: Microsoft Azure Get Parties Partyid Attachments Attachmentid File
/boundaries:
get:
tags:
- Boundaries
description: Returns a paginated list of boundary resources across all parties.
operationId: microsoftAzureBoundariesList
produces:
- application/json
parameters:
- in: query
name: parentType
description: Type of the parent it belongs to.
type: string
- in: query
name: type
description: Type it belongs to.
type: string
- in: query
name: parentIds
description: Parent Ids of the resource.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: minArea
description: Minimum area of the boundary (inclusive).
type: number
format: double
- in: query
name: maxArea
description: Maximum acreage of the boundary (inclusive).
type: number
format: double
- 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: minCr
# --- truncated at 32 KB (571 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-agfoodplatform-data-plane-service-openapi-original.yml