Microsoft Azure Data Manager for Agriculture Data Plane Service is a cloud-based platform that helps farmers and agricultural businesses collect, process, and analyze data to make informed decisions about their operations. It allows users to securely store and manage agricultural data from various sources, such as sensors, drones, and weather stations, and provides tools for visualization, reporting, and predictive analytics.
swagger: '2.0'
info:
title: Microsoft Azure Data Manager for Agriculture Data Plane Service
description: >-
APIs documentation for Microsoft Azure Data Manager for Agriculture
DataPlane Service.
version: 2023-11-01-preview
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- name: endpoint
in: path
description: >-
The host name of the namespace, e.g.
admaInstanceName.farmbeats.azure.net
required: true
type: string
format: uri
x-ms-skip-url-encoding: true
paths:
/application-data:search:
post:
tags:
- ApplicationData
description: Search for ApplicationData across all parties by intersecting geometry.
operationId: microsoftAzureApplicationdataSearch
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: skipToken
description: Skip token for getting next set of results.
type: string
- in: query
name: maxPageSize
description: >-
Maximum number of items needed (inclusive). Minimum = 10, Maximum =
1000, Default Value = 50.
type: integer
format: int32
default: 50
maximum: 1000
minimum: 10
- in: query
name: api-version
description: The requested API version
required: true
type: string
- in: body
name: searchFarmOperationQuery
description: Query filters.
required: true
schema:
$ref: '#/definitions/SearchApplicationDataQuery'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ApplicationDataMetaDataListResponse'
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_Search:
$ref: ./examples/ApplicationData_Search.json
summary: Microsoft Azure Post Application Data:search
/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/{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, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis, Prescription."
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
- in: formData
name: eTag
description: The ETag value to implement optimistic concurrency.
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
/chemical-products:
get:
tags:
- ChemicalProducts
description: Returns a paginated list of chemical product resources.
operationId: microsoftAzureChemicalproductsList
produces:
- application/json
parameters:
- in: query
name: cropIds
description: CropIds of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: brands
description: Brands of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: products
description: Products of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: types
description: Types of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: states
description: States of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: activeIngredients
description: ActiveIngredients of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: specificGravity
description: SpecificGravity of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: formulation
description: Formulation of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: registrationNumber
description: RegistrationNumber of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: minReEntryInterval
description: Min ReEntryInterval of chemical product.
type: integer
format: int32
- in: query
name: maxReEntryInterval
description: Max ReEntryInterval of chemical product.
type: integer
format: int32
- in: query
name: locations
description: Locations of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: companyNames
description: Company names of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: datasetIds
description: Reference dataset id of chemical product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: referenceRecordIds
description: Reference record id of chemical product.
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/ChemicalProductListResponse'
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:
ChemicalProducts_List:
$ref: ./examples/ChemicalProducts_List.json
summary: Microsoft Azure Get Chemical Products
/chemical-products/{chemicalProductId}:
get:
tags:
- ChemicalProducts
description: Gets a specified chemicalProduct resource.
operationId: microsoftAzureChemicalproductsGet
produces:
- application/json
parameters:
- in: path
name: chemicalProductId
description: Id of the chemicalProduct.
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/ChemicalProduct'
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:
ChemicalProducts_Get:
$ref: ./examples/ChemicalProducts_Get.json
summary: Microsoft Azure Get Chemical Products Chemicalproductid
patch:
tags:
- ChemicalProducts
description: Creates or updates a chemicalProduct resource.
operationId: microsoftAzureChemicalproductsCreateorupdate
consumes:
- application/merge-patch+json
produces:
- application/json
parameters:
- in: path
name: chemicalProductId
description: Id of the chemicalProduct resource.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
- in: body
name: chemicalProduct
description: ChemicalProduct resource payload to create or update.
required: true
schema:
$ref: '#/definitions/ChemicalProduct'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ChemicalProduct'
'201':
description: Created
schema:
$ref: '#/definitions/ChemicalProduct'
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:
ChemicalProducts_CreateOrUpdate:
$ref: ./examples/ChemicalProducts_CreateOrUpdate.json
summary: Microsoft Azure Patch Chemical Products Chemicalproductid
delete:
tags:
- ChemicalProducts
description: Deletes dataset for given chemicalProduct id.
operationId: microsoftAzureChemicalproductsDelete
produces:
- application/json
parameters:
- in: path
name: chemicalProductId
description: Id of chemicalProduct to be deleted.
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:
ChemicalProducts_Delete:
$ref: ./examples/ChemicalProducts_Delete.json
summary: Microsoft Azure Delete Chemical Products Chemicalproductid
/crop-products:
get:
tags:
- CropProducts
description: Returns a paginated list of crop product resources.
operationId: microsoftAzureCropproductsList
produces:
- application/json
parameters:
- in: query
name: cropIds
description: CropIds of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: brands
description: Brands of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: products
description: Products of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: treatments
description: Treatments of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: traits
description: Traits of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: traitStacks
description: TraitStacks of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: locations
description: Locations of crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: companyNames
description: Company names of the crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: referenceDatasetIds
description: Reference dataset id of the crop product.
type: array
items:
type: string
collectionFormat: multi
- in: query
name: referenceRecordIds
description: Reference record id of the crop product.
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
# --- truncated at 32 KB (542 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-data-manager-for-agriculture-data-plane-service-openapi-original.yml