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 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/CropProductListResponse' 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: CropProducts_List: $ref: ./examples/CropProducts_List.json summary: Microsoft Azure Get Crop Products /crop-products/{cropProductId}: get: tags: - CropProducts description: Gets a specified crop Product resource. operationId: microsoftAzureCropproductsGet produces: - application/json parameters: - in: path name: cropProductId description: Id of the crop Product. 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/CropProduct' 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: CropProducts_Get: $ref: ./examples/CropProducts_Get.json summary: Microsoft Azure Get Crop Products Cropproductid patch: tags: - CropProducts description: Creates or updates a crop Product resource. operationId: microsoftAzureCropproductsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: cropProductId description: Id of the crop Product resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: cropProduct description: Crop Product resource payload to create or update. required: true schema: $ref: '#/definitions/CropProduct' responses: '200': description: Success schema: $ref: '#/definitions/CropProduct' '201': description: Created schema: $ref: '#/definitions/CropProduct' 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: CropProducts_CreateOrUpdate: $ref: ./examples/CropProducts_CreateOrUpdate.json summary: Microsoft Azure Patch Crop Products Cropproductid delete: tags: - CropProducts description: Deletes a specified crop Product resource. operationId: microsoftAzureCropproductsDelete produces: - application/json parameters: - in: path name: cropProductId description: Id of the crop Product. 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: CropProducts_Delete: $ref: ./examples/CropProducts_Delete.json summary: Microsoft Azure Delete Crop Products Cropproductid /crops: get: tags: - Crops description: Returns a paginated list of crop resources. operationId: microsoftAzureCropsList produces: - application/json parameters: - in: query name: phenotypes description: Crop phenotypes of the crop. type: array items: type: string collectionFormat: multi - in: query name: breedingMethods description: Breeding method of the crop. type: array items: type: string collectionFormat: multi - in: query name: locations description: Location of the crop. type: array items: type: string collectionFormat: multi - in: query name: referenceDatasetIds description: Reference dataset id of the crop. type: array items: type: string collectionFormat: multi - in: query name: referenceRecordIds description: Reference record id of the crop. 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/CropListResponse' 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: Crops_List: $ref: ./examples/Crops_List.json summary: Microsoft Azure Get Crops /crops/{cropId}: get: tags: - Crops description: Gets a specified crop resource. operationId: microsoftAzureCropsGet produces: - application/json parameters: - in: path name: cropId description: Id of the crop. 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/Crop' 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: Crops_Get: $ref: ./examples/Crops_Get.json summary: Microsoft Azure Get Crops Cropid patch: tags: - Crops description: Creates or updates a crop resource. operationId: microsoftAzureCropsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: cropId description: Id of the crop resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: crop description: Crop resource payload to create or update. required: true schema: $ref: '#/definitions/Crop' responses: '200': description: Success schema: $ref: '#/definitions/Crop' '201': description: Created schema: $ref: '#/definitions/Crop' 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: Crops_CreateOrUpdate: $ref: ./examples/Crops_CreateOrUpdate.json summary: Microsoft Azure Patch Crops Cropid delete: tags: - Crops description: Deletes Crop for given crop id. operationId: microsoftAzureCropsDelete produces: - application/json parameters: - in: path name: cropId description: Id of crop 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: Crops_Delete: $ref: ./examples/Crops_Delete.json summary: Microsoft Azure Delete Crops Cropid /datasets/{datasetId}/records: get: tags: - DatasetRecords description: Returns a paginated list of records. operationId: microsoftAzureDatasetrecordsList produces: - application/json parameters: - in: path name: datasetId description: dataset id. required: true type: string - in: query name: recordFilters description: "Filters on key-value pairs within the Record object.\r\nOnly applicable for first level keys with value of type string, datetime or number.\r\neg. \"{testKey} eq {testValue}\"." 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/DatasetRecordListResponse' 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: DatasetRecords_List: $ref: ./examples/DatasetRecords_List.json summary: Microsoft Azure Get Datasets Datasetid Records /datasets/{datasetId}/records/{recordId}: get: tags: - DatasetRecords description: Gets a specified record. operationId: microsoftAzureDatasetrecordsGet produces: - application/json parameters: - in: path name: datasetId description: Id of the dataset. required: true type: string - in: path name: recordId description: Id of the record. 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/DatasetRecord' 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: DatasetRecords_Get: $ref: ./examples/DatasetRecords_Get.json summary: Microsoft Azure Get Datasets Datasetid Records Recordid patch: tags: - DatasetRecords description: Creates or updates a dataset record. operationId: microsoftAzureDatasetrecordsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: datasetId description: Id of the dataset resource. required: true type: string - in: path name: recordId description: Id of the dataset record resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: datasetRecord description: Dataset record resource payload to create or update. required: true schema: $ref: '#/definitions/DatasetRecord' responses: '200': description: Success schema: $ref: '#/definitions/DatasetRecord' '201': description: Created schema: $ref: '#/definitions/DatasetRecord' 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: DatasetRecords_CreateOrUpdate: $ref: ./examples/DatasetRecords_CreateOrUpdate.json summary: Microsoft Azure Patch Datasets Datasetid Records Recordid delete: tags: - DatasetRecords description: Deletes dataset record for given record id. operationId: microsoftAzureDatasetrecordsDelete produces: - application/json parameters: - in: path name: datasetId description: Id of dataset the record belongs to. required: true type: string - in: path name: recordId description: Id of the record 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: DatasetRecords_Delete: $ref: ./examples/DatasetRecords_Delete.json summary: Microsoft Azure Delete Datasets Datasetid Records Recordid /datasets: get: tags: - Datasets description: Returns a paginated list of datasets. operationId: microsoftAzureDatasetsList produces: - application/json parameters: - in: query name: type description: Dataset type. type: string - 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/DatasetListResponse' 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: Datasets_List: $ref: ./examples/Datasets_List.json summary: Microsoft Azure Get Datasets /datasets/{datasetId}: get: tags: - Datasets description: Gets a specified dataset. operationId: microsoftAzureDatasetsGet produces: - application/json parameters: - in: path name: datasetId description: Id of the dataset. 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/Dataset' 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: Datasets_Get: $ref: ./examples/Datasets_Get.json summary: Microsoft Azure Get Datasets Datasetid patch: tags: - Datasets description: Creates or updates a dataset. operationId: microsoftAzureDatasetsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: datasetId description: Id of the dataset resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: dataset description: Dataset resource payload to create or update. required: true schema: $ref: '#/definitions/Dataset' responses: '200': description: Success schema: $ref: '#/definitions/Dataset' '201': description: Created schema: $ref: '#/definitions/Dataset' 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: Datasets_CreateOrUpdate: $ref: ./examples/Datasets_CreateOrUpdate.json summary: Microsoft Azure Patch Datasets Datasetid delete: tags: - Datasets description: Deletes dataset for given dataset id. operationId: microsoftAzureDatasetsDelete produces: - application/json parameters: - in: path name: datasetId description: Id of dataset 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: Datasets_Delete: $ref: ./examples/Datasets_Delete.json summary: Microsoft Azure Delete Datasets Datasetid /datasets/{datasetId}/access: get: tags: - Datasets description: Dataset access list. operationId: microsoftAzureDatasetsListauthorizedaccess produces: - application/json parameters: - in: path name: datasetId description: Id of dataset to be accessed. required: true type: string - in: query name: subscriptionIds description: Subscription Ids. type: array items: type: string collectionFormat: multi - in: query name: resourceIds description: Resource Ids. type: array items: type: string collectionFormat: multi - 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/DatasetAccessListResponse' 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: Datasets_ListAuthorizedAccess: $ref: ./examples/Datasets_ListAuthorizedAccess.json summary: Microsoft Azure Get Datasets Datasetid Access /datasets/{datasetId}/access:grant: post: tags: - Datasets description: Dataset access grant. operationId: microsoftAzureDatasetsAuthorizeaccess consumes: - application/json produces: - application/json parameters: - in: path name: datasetId description: Id of dataset to be accessed. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: datasetAccess description: Dataset access details. required: true schema: $ref: '#/definitions/DatasetAccess' responses: '200': description: Success schema: $ref: '#/definitions/DatasetAccess' 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: Datasets_AuthorizeAccess: $ref: ./examples/Datasets_AuthorizeAccess.json summary: Microsoft Azure Post Datasets Datasetid Access:grant /datasets/{datasetId}/access:remove: post: tags: - Datasets description: Dataset access remove. operationId: microsoftAzureDatasetsRemoveaccess consumes: - application/json produces: - application/json parameters: - in: path name: datasetId description: Id of dataset to be accessed. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: datasetAccess description: Dataset access details. required: true schema: $ref: '#/definitions/DatasetAccess' 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: Datasets_RemoveAccess: $ref: ./examples/Datasets_RemoveAccess.json summary: Microsoft Azure Post Datasets Datasetid Access:remove /sensor-partners/{sensorPartnerId}/device-data-models: get: tags: - DeviceDataModels description: Returns a paginated list of device data model resources. operationId: microsoftAzureDevicedatamodelsList produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the associated sensor partner. required: true type: string - 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/DeviceDataModelListResponse' 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: DeviceDataModels_List: $ref: ./examples/DeviceDataModels_List.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Device Data Models /sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}: patch: tags: - DeviceDataModels description: Create a device data model entity. operationId: microsoftAzureDevicedatamodelsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: deviceDataModelId description: Id of the device data model. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: deviceDataModelObject description: Device data model object details. required: true schema: $ref: '#/definitions/DeviceDataModel' responses: '200': description: Success schema: $ref: '#/definitions/DeviceDataModel' '201': description: Created schema: $ref: '#/definitions/DeviceDataModel' 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: DeviceDataModels_CreateOrUpdate: $ref: ./examples/DeviceDataModels_CreateOrUpdate.json summary: >- Microsoft Azure Patch Sensor Partners Sensorpartnerid Device Data Models Devicedatamodelid get: tags: - DeviceDataModels description: Gets a device data model entity. operationId: microsoftAzureDevicedatamodelsGet produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: deviceDataModelId description: Id of the device data model 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/DeviceDataModel' 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: DeviceDataModels_Get: $ref: ./examples/DeviceDataModels_Get.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Device Data Models Devicedatamodelid delete: tags: - DeviceDataModels description: Deletes a device data model entity. operationId: microsoftAzureDevicedatamodelsDelete produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: deviceDataModelId description: Id of the device data model 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: DeviceDataModels_Delete: $ref: ./examples/DeviceDataModels_Delete.json summary: >- Microsoft Azure Delete Sensor Partners Sensorpartnerid Device Data Models Devicedatamodelid /sensor-partners/{sensorPartnerId}/devices: get: tags: - Devices description: Returns a paginated list of device resources. operationId: microsoftAzureDevicesList produces: - application/json parameters: - in: query name: parentDeviceIds description: Id's of the parent devices. type: array items: type: string collectionFormat: multi - in: query name: deviceDataModelIds description: Id's of the device data models. type: array items: type: string collectionFormat: multi - in: path name: sensorPartnerId description: Id of the associated sensor partner. required: true type: string - 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/DeviceListResponse' 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: Devices_List: $ref: ./examples/Devices_List.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Devices /sensor-partners/{sensorPartnerId}/devices/{deviceId}: patch: tags: - Devices description: Create a device entity. operationId: microsoftAzureDevicesCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: deviceId description: Id of the device resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: deviceDetails description: Device object details. required: true schema: $ref: '#/definitions/Device' responses: '200': description: Success schema: $ref: '#/definitions/Device' '201': description: Created schema: $ref: '#/definitions/Device' 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: Devices_CreateOrUpdate: $ref: ./examples/Devices_CreateOrUpdate.json summary: Microsoft Azure Patch Sensor Partners Sensorpartnerid Devices Deviceid get: tags: - Devices description: Gets a device entity. operationId: microsoftAzureDevicesGet produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: deviceId description: Id of the device 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/Device' 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: Devices_Get: $ref: ./examples/Devices_Get.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Devices Deviceid delete: tags: - Devices description: Deletes a device entity. operationId: microsoftAzureDevicesDelete produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: deviceId description: Id of the device 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: Devices_Delete: $ref: ./examples/Devices_Delete.json summary: Microsoft Azure Delete Sensor Partners Sensorpartnerid Devices Deviceid /farm-equipments: get: tags: - FarmEquipments description: Returns a paginated list of farm equipment resources. operationId: microsoftAzureFarmequipmentsList produces: - application/json parameters: - in: query name: cropIds description: CropIds of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: brands description: Brands of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: equipmentSeries description: Equipment Series of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: models description: Model of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: serial description: Serial of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: types description: Type of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: ownership description: Ownership of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: locations description: Locations of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: companyNames description: Company names of farm equipment. type: array items: type: string collectionFormat: multi - in: query name: referenceDatasetIds description: Reference dataset id of the farm equipment. type: array items: type: string collectionFormat: multi - in: query name: referenceRecordIds description: Reference record id of the farm equipment. 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/FarmEquipmentListResponse' 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: FarmEquipments_List: $ref: ./examples/FarmEquipments_List.json summary: Microsoft Azure Get Farm Equipments /farm-equipments/{farmEquipmentId}: get: tags: - FarmEquipments description: Gets a specified farm equipment resource. operationId: microsoftAzureFarmequipmentsGet produces: - application/json parameters: - in: path name: farmEquipmentId description: Id of the farm equipment. 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/FarmEquipment' 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: FarmEquipments_Get: $ref: ./examples/FarmEquipments_Get.json summary: Microsoft Azure Get Farm Equipments Farmequipmentid patch: tags: - FarmEquipments description: Creates or updates a farm equipment resource. operationId: microsoftAzureFarmequipmentsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: farmEquipmentId description: Id of the farm equipment resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: farmEquipment description: FarmEquipment resource payload to create or update. required: true schema: $ref: '#/definitions/FarmEquipment' responses: '200': description: Success schema: $ref: '#/definitions/FarmEquipment' '201': description: Created schema: $ref: '#/definitions/FarmEquipment' 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: FarmEquipments_CreateOrUpdate: $ref: ./examples/FarmEquipments_CreateOrUpdate.json summary: Microsoft Azure Patch Farm Equipments Farmequipmentid delete: tags: - FarmEquipments description: Deletes dataset for given farm equipment id. operationId: microsoftAzureFarmequipmentsDelete produces: - application/json parameters: - in: path name: farmEquipmentId description: Id of farm equipment 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: FarmEquipments_Delete: $ref: ./examples/FarmEquipments_Delete.json summary: Microsoft Azure Delete Farm Equipments Farmequipmentid /farm-operations/ingest-data/{jobId}: put: tags: - FarmOperations description: Create a farm operation data ingestion job. operationId: microsoftAzureFarmoperationsCreatedataingestionjob consumes: - application/json produces: - application/json parameters: - in: path name: jobId description: Job Id supplied by user. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: job description: Job parameters supplied by user. required: true schema: $ref: '#/definitions/FarmOperationDataIngestionJob' responses: '202': description: Accepted schema: $ref: '#/definitions/FarmOperationDataIngestionJob' 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: FarmOperations_CreateDataIngestionJob: $ref: ./examples/FarmOperations_CreateDataIngestionJob.json summary: Microsoft Azure Put Farm Operations Ingest Data Jobid get: tags: - FarmOperations description: Get a farm operation data ingestion job. operationId: microsoftAzureFarmoperationsGetdataingestionjobdetails 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/FarmOperationDataIngestionJob' 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: FarmOperations_GetDataIngestionJobDetails: $ref: ./examples/FarmOperations_GetDataIngestionJobDetails.json summary: Microsoft Azure Get Farm Operations Ingest Data Jobid /farms: get: tags: - Farms description: Returns a paginated list of farm resources across all parties. operationId: microsoftAzureFarmsList produces: - application/json parameters: - 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/FarmListResponse' 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: Farms_List: $ref: ./examples/Farms_List.json summary: Microsoft Azure Get Farms /farms/cascade-delete/{jobId}: put: tags: - Farms description: Create a cascade delete job for specified farm. operationId: microsoftAzureFarmsCreatecascadedeletejob 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: farmId description: ID of the farm to be deleted. 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: Farms_CreateCascadeDeleteJob: $ref: ./examples/Farms_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Farms Cascade Delete Jobid get: tags: - Farms description: Get a cascade delete job for specified farm. operationId: microsoftAzureFarmsGetcascadedeletejobdetails 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: Farms_GetCascadeDeleteJobDetails: $ref: ./examples/Farms_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Farms Cascade Delete Jobid /parties/{partyId}/farms: get: tags: - Farms description: Returns a paginated list of farm resources under a particular party. operationId: microsoftAzureFarmsListbypartyid produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - 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/FarmListResponse' 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: Farms_ListByPartyId: $ref: ./examples/Farms_ListByPartyId.json summary: Microsoft Azure Get Parties Partyid Farms /parties/{partyId}/farms/{farmId}: get: tags: - Farms description: Gets a specified farm resource under a particular party. operationId: microsoftAzureFarmsGet produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: farmId description: ID of the farm 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/Farm' 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: Farms_Get: $ref: ./examples/Farms_Get.json summary: Microsoft Azure Get Parties Partyid Farms Farmid patch: tags: - Farms description: Creates or updates a farm resource under a particular party. operationId: microsoftAzureFarmsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the associated party resource. required: true type: string - in: path name: farmId description: Id of the farm resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: farm description: Farm resource payload to create or update. required: true schema: $ref: '#/definitions/Farm' responses: '200': description: Success schema: $ref: '#/definitions/Farm' '201': description: Created schema: $ref: '#/definitions/Farm' 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: Farms_CreateOrUpdate: $ref: ./examples/Farms_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Farms Farmid delete: tags: - Farms description: Deletes a specified farm resource under a particular party. operationId: microsoftAzureFarmsDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: farmId description: Id of the farm. 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: Farms_Delete: $ref: ./examples/Farms_Delete.json summary: Microsoft Azure Delete Parties Partyid Farms Farmid /fields:search: post: tags: - Fields description: Search for Fields across all parties by intersecting geometry. operationId: microsoftAzureFieldsSearch 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: searchFieldQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchFieldQuery' responses: '200': description: Success schema: $ref: '#/definitions/FieldMetaDataListResponse' 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: Fields_Search: $ref: ./examples/Fields_Search.json summary: Microsoft Azure Post Fields:search /fields/cascade-delete/{jobId}: get: tags: - Fields description: Get a cascade delete job for specified field. operationId: microsoftAzureFieldsGetcascadedeletejobdetails 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: Fields_GetCascadeDeleteJobDetails: $ref: ./examples/Fields_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Fields Cascade Delete Jobid put: tags: - Fields description: Create a cascade delete job for specified field. operationId: microsoftAzureFieldsCreatecascadedeletejob 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: fieldId description: ID of the field to be deleted. 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: Fields_CreateCascadeDeleteJob: $ref: ./examples/Fields_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Fields Cascade Delete Jobid /parties/{partyId}/fields/{fieldId}: get: tags: - Fields description: Gets a specified field resource under a particular party. operationId: microsoftAzureFieldsGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: fieldId description: Id of the field. 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/Field' 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: Fields_Get: $ref: ./examples/Fields_Get.json summary: Microsoft Azure Get Parties Partyid Fields Fieldid patch: tags: - Fields description: Creates or Updates a field resource under a particular party. operationId: microsoftAzureFieldsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the associated party resource. required: true type: string - in: path name: fieldId description: Id of the field resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: field description: Field resource payload to create or update. required: true schema: $ref: '#/definitions/Field' responses: '200': description: Success schema: $ref: '#/definitions/Field' '201': description: Created schema: $ref: '#/definitions/Field' 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: Fields_CreateOrUpdate: $ref: ./examples/Fields_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Fields Fieldid delete: tags: - Fields description: Deletes a specified field resource under a particular party. operationId: microsoftAzureFieldsDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: fieldId description: Id of the field. 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: Fields_Delete: $ref: ./examples/Fields_Delete.json summary: Microsoft Azure Delete Parties Partyid Fields Fieldid /harvest-data:search: post: tags: - HarvestData description: Search for HarvestData across all parties by intersecting geometry. operationId: microsoftAzureHarvestdataSearch 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/SearchHarvestDataQuery' responses: '200': description: Success schema: $ref: '#/definitions/HarvestDataMetaDataListResponse' 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: HarvestData_Search: $ref: ./examples/HarvestData_Search.json summary: Microsoft Azure Post Harvest Data:search /harvest-data/cascade-delete/{jobId}: put: tags: - HarvestData description: Create cascade delete job for harvest data resource. operationId: microsoftAzureHarvestdataCreatecascadedeletejob 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: harvestDataId description: Id of the harvest 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: HarvestData_CreateCascadeDeleteJob: $ref: ./examples/HarvestData_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Harvest Data Cascade Delete Jobid get: tags: - HarvestData description: Get cascade delete job for harvest data resource. operationId: microsoftAzureHarvestdataGetcascadedeletejobdetails 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: HarvestData_GetCascadeDeleteJobDetails: $ref: ./examples/HarvestData_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Harvest Data Cascade Delete Jobid /parties/{partyId}/harvest-data/{harvestDataId}: get: tags: - HarvestData description: Get a specified harvest data resource under a particular party. operationId: microsoftAzureHarvestdataGet produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: harvestDataId description: ID of the harvest 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/HarvestData' 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: HarvestData_Get: $ref: ./examples/HarvestData_Get.json summary: Microsoft Azure Get Parties Partyid Harvest Data Harvestdataid patch: tags: - HarvestData description: Creates or updates harvest data resource under a particular party. operationId: microsoftAzureHarvestdataCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: ID of the party. required: true type: string - in: path name: harvestDataId description: ID of the harvest data resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: harvestData description: Harvest data resource payload to create or update. required: true schema: $ref: '#/definitions/HarvestData' responses: '200': description: Success schema: $ref: '#/definitions/HarvestData' '201': description: Created schema: $ref: '#/definitions/HarvestData' 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: HarvestData_CreateOrUpdate: $ref: ./examples/HarvestData_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Harvest Data Harvestdataid delete: tags: - HarvestData description: Deletes a specified harvest data resource under a particular party. operationId: microsoftAzureHarvestdataDelete produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: harvestDataId description: ID of the harvest 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: HarvestData_Delete: $ref: ./examples/HarvestData_Delete.json summary: Microsoft Azure Delete Parties Partyid Harvest Data Harvestdataid /image-processing/rasterize/{jobId}: put: tags: - ImageProcessing description: Create a ImageProcessing Rasterize job. operationId: microsoftAzureImageprocessingCreaterasterizejob consumes: - application/json produces: - application/json parameters: - in: path name: jobId description: JobId provided by user. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: job description: Job parameters supplied by user. required: true schema: $ref: '#/definitions/ImageProcessingRasterizeJob' responses: '202': description: Accepted schema: $ref: '#/definitions/ImageProcessingRasterizeJob' 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: ImageProcessing_CreateRasterizeJob: $ref: ./examples/ImageProcessing_CreateRasterizeJob.json summary: Microsoft Azure Put Image Processing Rasterize Jobid get: tags: - ImageProcessing description: Get ImageProcessing Rasterize job's details. operationId: microsoftAzureImageprocessingGetrasterizejob 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/ImageProcessingRasterizeJob' 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: ImageProcessing_GetRasterizeJob: $ref: ./examples/ImageProcessing_GetRasterizeJob.json summary: Microsoft Azure Get Image Processing Rasterize Jobid /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments: get: tags: - InsightAttachments description: Returns a paginated list of insight resources. operationId: microsoftAzureInsightattachmentsListbypartyidmodelidandresource 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: insightIds description: List of insight IDs. 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/InsightAttachmentListResponse' 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: InsightAttachments_ListByPartyIdModelIdAndResource: $ref: ./examples/InsightAttachments_ListByPartyIdModelIdAndResource.json summary: >- Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insight Attachments ? /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId} : patch: tags: - InsightAttachments description: Creates or updates insight entity. operationId: microsoftAzureInsightattachmentsCreateorupdate consumes: - multipart/form-data 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: path name: insightAttachmentId 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: formData name: file type: file format: binary description: File to be uploaded. - in: formData name: insightId description: InsightID for this InsightAttachment. required: true 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/InsightAttachment' '201': description: Created schema: $ref: '#/definitions/InsightAttachment' 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: InsightAttachments_CreateOrUpdate: $ref: ./examples/InsightAttachments_CreateOrUpdate.json summary: >- Microsoft Azure Patch Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insight Attachments Insightattachmentid get: tags: - InsightAttachments description: Gets a specified insight resource under a particular party. operationId: microsoftAzureInsightattachmentsGet 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: path name: insightAttachmentId description: Id of the insight attachment 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/InsightAttachment' 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: InsightAttachments_Get: $ref: ./examples/InsightAttachments_Get.json summary: >- Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insight Attachments Insightattachmentid delete: tags: - InsightAttachments description: Deletes a specified insight resource. operationId: microsoftAzureInsightattachmentsDelete 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: insightAttachmentId description: Id of the insight attachment 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: InsightAttachments_Delete: $ref: ./examples/InsightAttachments_Delete.json summary: >- Microsoft Azure Delete Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insight Attachments Insightattachmentid ? /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 produces: - application/json - application/octet-stream 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: insightAttachmentId description: Id of the insight attachment resource. 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: InsightAttachments_Download: $ref: ./examples/InsightAttachments_Download.json summary: >- Microsoft Azure Get Parties Partyid Models Modelid Resource Types Resourcetype Resources Resourceid Insight Attachments Insightattachmentid File /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. 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. 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 /management-zones: get: tags: - ManagementZones description: >- Returns a paginated list of management zone resources across all parties. operationId: microsoftAzureManagementzonesList produces: - application/json parameters: - in: query name: types description: Types of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: cropIds description: CropIds of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: seasonIds description: SeasonIds of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: fieldIds description: FieldIds of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: sources description: Sources of the ManagementZone. 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/ManagementZoneListResponse' 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: ManagementZones_List: $ref: ./examples/ManagementZones_List.json summary: Microsoft Azure Get Management Zones /management-zones/cascade-delete/{jobId}: get: tags: - ManagementZones description: Get a cascade delete job for specified job id. operationId: microsoftAzureManagementzonesGetcascadedeletejobdetails 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: ManagementZones_GetCascadeDeleteJobDetails: $ref: ./examples/ManagementZones_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Management Zones Cascade Delete Jobid put: tags: - ManagementZones description: Create a cascade delete job for specified management zone. operationId: microsoftAzureManagementzonesCreatecascadedeletejob 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: managementZoneId description: ID of the management zone to be deleted. 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: ManagementZones_CreateCascadeDeleteJob: $ref: ./examples/ManagementZones_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Management Zones Cascade Delete Jobid /parties/{partyId}/management-zones: get: tags: - ManagementZones description: >- Returns a paginated list of management zone resources under a particular party. operationId: microsoftAzureManagementzonesListbypartyid produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: query name: types description: Types of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: cropIds description: CropIds of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: seasonIds description: SeasonIds of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: fieldIds description: FieldIds of the ManagementZone. type: array items: type: string collectionFormat: multi - in: query name: sources description: Sources of the ManagementZone. 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/ManagementZoneListResponse' 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: ManagementZones_ListByPartyId: $ref: ./examples/ManagementZones_ListByPartyId.json summary: Microsoft Azure Get Parties Partyid Management Zones /parties/{partyId}/management-zones/{managementZoneId}: get: tags: - ManagementZones description: Gets a specified management zone resource under a particular party. operationId: microsoftAzureManagementzonesGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: managementZoneId description: Id of the management zone. 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/ManagementZone' 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: ManagementZones_Get: $ref: ./examples/ManagementZones_Get.json summary: Microsoft Azure Get Parties Partyid Management Zones Managementzoneid patch: tags: - ManagementZones description: Creates or updates a management zone resource. operationId: microsoftAzureManagementzonesCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the party resource. required: true type: string - in: path name: managementZoneId description: Id of the management zone resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: managementZone description: ManagementZone resource payload to create or update. required: true schema: $ref: '#/definitions/ManagementZone' responses: '200': description: Success schema: $ref: '#/definitions/ManagementZone' '201': description: Created schema: $ref: '#/definitions/ManagementZone' 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: ManagementZones_CreateOrUpdate: $ref: ./examples/ManagementZones_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Management Zones Managementzoneid delete: tags: - ManagementZones description: Deletes a specified management zone resource under a particular party. operationId: microsoftAzureManagementzonesDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: managementZoneId description: Id of the management zone. 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: ManagementZones_Delete: $ref: ./examples/ManagementZones_Delete.json summary: Microsoft Azure Delete Parties Partyid Management Zones Managementzoneid /nutrient-analyses: get: tags: - NutrientAnalyses description: >- Returns a paginated list of nutrient analysis resources across all parties. operationId: microsoftAzureNutrientanalysesList produces: - application/json parameters: - in: query name: parentType description: "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis." type: string - in: query name: parentIds description: Parent ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: classifications description: Classifications for nutrient analyses. 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/NutrientAnalysisListResponse' 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: NutrientAnalyses_List: $ref: ./examples/NutrientAnalyses_List.json summary: Microsoft Azure Get Nutrient Analyses /parties/{partyId}/nutrient-analyses: get: tags: - NutrientAnalyses description: >- Returns a paginated list of nutrient analysis resources under a particular party. operationId: microsoftAzureNutrientanalysesListbypartyid produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: query name: parentType description: "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis." type: string - in: query name: parentIds description: Parent ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: classifications description: Classifications for nutrient analyses. 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/NutrientAnalysisListResponse' 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: NutrientAnalyses_ListByPartyId: $ref: ./examples/NutrientAnalyses_ListByPartyId.json summary: Microsoft Azure Get Parties Partyid Nutrient Analyses /parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}: get: tags: - NutrientAnalyses description: Gets a specified nutrient analysis resource under a particular party. operationId: microsoftAzureNutrientanalysesGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: nutrientAnalysisId description: Id of the nutrient analysis. 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/NutrientAnalysis' 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: NutrientAnalyses_Get: $ref: ./examples/NutrientAnalyses_Get.json summary: Microsoft Azure Get Parties Partyid Nutrient Analyses Nutrientanalysisid patch: tags: - NutrientAnalyses description: Creates or updates a nutrient analysis resource. operationId: microsoftAzureNutrientanalysesCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the party resource. required: true type: string - in: path name: nutrientAnalysisId description: Id of the nutrient analysis resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: nutrientAnalysis description: NutrientAnalysis resource payload to create or update. required: true schema: $ref: '#/definitions/NutrientAnalysis' responses: '200': description: Success schema: $ref: '#/definitions/NutrientAnalysis' '201': description: Created schema: $ref: '#/definitions/NutrientAnalysis' 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: NutrientAnalyses_CreateOrUpdate: $ref: ./examples/NutrientAnalyses_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Nutrient Analyses Nutrientanalysisid delete: tags: - NutrientAnalyses description: Deletes a specified nutrient analysis resource under a particular party. operationId: microsoftAzureNutrientanalysesDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: nutrientAnalysisId description: Id of the nutrient analysis. 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: NutrientAnalyses_Delete: $ref: ./examples/NutrientAnalyses_Delete.json summary: Microsoft Azure Delete Parties Partyid Nutrient Analyses Nutrientanalysisid /oauth/providers: get: tags: - OAuthProviders description: Returns a paginated list of oauthProvider resources. operationId: microsoftAzureOauthprovidersList produces: - application/json parameters: - 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/OAuthProviderListResponse' 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: OAuthProviders_List: $ref: ./examples/OAuthProviders_List.json summary: Microsoft Azure Get Oauth Providers /oauth/providers/{oauthProviderId}: get: tags: - OAuthProviders description: Get a specified oauthProvider resource. operationId: microsoftAzureOauthprovidersGet produces: - application/json parameters: - in: path name: oauthProviderId description: ID of the oauthProvider 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/OAuthProvider' 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: OAuthProviders_Get: $ref: ./examples/OAuthProviders_Get.json summary: Microsoft Azure Get Oauth Providers Oauthproviderid patch: tags: - OAuthProviders description: Creates or updates an oauthProvider resource. operationId: microsoftAzureOauthprovidersCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: oauthProviderId description: ID of oauthProvider resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: oauthProvider description: OauthProvider resource payload to create or update. required: true schema: $ref: '#/definitions/OAuthProvider' responses: '200': description: Success schema: $ref: '#/definitions/OAuthProvider' '201': description: Created schema: $ref: '#/definitions/OAuthProvider' 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: OAuthProviders_CreateOrUpdate: $ref: ./examples/OAuthProviders_CreateOrUpdate.json summary: Microsoft Azure Patch Oauth Providers Oauthproviderid delete: tags: - OAuthProviders description: Deletes an specified oauthProvider resource. operationId: microsoftAzureOauthprovidersDelete produces: - application/json parameters: - in: path name: oauthProviderId description: ID of oauthProvider. 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: OAuthProviders_Delete: $ref: ./examples/OAuthProviders_Delete.json summary: Microsoft Azure Delete Oauth Providers Oauthproviderid /oauth/providers/cascade-delete/{jobId}: get: tags: - OAuthProviders description: Get cascade delete job for oauthProvider resource. operationId: microsoftAzureOauthprovidersGetcascadedeletejobdetails 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/OAuthProviderCascadeDeleteJob' 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: OAuthProviders_GetCascadeDeleteJobDetails: $ref: ./examples/OAuthProviders_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Oauth Providers Cascade Delete Jobid put: tags: - OAuthProviders description: Create cascade delete job for oauthProvider resource. operationId: microsoftAzureOauthprovidersCreatecascadedeletejob produces: - application/json parameters: - in: path name: jobId description: Job Id supplied by end user. required: true type: string - in: query name: oauthProviderId 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/OAuthProviderCascadeDeleteJob' 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: OAuthProviders_CreateCascadeDeleteJob: $ref: ./examples/OAuthProviders_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Oauth Providers Cascade Delete Jobid /oauth/tokens: get: tags: - OAuthTokens description: Returns a list of OAuthToken documents. operationId: microsoftAzureOauthtokensList produces: - application/json parameters: - in: query name: authProviderIds description: Name of AuthProvider. type: array items: type: string collectionFormat: multi - in: query name: partyIds description: List of parties. type: array items: type: string collectionFormat: multi - in: query name: isValid description: If the token object is valid. type: boolean - 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/OAuthTokenListResponse' 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: OAuthTokens_List: $ref: ./examples/OAuthTokens_List.json summary: Microsoft Azure Get Oauth Tokens /oauth/tokens/:connect: post: tags: - OAuthTokens description: Returns Connection link needed in the OAuth flow. operationId: microsoftAzureOauthtokensGetoauthconnectionlink consumes: - application/json produces: - application/json parameters: - in: query name: api-version description: The requested API version required: true type: string - in: body name: oauthConnectRequest description: OAuth Connect Request. required: true schema: $ref: '#/definitions/OAuthConnectRequest' responses: '200': description: Success schema: type: string 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: OAuthTokens_GetOAuthConnectionLink: $ref: ./examples/OAuthTokens_GetOAuthConnectionLink.json summary: Microsoft Azure Post Oauth Tokens :connect /oauth/tokens/remove/{jobId}: get: tags: - OAuthTokens description: Get remove job for OAuth token. operationId: microsoftAzureOauthtokensGetcascadedeletejobdetails 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: OAuthTokens_GetCascadeDeleteJobDetails: $ref: ./examples/OAuthTokens_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Oauth Tokens Remove Jobid put: tags: - OAuthTokens description: Create remove job for OAuth token. operationId: microsoftAzureOauthtokensCreatecascadedeletejob 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: oauthProviderId description: Id of the OAuthProvider. 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: OAuthTokens_CreateCascadeDeleteJob: $ref: ./examples/OAuthTokens_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Oauth Tokens Remove Jobid /parties: get: tags: - Parties description: Returns a paginated list of party resources. operationId: microsoftAzurePartiesList produces: - application/json parameters: - 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/PartyListResponse' 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: Parties_List: $ref: ./examples/Parties_List.json summary: Microsoft Azure Get Parties /parties:overlap: post: tags: - Parties description: Returns overlapping area between two resources. operationId: microsoftAzurePartiesGeooverlap consumes: - application/json produces: - application/json parameters: - in: query name: api-version description: The requested API version required: true type: string - in: body name: overlapResources description: Overlap Resources. required: true schema: $ref: '#/definitions/OverlapResourcesQuery' responses: '200': description: Success schema: $ref: '#/definitions/PartyOverlapResponse' 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: Parties_GeoOverlap: $ref: ./examples/Parties_GeoOverlap.json summary: Microsoft Azure Post Parties:overlap /parties/{partyId}: get: tags: - Parties description: Gets a specified party resource. operationId: microsoftAzurePartiesGet produces: - application/json parameters: - in: path name: partyId description: ID of the associated party. 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/Party' 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: Parties_Get: $ref: ./examples/Parties_Get.json summary: Microsoft Azure Get Parties Partyid patch: tags: - Parties description: Creates or updates a party resource. operationId: microsoftAzurePartiesCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the party resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: party description: Party resource payload to create or update. required: true schema: $ref: '#/definitions/Party' responses: '200': description: Success schema: $ref: '#/definitions/Party' '201': description: Created schema: $ref: '#/definitions/Party' 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: Parties_CreateOrUpdate: $ref: ./examples/Parties_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid delete: tags: - Parties description: Deletes a specified party resource. operationId: microsoftAzurePartiesDelete produces: - application/json parameters: - in: path name: partyId description: Id of party 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: Parties_Delete: $ref: ./examples/Parties_Delete.json summary: Microsoft Azure Delete Parties Partyid /parties/cascade-delete/{jobId}: get: tags: - Parties description: Get a cascade delete job for specified party. operationId: microsoftAzurePartiesGetcascadedeletejobdetails 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: Parties_GetCascadeDeleteJobDetails: $ref: ./examples/Parties_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Parties Cascade Delete Jobid put: tags: - Parties description: Create a cascade delete job for specified party. operationId: microsoftAzurePartiesCreatecascadedeletejob 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 to be deleted. 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: Parties_CreateCascadeDeleteJob: $ref: ./examples/Parties_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Parties Cascade Delete Jobid /parties/{partyId}/planting-data/{plantingDataId}: get: tags: - PlantingData description: Get a specified planting data resource under a particular party. operationId: microsoftAzurePlantingdataGet produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: plantingDataId description: ID of the planting 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/PlantingData' 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: PlantingData_Get: $ref: ./examples/PlantingData_Get.json summary: Microsoft Azure Get Parties Partyid Planting Data Plantingdataid patch: tags: - PlantingData description: Creates or updates an planting data resource under a particular party. operationId: microsoftAzurePlantingdataCreateorupdate 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: plantingDataId description: ID of the planting data resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: plantingData description: Planting data resource payload to create or update. required: true schema: $ref: '#/definitions/PlantingData' responses: '200': description: Success schema: $ref: '#/definitions/PlantingData' '201': description: Created schema: $ref: '#/definitions/PlantingData' 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: PlantingData_CreateOrUpdate: $ref: ./examples/PlantingData_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Planting Data Plantingdataid delete: tags: - PlantingData description: Deletes a specified planting data resource under a particular party. operationId: microsoftAzurePlantingdataDelete produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: plantingDataId description: ID of the planting 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: PlantingData_Delete: $ref: ./examples/PlantingData_Delete.json summary: Microsoft Azure Delete Parties Partyid Planting Data Plantingdataid /planting-data:search: post: tags: - PlantingData description: Search for PlantingData across all parties by intersecting geometry. operationId: microsoftAzurePlantingdataSearch 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/SearchPlantingDataQuery' responses: '200': description: Success schema: $ref: '#/definitions/PlantingDataMetaDataListResponse' 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: PlantingData_Search: $ref: ./examples/PlantingData_Search.json summary: Microsoft Azure Post Planting Data:search /planting-data/cascade-delete/{jobId}: put: tags: - PlantingData description: Create cascade delete job for planting data resource. operationId: microsoftAzurePlantingdataCreatecascadedeletejob 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: plantingDataId description: Id of the planting 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: PlantingData_CreateCascadeDeleteJob: $ref: ./examples/PlantingData_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Planting Data Cascade Delete Jobid get: tags: - PlantingData description: Get cascade delete job for planting data resource. operationId: microsoftAzurePlantingdataGetcascadedeletejobdetails 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: PlantingData_GetCascadeDeleteJobDetails: $ref: ./examples/PlantingData_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Planting Data Cascade Delete Jobid /parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}: get: tags: - PlantTissueAnalyses description: >- Gets a specified plant tissue analysis resource under a particular party. operationId: microsoftAzurePlanttissueanalysesGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: plantTissueAnalysisId description: Id of the plant tissue analysis. 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/PlantTissueAnalysis' 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: PlantTissueAnalyses_Get: $ref: ./examples/PlantTissueAnalyses_Get.json summary: Microsoft Azure Get Parties Partyid Plant Tissue Analyses Planttissueanalysisid patch: tags: - PlantTissueAnalyses description: Creates or updates a plant tissue analysis resource. operationId: microsoftAzurePlanttissueanalysesCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the party resource. required: true type: string - in: path name: plantTissueAnalysisId description: Id of the plant tissue analysis resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: plantTissueAnalysis description: PlantTissueAnalysis resource payload to create or update. required: true schema: $ref: '#/definitions/PlantTissueAnalysis' responses: '200': description: Success schema: $ref: '#/definitions/PlantTissueAnalysis' '201': description: Created schema: $ref: '#/definitions/PlantTissueAnalysis' 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: PlantTissueAnalyses_CreateOrUpdate: $ref: ./examples/PlantTissueAnalyses_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Plant Tissue Analyses Planttissueanalysisid delete: tags: - PlantTissueAnalyses description: >- Deletes a specified plant tissue analysis resource under a particular party. operationId: microsoftAzurePlanttissueanalysesDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: plantTissueAnalysisId description: Id of the plant tissue analysis. 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: PlantTissueAnalyses_Delete: $ref: ./examples/PlantTissueAnalyses_Delete.json summary: Microsoft Azure Delete Parties Partyid Plant Tissue Analyses Planttissueanalysisid /plant-tissue-analyses:search: post: tags: - PlantTissueAnalyses description: >- Search for PlantTissueAnalyses across all parties by intersecting geometry. operationId: microsoftAzurePlanttissueanalysesSearch 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: searchPlantTissueAnalysisQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchPlantTissueAnalysisQuery' responses: '200': description: Success schema: $ref: '#/definitions/PlantTissueAnalysisMetaDataListResponse' 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: PlantTissueAnalyses_Search: $ref: ./examples/PlantTissueAnalyses_Search.json summary: Microsoft Azure Post Plant Tissue Analyses:search /plant-tissue-analyses/cascade-delete/{jobId}: put: tags: - PlantTissueAnalyses description: Create a cascade delete job for specified plant tissue analysis. operationId: microsoftAzurePlanttissueanalysesCreatecascadedeletejob 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: plantTissueAnalysisId description: ID of the plant tissue analysis to be deleted. 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: PlantTissueAnalyses_CreateCascadeDeleteJob: $ref: ./examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Plant Tissue Analyses Cascade Delete Jobid get: tags: - PlantTissueAnalyses description: Get a cascade delete job for specified plant tissue analysis. operationId: microsoftAzurePlanttissueanalysesGetcascadedeletejobdetails 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: PlantTissueAnalyses_GetCascadeDeleteJobDetails: $ref: ./examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Plant Tissue Analyses Cascade Delete Jobid /parties/{partyId}/prescription-maps: get: tags: - PrescriptionMaps description: >- Returns a paginated list of prescription map resources under a particular party. operationId: microsoftAzurePrescriptionmapsListbypartyid produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: query name: types description: Types of the resource. type: array items: type: string collectionFormat: multi - in: query name: cropIds description: Crop Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: seasonIds description: Season Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: fieldIds description: Field Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: sources description: Sources for the resource. 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/PrescriptionMapListResponse' 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: PrescriptionMaps_ListByPartyId: $ref: ./examples/PrescriptionMaps_ListByPartyId.json summary: Microsoft Azure Get Parties Partyid Prescription Maps /parties/{partyId}/prescription-maps/{prescriptionMapId}: get: tags: - PrescriptionMaps description: Gets a specified prescription map resource under a particular party. operationId: microsoftAzurePrescriptionmapsGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: prescriptionMapId description: Id of the prescription map. 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/PrescriptionMap' 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: PrescriptionMaps_Get: $ref: ./examples/PrescriptionMaps_Get.json summary: Microsoft Azure Get Parties Partyid Prescription Maps Prescriptionmapid patch: tags: - PrescriptionMaps description: Creates or Updates a prescription map resource under a particular party. operationId: microsoftAzurePrescriptionmapsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the associated party resource. required: true type: string - in: path name: prescriptionMapId description: Id of the prescription map resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: prescriptionMap description: PrescriptionMap resource payload to create or update. required: true schema: $ref: '#/definitions/PrescriptionMap' responses: '200': description: Success schema: $ref: '#/definitions/PrescriptionMap' '201': description: Created schema: $ref: '#/definitions/PrescriptionMap' 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: PrescriptionMaps_CreateOrUpdate: $ref: ./examples/PrescriptionMaps_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Prescription Maps Prescriptionmapid delete: tags: - PrescriptionMaps description: Deletes a specified prescription map resource under a particular party. operationId: microsoftAzurePrescriptionmapsDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: prescriptionMapId description: Id of the prescriptionMap. 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: PrescriptionMaps_Delete: $ref: ./examples/PrescriptionMaps_Delete.json summary: Microsoft Azure Delete Parties Partyid Prescription Maps Prescriptionmapid /prescription-maps: get: tags: - PrescriptionMaps description: >- Returns a paginated list of prescription map resources across all parties. operationId: microsoftAzurePrescriptionmapsList produces: - application/json parameters: - in: query name: types description: Types of the resource. type: array items: type: string collectionFormat: multi - in: query name: cropIds description: Crop Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: seasonIds description: Season Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: fieldIds description: Field Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: sources description: Sources for the resource. 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/PrescriptionMapListResponse' 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: PrescriptionMaps_List: $ref: ./examples/PrescriptionMaps_List.json summary: Microsoft Azure Get Prescription Maps /prescription-maps/cascade-delete/{jobId}: get: tags: - PrescriptionMaps description: Get a cascade delete job for specified prescription map. operationId: microsoftAzurePrescriptionmapsGetcascadedeletejobdetails 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: PrescriptionMaps_GetCascadeDeleteJobDetails: $ref: ./examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Prescription Maps Cascade Delete Jobid put: tags: - PrescriptionMaps description: Create a cascade delete job for specified prescription map. operationId: microsoftAzurePrescriptionmapsCreatecascadedeletejob 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: prescriptionMapId description: ID of the prescription map to be deleted. 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: PrescriptionMaps_CreateCascadeDeleteJob: $ref: ./examples/PrescriptionMaps_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Prescription Maps Cascade Delete Jobid /parties/{partyId}/prescriptions/{prescriptionId}: get: tags: - Prescriptions description: Gets a specified prescription resource under a particular party. operationId: microsoftAzurePrescriptionsGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: prescriptionId description: Id of the prescription. 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/Prescription' 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: Prescriptions_Get: $ref: ./examples/Prescriptions_Get.json summary: Microsoft Azure Get Parties Partyid Prescriptions Prescriptionid patch: tags: - Prescriptions description: Creates or Updates a prescription resource under a particular party. operationId: microsoftAzurePrescriptionsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the associated party resource. required: true type: string - in: path name: prescriptionId description: Id of the prescription resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: prescription description: Prescription resource payload to create or update. required: true schema: $ref: '#/definitions/Prescription' responses: '200': description: Success schema: $ref: '#/definitions/Prescription' '201': description: Created schema: $ref: '#/definitions/Prescription' 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: Prescriptions_CreateOrUpdate: $ref: ./examples/Prescriptions_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Prescriptions Prescriptionid delete: tags: - Prescriptions description: Deletes a specified prescription resource under a particular party. operationId: microsoftAzurePrescriptionsDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: prescriptionId description: Id of the prescription. 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: Prescriptions_Delete: $ref: ./examples/Prescriptions_Delete.json summary: Microsoft Azure Delete Parties Partyid Prescriptions Prescriptionid /prescription:search: post: tags: - Prescriptions description: Search for Prescriptions across all parties by intersecting geometry. operationId: microsoftAzurePrescriptionsSearch 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: searchPrescriptionQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchPrescriptionQuery' responses: '200': description: Success schema: $ref: '#/definitions/PrescriptionMetaDataListResponse' 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: Prescriptions_Search: $ref: ./examples/Prescriptions_Search.json summary: Microsoft Azure Post Prescription:search /prescriptions/cascade-delete/{jobId}: get: tags: - Prescriptions description: Get a cascade delete job for specified prescription. operationId: microsoftAzurePrescriptionsGetcascadedeletejobdetails 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: Prescriptions_GetCascadeDeleteJobDetails: $ref: ./examples/Prescriptions_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Prescriptions Cascade Delete Jobid put: tags: - Prescriptions description: Create a cascade delete job for specified prescription. operationId: microsoftAzurePrescriptionsCreatecascadedeletejob 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: prescriptionId description: ID of the prescription to be deleted. 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: Prescriptions_CreateCascadeDeleteJob: $ref: ./examples/Prescriptions_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Prescriptions Cascade Delete Jobid /scenes: get: tags: - Scenes description: Returns a paginated list of scene resources. operationId: microsoftAzureScenesList produces: - application/json parameters: - in: query name: provider description: 'Provider name of scene data. Supported value: SentinelHub.' required: true type: string - in: query name: partyId description: PartyId. required: true type: string - in: query name: associatedResourceId description: Associated Resource Id of the resource. required: true type: string - in: query name: associatedResourceType description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." required: true type: string - in: query name: collection description: >- Collection name of scene data, Available Values: sentinel-2-l2a, sentinel-2l1c. required: true type: string - in: query name: itemId description: Item Id. type: string - in: query name: startDateTime description: >- Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ. type: string format: date-time - in: query name: endDateTime description: >- Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ. type: string format: date-time - in: query name: maxCloudCoveragePercentage description: >- Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. type: number format: double default: 100 maximum: 100 minimum: 0 - in: query name: maxDarkPixelCoveragePercentage description: >- Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. type: number format: double default: 100 maximum: 100 minimum: 0 - in: query name: imageNames description: List of image names to be filtered. type: array items: type: string collectionFormat: multi - in: query name: imageResolutions description: List of image resolutions in meters to be filtered. type: array items: format: double type: number collectionFormat: multi - in: query name: imageFormats description: List of image formats to be filtered. type: array items: type: string collectionFormat: multi - 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/SceneListResponse' 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: Scenes_List: $ref: ./examples/Scenes_List.json summary: Microsoft Azure Get Scenes /scenes/downloadFiles: get: tags: - Scenes description: >- Downloads and returns file Stream as response for the given input filePath. operationId: microsoftAzureScenesDownload produces: - application/json - application/octet-stream parameters: - in: query name: filePath description: cloud storage path of scene file. 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: Scenes_Download: $ref: ./examples/Scenes_Download.json summary: Microsoft Azure Get Scenes Downloadfiles /scenes/satellite/ingest-data/{jobId}: put: tags: - Scenes description: Create a satellite data ingestion job. operationId: microsoftAzureScenesCreatesatellitedataingestionjob consumes: - application/json produces: - application/json parameters: - in: path name: jobId description: JobId provided by user. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: job description: Job parameters supplied by user. required: true schema: $ref: '#/definitions/SatelliteDataIngestionJob' responses: '202': description: Accepted schema: $ref: '#/definitions/SatelliteDataIngestionJob' 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: Scenes_CreateSatelliteDataIngestionJob: $ref: ./examples/Scenes_CreateSatelliteDataIngestionJob.json summary: Microsoft Azure Put Scenes Satellite Ingest Data Jobid get: tags: - Scenes description: Get a satellite data ingestion job. operationId: microsoftAzureScenesGetsatellitedataingestionjobdetails 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/SatelliteDataIngestionJob' 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: Scenes_GetSatelliteDataIngestionJobDetails: $ref: ./examples/Scenes_GetSatelliteDataIngestionJobDetails.json summary: Microsoft Azure Get Scenes Satellite Ingest Data Jobid /scenes/stac-collections/{collectionId}:search: post: tags: - Scenes description: >- Search for STAC items by collection id, bbox, intersecting geometry, start and end datetime. operationId: microsoftAzureScenesSearchitems consumes: - application/json produces: - application/json parameters: - in: path name: collectionId description: >- Collection Id to be searched. Available Values are: sentinel-2-l2a, sentinel-2-l1c. required: true type: string - in: query name: maxpagesize description: >- Maximum number of items needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10. type: integer format: int32 default: 10 maximum: 100 minimum: 1 - in: query name: skip description: Skip token for getting next set of results. type: integer format: int32 maximum: 2147483647 minimum: 1 - in: query name: api-version description: The requested API version required: true type: string - in: body name: searchItemsQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchItemsQuery' responses: '200': description: Success schema: $ref: '#/definitions/SearchItemsResponse' 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: Scenes_SearchItems: $ref: ./examples/Scenes_SearchItems.json summary: Microsoft Azure Post Scenes Stac Collections Collectionid:search /parties/{partyId}/seasonal-fields/{seasonalFieldId}: get: tags: - SeasonalFields description: Gets a specified seasonal field resource under a particular party. operationId: microsoftAzureSeasonalfieldsGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: seasonalFieldId description: Id of the seasonal field. 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/SeasonalField' 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: SeasonalFields_Get: $ref: ./examples/SeasonalFields_Get.json summary: Microsoft Azure Get Parties Partyid Seasonal Fields Seasonalfieldid patch: tags: - SeasonalFields description: Creates or Updates a seasonal field resource under a particular party. operationId: microsoftAzureSeasonalfieldsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the associated party resource. required: true type: string - in: path name: seasonalFieldId description: Id of the seasonal field resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: seasonalField description: Seasonal field resource payload to create or update. required: true schema: $ref: '#/definitions/SeasonalField' responses: '200': description: Success schema: $ref: '#/definitions/SeasonalField' '201': description: Created schema: $ref: '#/definitions/SeasonalField' 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: SeasonalFields_CreateOrUpdate: $ref: ./examples/SeasonalFields_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Seasonal Fields Seasonalfieldid delete: tags: - SeasonalFields description: Deletes a specified seasonal-field resource under a particular party. operationId: microsoftAzureSeasonalfieldsDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: seasonalFieldId description: Id of the seasonal field. 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: SeasonalFields_Delete: $ref: ./examples/SeasonalFields_Delete.json summary: Microsoft Azure Delete Parties Partyid Seasonal Fields Seasonalfieldid /seasonal-fields:search: post: tags: - SeasonalFields description: Search for SeasonalFields across all parties by intersecting geometry. operationId: microsoftAzureSeasonalfieldsSearch 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: searchSeasonalFieldQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchSeasonalFieldQuery' responses: '200': description: Success schema: $ref: '#/definitions/SeasonalFieldMetaDataListResponse' 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: SeasonalFields_Search: $ref: ./examples/SeasonalFields_Search.json summary: Microsoft Azure Post Seasonal Fields:search /seasonal-fields/cascade-delete/{jobId}: get: tags: - SeasonalFields description: Get cascade delete job for specified seasonal field. operationId: microsoftAzureSeasonalfieldsGetcascadedeletejobdetails 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: SeasonalFields_GetCascadeDeleteJobDetails: $ref: ./examples/SeasonalFields_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Seasonal Fields Cascade Delete Jobid put: tags: - SeasonalFields description: Create a cascade delete job for specified seasonal field. operationId: microsoftAzureSeasonalfieldsCreatecascadedeletejob 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: seasonalFieldId description: ID of the seasonalField to be deleted. 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: SeasonalFields_CreateCascadeDeleteJob: $ref: ./examples/SeasonalFields_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Seasonal Fields Cascade Delete Jobid /seasons: get: tags: - Seasons description: Returns a paginated list of season resources. operationId: microsoftAzureSeasonsList produces: - application/json parameters: - in: query name: minStartDateTime description: 'Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string format: date-time - in: query name: maxStartDateTime description: 'Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string format: date-time - in: query name: minEndDateTime description: 'Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string format: date-time - in: query name: maxEndDateTime description: 'Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string format: date-time - in: query name: years description: Years of the resource. type: array items: format: int32 type: integer 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/SeasonListResponse' 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: Seasons_List: $ref: ./examples/Seasons_List.json summary: Microsoft Azure Get Seasons /seasons/{seasonId}: get: tags: - Seasons description: Gets a specified season resource. operationId: microsoftAzureSeasonsGet produces: - application/json parameters: - in: path name: seasonId description: Id of the season. 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/Season' 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: Seasons_Get: $ref: ./examples/Seasons_Get.json summary: Microsoft Azure Get Seasons Seasonid patch: tags: - Seasons description: Creates or updates a season resource. operationId: microsoftAzureSeasonsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: seasonId description: Id of the season resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: season description: Season resource payload to create or update. required: true schema: $ref: '#/definitions/Season' responses: '200': description: Success schema: $ref: '#/definitions/Season' '201': description: Created schema: $ref: '#/definitions/Season' 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: Seasons_CreateOrUpdate: $ref: ./examples/Seasons_CreateOrUpdate.json summary: Microsoft Azure Patch Seasons Seasonid delete: tags: - Seasons description: Deletes a specified season resource. operationId: microsoftAzureSeasonsDelete produces: - application/json parameters: - in: path name: seasonId description: Id of the season. 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: Seasons_Delete: $ref: ./examples/Seasons_Delete.json summary: Microsoft Azure Delete Seasons Seasonid /sensor-partners/{sensorPartnerId}/sensor-data-models: get: tags: - SensorDataModels description: Returns a paginated list of sensor data model resources. operationId: microsoftAzureSensordatamodelsList produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the associated sensor partner. required: true type: string - 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/SensorDataModelListResponse' 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: SensorDataModels_List: $ref: ./examples/SensorDataModels_List.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Sensor Data Models /sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}: patch: tags: - SensorDataModels description: Create a sensor data model entity. operationId: microsoftAzureSensordatamodelsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorDataModelId description: Id of the sensor data model. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: sensorDataModelObject description: Sensor data model object details. required: true schema: $ref: '#/definitions/SensorDataModel' responses: '200': description: Success schema: $ref: '#/definitions/SensorDataModel' '201': description: Created schema: $ref: '#/definitions/SensorDataModel' 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: SensorDataModels_CreateOrUpdate: $ref: ./examples/SensorDataModels_CreateOrUpdate.json summary: >- Microsoft Azure Patch Sensor Partners Sensorpartnerid Sensor Data Models Sensordatamodelid get: tags: - SensorDataModels description: Gets a sensor data model entity. operationId: microsoftAzureSensordatamodelsGet produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorDataModelId description: Id of the sensor data model 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/SensorDataModel' 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: SensorDataModels_Get: $ref: ./examples/SensorDataModels_Get.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Sensor Data Models Sensordatamodelid delete: tags: - SensorDataModels description: Deletes a sensor data model entity. operationId: microsoftAzureSensordatamodelsDelete produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorDataModelId description: Id of the sensor data model 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: SensorDataModels_Delete: $ref: ./examples/SensorDataModels_Delete.json summary: >- Microsoft Azure Delete Sensor Partners Sensorpartnerid Sensor Data Models Sensordatamodelid /sensor-events: get: tags: - SensorEvents description: >- Returns a list of sensor events data. Time span for query is limited to 90 days at a time.
Returns last 90 days events when startDateTime and endDateTime are not provided. operationId: microsoftAzureSensoreventsList produces: - application/json parameters: - in: query name: sensorId description: Id of the associated sensor. required: true type: string - in: query name: sensorPartnerId description: Id of the associated sensor partner. required: true type: string - in: query name: startDateTime description: "Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided." type: string format: date-time - in: query name: endDateTime description: "Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided." type: string format: date-time - in: query name: excludeDuplicateEvents description: >- Flag to exclude duplicate events and take the latest ones only (Default: false). type: boolean default: false - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/SensorEventListResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: SensorEvents_List: $ref: ./examples/SensorEvents_List.json summary: Microsoft Azure Get Sensor Events /sensor-mappings: get: tags: - SensorMappings description: Returns a paginated list of sensor mapping resources. operationId: microsoftAzureSensormappingsList produces: - application/json parameters: - in: query name: sensorIds description: Id of the sensors. type: array items: type: string collectionFormat: multi - in: query name: sensorPartnerIds description: Id of the sensor partners. type: array items: type: string collectionFormat: multi - in: query name: partyIds description: Id of the parties. type: array items: type: string collectionFormat: multi - in: query name: associatedResourceIds description: Resource Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: associatedResourceType description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, FarmOperationApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." type: string - 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/SensorMappingListResponse' 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: SensorMappings_List: $ref: ./examples/SensorMappings_List.json summary: Microsoft Azure Get Sensor Mappings /sensor-mappings/{sensorMappingId}: patch: tags: - SensorMappings description: Create a sensor mapping entity. operationId: microsoftAzureSensormappingsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: sensorMappingId description: Id of the sensor mapping. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: sensorMappingObject description: Sensor mapping object details. required: true schema: $ref: '#/definitions/SensorMapping' responses: '200': description: Success schema: $ref: '#/definitions/SensorMapping' '201': description: Created schema: $ref: '#/definitions/SensorMapping' 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: SensorMappings_CreateOrUpdate: $ref: ./examples/SensorMappings_CreateOrUpdate.json summary: Microsoft Azure Patch Sensor Mappings Sensormappingid get: tags: - SensorMappings description: Gets a sensor mapping entity. operationId: microsoftAzureSensormappingsGet produces: - application/json parameters: - in: path name: sensorMappingId description: Id of the sensor mapping 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/SensorMapping' 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: SensorMappings_Get: $ref: ./examples/SensorMappings_Get.json summary: Microsoft Azure Get Sensor Mappings Sensormappingid delete: tags: - SensorMappings description: Deletes a sensor mapping entity. operationId: microsoftAzureSensormappingsDelete produces: - application/json parameters: - in: path name: sensorMappingId description: Id of the sensor mapping 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: SensorMappings_Delete: $ref: ./examples/SensorMappings_Delete.json summary: Microsoft Azure Delete Sensor Mappings Sensormappingid /sensor-partners/{sensorPartnerId}/integrations: get: tags: - SensorPartnerIntegrations description: Gets partner integration models. operationId: microsoftAzureSensorpartnerintegrationsList produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the associated sensor partner. required: true type: string - in: query name: partyIds description: Ids of the parties. 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/SensorPartnerIntegrationModelListResponse' 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: SensorPartnerIntegrations_List: $ref: ./examples/SensorPartnerIntegrations_List.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Integrations /sensor-partners/{sensorPartnerId}/integrations/{integrationId}: patch: tags: - SensorPartnerIntegrations description: Create or update an integration with a sensor partner. operationId: microsoftAzureSensorpartnerintegrationsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: integrationId description: Id of the integration to be created. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: sensorPartnerIntegrationModel description: Partner integration model. required: true schema: $ref: '#/definitions/SensorPartnerIntegrationModel' responses: '200': description: Success schema: $ref: '#/definitions/SensorPartnerIntegrationModel' '201': description: Created schema: $ref: '#/definitions/SensorPartnerIntegrationModel' 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: SensorPartnerIntegrations_CreateOrUpdate: $ref: ./examples/SensorPartnerIntegrations_CreateOrUpdate.json summary: Microsoft Azure Patch Sensor Partners Sensorpartnerid Integrations Integrationid get: tags: - SensorPartnerIntegrations description: Gets a partner integration model entity. operationId: microsoftAzureSensorpartnerintegrationsGet produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: integrationId description: Id of the integration object. 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/SensorPartnerIntegrationModel' 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: SensorPartnerIntegrations_Get: $ref: ./examples/SensorPartnerIntegrations_Get.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Integrations Integrationid delete: tags: - SensorPartnerIntegrations description: Deletes a partner integration model entity. operationId: microsoftAzureSensorpartnerintegrationsDelete produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: integrationId description: Id of the integration 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: SensorPartnerIntegrations_Delete: $ref: ./examples/SensorPartnerIntegrations_Delete.json summary: Microsoft Azure Delete Sensor Partners Sensorpartnerid Integrations Integrationid /sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent: post: tags: - SensorPartnerIntegrations description: Checks consent for partner integration. operationId: microsoftAzureSensorpartnerintegrationsCheckconsent produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: integrationId description: Id of the integration object. required: true type: string - in: query name: key description: Partner integration key. 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/SensorPartnerIntegrationCheckConsentResponse' 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: SensorPartnerIntegrations_CheckConsent: $ref: ./examples/SensorPartnerIntegrations_CheckConsent.json summary: >- Microsoft Azure Post Sensor Partners Sensorpartnerid Integrations Integrationid :check Consent /sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:generate-consent-link: post: tags: - SensorPartnerIntegrations description: Generates partner integration consent link. operationId: microsoftAzureSensorpartnerintegrationsGenerateconsentlink produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: integrationId description: Id of the integration object. 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/SensorPartnerIntegrationGenerateConsentLinkResponse' 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: SensorPartnerIntegrations_GenerateConsentLink: $ref: ./examples/SensorPartnerIntegrations_GenerateConsentLink.json summary: >- Microsoft Azure Post Sensor Partners Sensorpartnerid Integrations Integrationid :generate Consent Link /sensor-partners/{sensorPartnerId}/sensors: get: tags: - Sensors description: Returns a paginated list of sensor resources. operationId: microsoftAzureSensorsList produces: - application/json parameters: - in: query name: sensorDataModelIds description: Id's of the sensor data models. type: array items: type: string collectionFormat: multi - in: query name: sensorMappingIds description: Ids of the sensor mappings. type: array items: type: string collectionFormat: multi - in: path name: sensorPartnerId description: Id of the associated sensor partner. required: true type: string - in: query name: deviceIds description: Id's of the devices. 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/SensorListResponse' 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: Sensors_List: $ref: ./examples/Sensors_List.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Sensors /sensor-partners/{sensorPartnerId}/sensors/{sensorId}: patch: tags: - Sensors description: Create a sensor entity. operationId: microsoftAzureSensorsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorId description: Id of the sensor resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: sensorDetails description: Sensor object details. required: true schema: $ref: '#/definitions/Sensor' responses: '200': description: Success schema: $ref: '#/definitions/Sensor' '201': description: Created schema: $ref: '#/definitions/Sensor' 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: Sensors_CreateOrUpdate: $ref: ./examples/Sensors_CreateOrUpdate.json summary: Microsoft Azure Patch Sensor Partners Sensorpartnerid Sensors Sensorid get: tags: - Sensors description: Gets a sensor entity. operationId: microsoftAzureSensorsGet produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorId description: Id of the sensor 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/Sensor' 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: Sensors_Get: $ref: ./examples/Sensors_Get.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Sensors Sensorid delete: tags: - Sensors description: Deletes a sensor entity. operationId: microsoftAzureSensorsDelete produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorId description: Id of the sensor 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: Sensors_Delete: $ref: ./examples/Sensors_Delete.json summary: Microsoft Azure Delete Sensor Partners Sensorpartnerid Sensors Sensorid /sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings: get: tags: - Sensors description: Gets a sensor connection string. operationId: microsoftAzureSensorsGetconnectionstring produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorId description: Id of the sensor 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/IoTHubDeviceAuthentication' 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: Sensors_GetConnectionString: $ref: ./examples/Sensors_GetConnectionString.json summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Sensors Sensorid Connection Strings /sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings/:renew: post: tags: - Sensors description: Renews a sensor connection string. operationId: microsoftAzureSensorsRenewconnectionstring consumes: - application/json produces: - application/json parameters: - in: path name: sensorPartnerId description: Id of the sensor partner. required: true type: string - in: path name: sensorId description: Id of the sensor resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: renewConnectionStringModel description: Sensor's connection string model. required: true schema: $ref: '#/definitions/SensorRenewConnectionStringModel' responses: '200': description: Success schema: $ref: '#/definitions/IoTHubDeviceAuthentication' 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: Sensors_RenewConnectionString: $ref: ./examples/Sensors_RenewConnectionString.json summary: >- Microsoft Azure Post Sensor Partners Sensorpartnerid Sensors Sensorid Connection Strings :renew /solutions/{solutionId}:cancel: post: tags: - SolutionInference description: Cancels a job for given solution id. operationId: microsoftAzureSolutioninferenceCancel consumes: - application/json produces: - application/json parameters: - in: path name: solutionId description: Id of solution for which job is to be cancelled. required: true type: string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$ - in: query name: api-version description: The requested API version required: true type: string - in: body name: solutionInferenceRequest description: >- solutionInferenceRequest containing input needed for job request processing. required: true schema: $ref: '#/definitions/SolutionInference' responses: '200': description: Success schema: type: object additionalProperties: {} 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: SolutionInference_Cancel: $ref: ./examples/SolutionInference_Cancel.json summary: Microsoft Azure Post Solutions Solutionid:cancel /solutions/{solutionId}:create: post: tags: - SolutionInference description: Creates a job trigger for a solution. operationId: microsoftAzureSolutioninferenceCreateorupdate consumes: - application/json produces: - application/json parameters: - in: path name: solutionId description: Id of the solution resource. required: true type: string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$ - in: query name: api-version description: The requested API version required: true type: string - in: body name: solutionInferenceRequest description: >- solutionInferenceRequest containing input needed for job request processing. required: true schema: $ref: '#/definitions/SolutionInference' responses: '202': description: Accepted schema: type: object additionalProperties: {} 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: SolutionInference_CreateOrUpdate: $ref: ./examples/SolutionInference_CreateOrUpdate.json summary: Microsoft Azure Post Solutions Solutionid:create /solutions/{solutionId}:fetch: post: tags: - SolutionInference description: Fetches details of triggered job for a solution. operationId: microsoftAzureSolutioninferenceFetch consumes: - application/json produces: - application/json parameters: - in: path name: solutionId description: Id of the solution. required: true type: string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$ - in: query name: api-version description: The requested API version required: true type: string - in: body name: solutionInferenceRequest description: >- solutionInferenceRequest containing input needed for job request processing. required: true schema: $ref: '#/definitions/SolutionInference' responses: '200': description: Success schema: type: object additionalProperties: {} 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: SolutionInference_Fetch: $ref: ./examples/SolutionInference_Fetch.json summary: Microsoft Azure Post Solutions Solutionid:fetch /parties/{partyId}/tillage-data/{tillageDataId}: get: tags: - TillageData description: Get a specified tillage data resource under a particular party. operationId: microsoftAzureTillagedataGet produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: tillageDataId description: ID of the tillage 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/TillageData' 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: TillageData_Get: $ref: ./examples/TillageData_Get.json summary: Microsoft Azure Get Parties Partyid Tillage Data Tillagedataid patch: tags: - TillageData description: Creates or updates an tillage data resource under a particular party. operationId: microsoftAzureTillagedataCreateorupdate 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: tillageDataId description: ID of the tillage data resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: tillageData description: Tillage data resource payload to create or update. required: true schema: $ref: '#/definitions/TillageData' responses: '200': description: Success schema: $ref: '#/definitions/TillageData' '201': description: Created schema: $ref: '#/definitions/TillageData' 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: TillageData_CreateOrUpdate: $ref: ./examples/TillageData_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Tillage Data Tillagedataid delete: tags: - TillageData description: Deletes a specified tillage data resource under a particular party. operationId: microsoftAzureTillagedataDelete produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: tillageDataId description: ID of the tillage 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: TillageData_Delete: $ref: ./examples/TillageData_Delete.json summary: Microsoft Azure Delete Parties Partyid Tillage Data Tillagedataid /tillage-data:search: post: tags: - TillageData description: Search for TillageData across all parties by intersecting geometry. operationId: microsoftAzureTillagedataSearch 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/SearchTillageDataQuery' responses: '200': description: Success schema: $ref: '#/definitions/TillageDataMetaDataListResponse' 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: TillageData_Search: $ref: ./examples/TillageData_Search.json summary: Microsoft Azure Post Tillage Data:search /tillage-data/cascade-delete/{jobId}: put: tags: - TillageData description: Create cascade delete job for tillage data resource. operationId: microsoftAzureTillagedataCreatecascadedeletejob 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: tillageDataId description: Id of the tillage 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: TillageData_CreateCascadeDeleteJob: $ref: ./examples/TillageData_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Tillage Data Cascade Delete Jobid get: tags: - TillageData description: Get cascade delete job for tillage data resource. operationId: microsoftAzureTillagedataGetcascadedeletejobdetails 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: TillageData_GetCascadeDeleteJobDetails: $ref: ./examples/TillageData_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Tillage Data Cascade Delete Jobid /weather-data:fetch: post: tags: - WeatherData description: Returns a list of WeatherData. operationId: microsoftAzureWeatherdataGet consumes: - application/json produces: - application/json parameters: - in: query name: api-version description: The requested API version required: true type: string - in: body name: weatherDataProviderRequest description: Weather data provider request. required: true schema: $ref: '#/definitions/WeatherDataProviderRequest' responses: '200': description: Success schema: $ref: '#/definitions/WeatherDataProviderResponse' 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: WeatherData_Get: $ref: ./examples/WeatherData_Get.json summary: Microsoft Azure Post Weather Data:fetch /parties/{partyId}/zones/{zoneId}: get: tags: - Zones description: Gets a specified zone resource under a particular party. operationId: microsoftAzureZonesGet produces: - application/json parameters: - in: path name: partyId description: Id of the associated party. required: true type: string - in: path name: zoneId description: Id of the zone. 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/Zone' 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: Zones_Get: $ref: ./examples/Zones_Get.json summary: Microsoft Azure Get Parties Partyid Zones Zoneid patch: tags: - Zones description: Creates or updates a Zone resource. operationId: microsoftAzureZonesCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: Id of the party resource. required: true type: string - in: path name: zoneId description: Id of the zone resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: zone description: Zone resource payload to create or update. required: true schema: $ref: '#/definitions/Zone' responses: '200': description: Success schema: $ref: '#/definitions/Zone' '201': description: Created schema: $ref: '#/definitions/Zone' 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: Zones_CreateOrUpdate: $ref: ./examples/Zones_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Zones Zoneid delete: tags: - Zones description: Deletes a specified zone resource under a particular party. operationId: microsoftAzureZonesDelete produces: - application/json parameters: - in: path name: partyId description: Id of the party. required: true type: string - in: path name: zoneId description: Id of the zone. 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: Zones_Delete: $ref: ./examples/Zones_Delete.json summary: Microsoft Azure Delete Parties Partyid Zones Zoneid /zone:search: post: tags: - Zones description: Search for Zones across all parties by intersecting geometry. operationId: microsoftAzureZonesSearch 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: searchZoneQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchZoneQuery' responses: '200': description: Success schema: $ref: '#/definitions/ZoneMetaDataListResponse' 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: Zones_Search: $ref: ./examples/Zones_Search.json summary: Microsoft Azure Post Zone:search /zones/cascade-delete/{jobId}: get: tags: - Zones description: Get a cascade delete job for specified job id. operationId: microsoftAzureZonesGetcascadedeletejobdetails 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: Zones_GetCascadeDeleteJobDetails: $ref: ./examples/Zones_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Zones Cascade Delete Jobid put: tags: - Zones description: Create a cascade delete job for specified zone. operationId: microsoftAzureZonesCreatecascadedeletejob 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: zoneId description: ID of the zone to be deleted. 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: Zones_CreateCascadeDeleteJob: $ref: ./examples/Zones_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Zones Cascade Delete Jobid definitions: AdditionalProviderParameters: description: Schema of additional parameters for weather data provider request. type: object properties: iconResolution: description: Icon Resolution (Only applicable for AzureWeatherMaps). maxLength: 100 minLength: 2 type: string details: description: Details (Only applicable for AzureWeatherMaps). default: true type: boolean ApiKeyAuthCredentials: description: Api Key Auth Credentials class for API Key based Auth. type: object allOf: - $ref: '#/definitions/AuthCredentials' - required: - apiKey type: object properties: apiKey: $ref: '#/definitions/KeyVaultProperties' x-ms-discriminator-value: ApiKeyAuthCredentials ApplicationData: description: Schema of application data resource. type: object properties: applicationProductDetails: description: Application product details. type: array items: $ref: '#/definitions/ApplicationProductDetail' avgMaterial: $ref: '#/definitions/Measure' totalMaterial: $ref: '#/definitions/Measure' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ApplicationDataMetaData: description: Schema of application data resource. type: object properties: applicationProductDetails: description: Application product details. type: array items: $ref: '#/definitions/ApplicationProductDetail' avgMaterial: $ref: '#/definitions/Measure' totalMaterial: $ref: '#/definitions/Measure' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ApplicationDataMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/ApplicationDataMetaData' 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 ApplicationProductDetail: description: Schema of product used during application. type: object properties: productName: description: Name of the product applied. maxLength: 100 minLength: 1 type: string isCarrier: description: A flag indicating whether product is a carrier for a tank mix. default: false type: boolean avgMaterial: $ref: '#/definitions/Measure' totalMaterial: $ref: '#/definitions/Measure' Attachment: description: Schema of attachment resource. type: object properties: resourceId: description: Associated Resource id for this attachment. type: string resourceType: description: Associated Resource type for this attachment. enum: - Party - Farm - Field - SeasonalField - ApplicationData - HarvestData - TillageData - PlantingData - PlantTissueAnalysis - Prescription type: string x-ms-enum: name: AttachmentResourceType modelAsString: 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 AttachmentListResponse: 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/Attachment' 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 AuthCredentials: description: AuthCredentials abstract base class for Auth Purpose. required: - kind type: object properties: kind: $ref: '#/definitions/AuthCredentialsKind' discriminator: kind AuthCredentialsKind: description: Enum for different types of AuthCredentials supported. enum: - OAuthClientCredentials - ApiKeyAuthCredentials type: string x-ms-enum: name: AuthCredentialsKind modelAsString: true 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 ChemicalProduct: description: Schema of ChemicalProduct resource. type: object properties: cropIds: description: "The Ids of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct." uniqueItems: true type: array items: type: string reference: $ref: '#/definitions/Reference' brand: description: Commercial brand of the chemical product. type: string product: description: Commercial product name of the chemical product. type: string type: description: Herbicide, Additive, Insecticides, Fertilizers. type: string state: description: Liquid/non Liquid. type: string activeIngredients: description: Active chemicals in the formulation. type: array items: type: string specificGravity: description: Specific gravity details. type: string formulation: description: "Formulation description. Percentage or other unit of N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL\r\n(based on the source, the available chemical elements can vary, but this is a typical list)." type: string company: $ref: '#/definitions/Company' location: description: >- Area where the chemical is used. This is important from a compliance perspective. type: string registrationNumber: description: Registration number of the chemical. This could vary by geography. type: string reEntryInterval: format: int32 description: >- The number of days after which a person can visit the field after the chemical product is applied. type: integer id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ChemicalProductListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/ChemicalProduct' 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 Company: description: Company/Manufacturer's details. type: object properties: name: description: Name of the manufacturing company. type: string description: description: Manufacturing Company description. type: string registrationNumber: description: Registration number of the company. type: string Crop: description: Schema of crop resource. type: object properties: reference: $ref: '#/definitions/Reference' phenotype: description: >- Phenotype of the crop. Example values are crop weight, height, color, etc. maxLength: 100 minLength: 0 type: string breedingMethod: description: Type of breeding Method like VARIETY, HYBRID, UNKNOWN. type: string measurements: description: >- The properties that pertain to this crop such as nominal weight, nominal moisture, and shrink factor. type: object additionalProperties: $ref: '#/definitions/Measure' location: description: Region where the crop is planted. maxLength: 50 minLength: 0 type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 CropListResponse: 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/Crop' 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 CropProduct: description: Schema of crop product resource. type: object properties: cropIds: description: "The IDs of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct." uniqueItems: true type: array items: type: string reference: $ref: '#/definitions/Reference' brand: description: Commercial brand of the crop product. maxLength: 100 minLength: 0 type: string product: description: Commercial product name of the crop product. maxLength: 100 minLength: 0 type: string relativeMaturity: $ref: '#/definitions/RelativeMaturityMeasure' treatments: description: Seed Coatings Applied for fungus, insects etc. type: array items: type: string traitStack: description: >- Phenotypic expressions like CONV, RR2. These are the Phenotypic expressions like CONV (Conventional), RR2 (RoundUpReady). maxLength: 100 minLength: 0 type: string traits: description: Traits that are in the stack. maxLength: 100 minLength: 0 type: string location: description: Trait. maxLength: 100 minLength: 0 type: string company: $ref: '#/definitions/Company' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 CropProductListResponse: 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/CropProduct' 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 Dataset: description: Schema of dataset resource. type: object properties: type: description: >- Type of the dataset. Supported types: Crop, CropProduct, ChemicalProduct, Equipment. enum: - Crop - CropProduct - ChemicalProduct - FarmEquipment type: string x-ms-enum: name: DatasetType modelAsString: true recordsSchema: description: Schema for records under the dataset. type: object additionalProperties: {} solutionId: description: Solution id of the dataset solution. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 DatasetAccess: description: DatasetAccess object. type: object properties: subscriptionId: description: Subscription Id. maxLength: 100 minLength: 2 type: string resourceId: description: Azure Data Manager for Agriculture resource Id. maxLength: 200 minLength: 2 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' createdBy: description: Created by user/tenant id. type: string readOnly: true modifiedBy: description: Modified by user/tenant id. type: string readOnly: true DatasetAccessListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/DatasetAccess' 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 DatasetListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/Dataset' 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 DatasetRecord: description: Schema of dataset records. type: object properties: datasetId: description: Dataset Id for this record. type: string readOnly: true record: description: Record object. type: object additionalProperties: {} id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 DatasetRecordListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/DatasetRecord' 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 Device: description: Device API model. type: object properties: deviceDataModelId: description: Id of the associated device data model. type: string integrationId: description: Integration id for the device. type: string type: description: Type of device. maxLength: 100 minLength: 0 type: string hardwareId: description: Device hardwareId. maxLength: 100 minLength: 0 type: string reportingIntervalInSeconds: format: int32 description: Interval at which the device sends data in seconds. type: integer parentDeviceId: description: Parent device Id for this device. type: string location: $ref: '#/definitions/Location' sensorPartnerId: description: Id of the associated sensor partner. type: string readOnly: true 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 DeviceDataModel: description: DeviceDataModel API model. type: object properties: type: description: Type of device. maxLength: 100 minLength: 0 type: string manufacturer: description: Device manufacturer. maxLength: 100 minLength: 0 type: string productCode: description: Device productCode. maxLength: 100 minLength: 0 type: string ports: description: List of device ports supported. type: array items: $ref: '#/definitions/Port' sensorPartnerId: description: Id of the associated sensor partner. type: string readOnly: true 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 DeviceDataModelListResponse: 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/DeviceDataModel' 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 DeviceListResponse: 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/Device' 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 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' ErrorForLocation: description: Model for error information for a failed location. type: object properties: location: $ref: '#/definitions/WeatherLocation' code: format: int32 description: Status code returned by data provider. type: integer description: description: Description of the error. type: string retryable: description: >- Flag suggesting if retry attempt with same request body should be made to fetch required data. type: boolean 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 Farm: description: Schema of farm resource. type: object properties: partyId: description: Party Id. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 FarmEquipment: description: Schema of FarmEquipment resource. type: object properties: cropIds: description: "The IDs of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct." uniqueItems: true type: array items: type: string reference: $ref: '#/definitions/Reference' brand: description: Commercial brand of the chemical product. type: string series: description: Series number of the Farm Equipment. type: string model: description: Model number of the Farm Equipment. type: string serial: description: Serial number of the Farm Equipment. type: string type: description: Type of the Farm Equipment (Tiller, Sower, harvester, Sprayer, …). type: string ownership: description: Owned, rented, shared, etc. type: string location: description: Area where the equipment is used. type: string company: $ref: '#/definitions/Company' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 FarmEquipmentListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/FarmEquipment' 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 FarmListResponse: 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/Farm' 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 FarmOperationDataIngestionJob: description: Schema of farm operation data ingestion job. required: - authProviderId - partyId - providerInput - startYear type: object properties: partyId: description: Party Id. minLength: 1 type: string authProviderId: description: Authentication provider Id. minLength: 1 type: string operations: description: >- List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. type: array items: type: string startYear: format: int32 description: Start Year (Minimum = 2000, Maximum = CurrentYear). type: integer isIncremental: description: Use this to pull only the incremental changes from the last run. default: false type: boolean providerInput: $ref: '#/definitions/FarmOperationJobProviderInput' id: description: Unique job id. type: string readOnly: true status: description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'." type: string readOnly: 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 FarmOperationJobProviderInput: description: Schema for provider input for Farm operations job. required: - shapeResolution - shapeType type: object properties: shapeType: description: "Type of shape file to be ingested from JohnDeere.\r\nPossible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile." minLength: 1 enum: - Point - Polygon - None type: string x-ms-enum: name: ShapeType modelAsString: true shapeResolution: description: "Resolution of shape file to be ingested from JohnDeere.\r\nPossible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile." minLength: 1 enum: - EachSection - EachSensor - OneHertz - None type: string x-ms-enum: name: ShapeResolution modelAsString: true Field: description: Schema of field resource. type: object properties: farmId: description: Id of the associated Farm. type: string partyId: description: Party Id. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 FieldMetaData: description: Schema of field resource. type: object properties: farmId: description: Id of the associated Farm. type: string partyId: description: Party Id. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 FieldMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/FieldMetaData' 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 GeoJsonObject: description: >- GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. required: - type type: object properties: type: $ref: '#/definitions/GeoJsonObjectType' discriminator: type GeoJsonObjectType: description: GeoJSON object type. enum: - Point - Polygon - MultiPolygon type: string x-ms-enum: name: GeoJsonObjectType modelAsString: true GeoResource: description: Schema for storing resource type and resource id. type: object properties: type: description: Resource Type. enum: - Field - SeasonalField - Zone - Prescription - PlantTissueAnalysis - PlantingData - ApplicationData - HarvestData - TillageData type: string x-ms-enum: name: FarmHierarchyGeoResourceType modelAsString: true id: description: Resource Id. type: string HarvestData: description: Schema of harvest data resource. type: object properties: totalYield: $ref: '#/definitions/Measure' avgYield: $ref: '#/definitions/Measure' totalWetMass: $ref: '#/definitions/Measure' avgWetMass: $ref: '#/definitions/Measure' avgMoisture: $ref: '#/definitions/Measure' avgSpeed: $ref: '#/definitions/Measure' harvestProductDetails: description: Harvest product details. type: array items: $ref: '#/definitions/HarvestProductDetail' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 HarvestDataMetaData: description: Schema of harvest data resource. type: object properties: totalYield: $ref: '#/definitions/Measure' avgYield: $ref: '#/definitions/Measure' totalWetMass: $ref: '#/definitions/Measure' avgWetMass: $ref: '#/definitions/Measure' avgMoisture: $ref: '#/definitions/Measure' avgSpeed: $ref: '#/definitions/Measure' harvestProductDetails: description: Harvest product details. type: array items: $ref: '#/definitions/HarvestProductDetail' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 HarvestDataMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/HarvestDataMetaData' 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 HarvestProductDetail: description: Schema of product used during harvesting. type: object properties: productName: description: Name of the product. maxLength: 100 minLength: 1 type: string area: $ref: '#/definitions/Measure' totalYield: $ref: '#/definitions/Measure' avgYield: $ref: '#/definitions/Measure' avgMoisture: $ref: '#/definitions/Measure' totalWetMass: $ref: '#/definitions/Measure' avgWetMass: $ref: '#/definitions/Measure' ImageFile: description: Schema of image file resource. required: - name type: object properties: fileLink: description: Link of the image file. type: string name: description: Name of the image file. minLength: 1 type: string imageFormat: $ref: '#/definitions/ImageFormat' resolution: format: double description: Resolution of image file in meters. type: number ImageFormat: description: Supported image formats for scene resource. enum: - TIF type: string x-ms-enum: name: ImageFormat modelAsString: true ImageProcessingRasterizeJob: description: Image Processing Rasterize Job to convert shapefile into tiff file. required: - partyId - shapefileAttachmentId - shapefileColumnNames type: object properties: partyId: description: Party Id. minLength: 1 type: string shapefileAttachmentId: description: Shapefile attachment Id. minLength: 1 type: string shapefileColumnNames: description: List of shapefile column names to create raster attachments. type: array items: 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'." type: string readOnly: 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 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' 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 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 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 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 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: '#/definitions/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 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 IoTHubDeviceAuthentication: description: Authentication via connection string to IoTHub devices. type: object properties: primaryDeviceConnectionString: description: Primary connection string of the ioTHub device. type: string readOnly: true secondaryDeviceConnectionString: description: Secondary connection string of the ioTHub device. type: string readOnly: true KeyVaultProperties: description: Properties of the key vault. required: - keyName - keyVaultUri - keyVersion type: object properties: keyVaultUri: description: Uri of the key vault. maxLength: 100 minLength: 2 type: string keyName: description: Name of Key Vault key. maxLength: 256 minLength: 2 type: string keyVersion: description: Version of Key Vault key. maxLength: 256 minLength: 2 type: string LabDetails: description: Model for representing LabDetails object. type: object properties: code: description: Code of the resource. maxLength: 150 minLength: 0 type: string name: description: Name of the resource. maxLength: 100 minLength: 0 type: string description: description: Description of the resource. maxLength: 500 minLength: 0 type: string address: description: Address of the resource. maxLength: 500 minLength: 0 type: string Location: description: Location model class. required: - latitude - longitude type: object properties: latitude: format: double description: Latitude of the location. maximum: 90 minimum: -90 type: number longitude: format: double description: Longitude of the location. maximum: 180 minimum: -180 type: number ManagementZone: description: Api Model for ManagementZone object. type: object properties: partyId: description: Party Id associated with the ManagementZone. type: string readOnly: true type: description: Type of the ManagementZone. maxLength: 100 minLength: 0 type: string seasonId: description: Season Id associated with the ManagementZone. type: string cropId: description: Crop Id associated with the ManagementZone. type: string fieldId: description: Field Id associated with the ManagementZone. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ManagementZoneListResponse: 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/ManagementZone' 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 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 Measures: description: Schema for storing measurement readings and unit. type: object properties: unit: description: Data unit. maxLength: 50 minLength: 1 type: string value: description: Data values. type: array items: format: double type: number MultiPolygon: description: MultiPolygon geometry. type: object allOf: - $ref: '#/definitions/GeoJsonObject' - required: - coordinates type: object properties: coordinates: description: "Gets or sets Coordinates of GeoJSON Object.\r\nIt must be an array of polygons, each polygon contains list of linear rings.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings." minItems: 1 type: array items: type: array items: type: array items: type: array items: format: double type: number x-ms-discriminator-value: MultiPolygon NutrientAnalysis: description: Api Model for nutrient analysis object. type: object properties: partyId: description: Party id for this nutrient analysis. type: string readOnly: true parentId: description: Parent id for this nutrient analysis. type: string parentType: description: "Parent type for this nutrient analysis.\r\ni.e. PlantTissueAnalysis." enum: - PlantTissueAnalysis type: string x-ms-enum: name: NutrientAnalysisParentType modelAsString: true unit: description: Unit for this nutrient analysis. maxLength: 32 minLength: 0 type: string value: format: double description: Value for this nutrient analysis. type: number referenceValueLow: format: double description: Reference value low for this nutrient analysis. type: number referenceValueHigh: format: double description: Reference value high for this nutrient analysis. type: number classification: description: Classification for this nutrient analysis. maxLength: 50 minLength: 0 type: string recommendation: description: Recommendation for this nutrient analysis. maxLength: 1000 minLength: 0 type: string products: description: Products for this nutrient analysis. type: array items: $ref: '#/definitions/ProductDetails' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 NutrientAnalysisListResponse: 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/NutrientAnalysis' 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 OAuthClientCredentials: description: OAuthClientCredentials for clientId clientSecret auth. type: object allOf: - $ref: '#/definitions/AuthCredentials' - required: - clientId - clientSecret type: object properties: clientId: description: ClientId associated with the provider. minLength: 1 type: string clientSecret: $ref: '#/definitions/KeyVaultProperties' x-ms-discriminator-value: OAuthClientCredentials OAuthConnectRequest: description: Get OAuth config query parameters. required: - oAuthProviderId - partyId - userRedirectLink type: object properties: partyId: description: Id of the party. minLength: 1 type: string oAuthProviderId: description: Id of the OAuthProvider. minLength: 1 type: string userRedirectLink: description: Link to redirect the user to, at the end of the oauth flow. maxLength: 1000 minLength: 0 type: string userRedirectState: description: >- State to provide back when redirecting the user, at the end of the oauth flow. maxLength: 200 minLength: 0 type: string OAuthProvider: description: Schema of OAuth provider resource. type: object properties: appId: description: OAuth App Id for given OAuth Provider. maxLength: 200 minLength: 2 type: string appSecret: description: "OAuth App secret for given Provider.\r\nNote: Won't be sent in response." maxLength: 200 minLength: 2 type: string apiKey: description: "OAuth Api key for given Provider.\r\nNote: currently Applicable to Climate provider. Won't be sent in response." maxLength: 200 minLength: 2 type: string isProductionApp: description: "An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)\r\nNote: Currently applicable for JohnDeere." default: false type: boolean id: description: Unique OAuth provider ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true 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' 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 OAuthProviderCascadeDeleteJob: description: Schema of oauth provider cascade delete job. required: - oauthProviderId type: object properties: oauthProviderId: description: The id of the oauth provider. 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'." type: string readOnly: 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 OAuthProviderListResponse: 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/OAuthProvider' 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 OAuthToken: description: Schema of OAuth token resource. required: - authProviderId - partyId type: object properties: partyId: description: Party ID for this OAuth config. type: string authProviderId: description: ID of the OAuth provider resource containing app information. minLength: 1 type: string isValid: description: >- An optional flag indicating whether the token is a valid or expired (Default value: true). default: true type: boolean eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true 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' OAuthTokenListResponse: 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/OAuthToken' 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 OverlapResource: description: Schema of overlap resource. required: - partyId - resourceId - resourceType type: object properties: partyId: description: Party Id of the resource. minLength: 1 type: string resourceType: description: Resource type of the resource. minLength: 1 type: string resourceId: description: Id of the resource. minLength: 1 type: string resourceArea: format: double description: Acreage of the resource. type: number readOnly: true OverlapResourcesQuery: description: Overlap Resource Query Parameters. type: object properties: resources: description: List of resources. maxItems: 2 minItems: 2 type: array items: $ref: '#/definitions/OverlapResource' Party: description: Schema of party resource. type: object properties: id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PartyListResponse: 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/Party' 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 PartyOverlapResponse: description: Schema of Party Overlap Response. type: object properties: resources: description: Resources with area. maxItems: 2 minItems: 2 type: array items: $ref: '#/definitions/OverlapResource' overlappingArea: format: double description: Acreage of overlapping area. type: number PlantTissueAnalysis: description: Api Model for plant tissue analysis object. type: object properties: partyId: description: Id of the associated Party. type: string readOnly: true fieldId: description: Id of the associated Field. type: string cropId: description: Id of the associated Crop. type: string cropProductId: description: Id of the associated Crop product. type: string seasonId: description: Id of the associated Season. type: string plantingDateTime: format: date-time description: Planting datetime for this plant tissue analysis. type: string growthStage: description: Growth stage for this plant tissue analysis. maxLength: 200 minLength: 0 type: string plantPart: description: Plant part for this plant tissue analysis. maxLength: 200 minLength: 0 type: string plantPosition: description: Plant position for this plant tissue analysis. maxLength: 200 minLength: 0 type: string plantAppearance: description: Plant appearance for this plant tissue analysis. maxLength: 500 minLength: 0 type: string sampleCollectionCondition: description: Sample collection condition for this plant tissue analysis. maxLength: 500 minLength: 0 type: string sampleCollectionDateTime: format: date-time description: Sample collection dateTime for this plant tissue analysis. type: string sampleReceivedDateTime: format: date-time description: Sample received dateTime. type: string sampleTestResultDateTime: format: date-time description: Sample test result dateTime for this plant tissue analysis. type: string labDetails: $ref: '#/definitions/LabDetails' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PlantTissueAnalysisMetaData: description: Api Model for plant tissue analysis object. type: object properties: partyId: description: Id of the associated Party. type: string readOnly: true fieldId: description: Id of the associated Field. type: string cropId: description: Id of the associated Crop. type: string cropProductId: description: Id of the associated Crop product. type: string seasonId: description: Id of the associated Season. type: string plantingDateTime: format: date-time description: Planting datetime for this plant tissue analysis. type: string growthStage: description: Growth stage for this plant tissue analysis. maxLength: 200 minLength: 0 type: string plantPart: description: Plant part for this plant tissue analysis. maxLength: 200 minLength: 0 type: string plantPosition: description: Plant position for this plant tissue analysis. maxLength: 200 minLength: 0 type: string plantAppearance: description: Plant appearance for this plant tissue analysis. maxLength: 500 minLength: 0 type: string sampleCollectionCondition: description: Sample collection condition for this plant tissue analysis. maxLength: 500 minLength: 0 type: string sampleCollectionDateTime: format: date-time description: Sample collection dateTime for this plant tissue analysis. type: string sampleReceivedDateTime: format: date-time description: Sample received dateTime. type: string sampleTestResultDateTime: format: date-time description: Sample test result dateTime for this plant tissue analysis. type: string labDetails: $ref: '#/definitions/LabDetails' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PlantTissueAnalysisMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/PlantTissueAnalysisMetaData' 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 PlantingData: description: Schema of planting data resource. type: object properties: avgPlantingRate: $ref: '#/definitions/Measure' totalMaterial: $ref: '#/definitions/Measure' avgMaterial: $ref: '#/definitions/Measure' plantingProductDetails: description: Planting product details. type: array items: $ref: '#/definitions/PlantingProductDetail' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PlantingDataMetaData: description: Schema of planting data resource. type: object properties: avgPlantingRate: $ref: '#/definitions/Measure' totalMaterial: $ref: '#/definitions/Measure' avgMaterial: $ref: '#/definitions/Measure' plantingProductDetails: description: Planting product details. type: array items: $ref: '#/definitions/PlantingProductDetail' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PlantingDataMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/PlantingDataMetaData' 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 PlantingProductDetail: description: Schema for Planting product detail. type: object properties: productName: description: Name of the product. type: string area: $ref: '#/definitions/Measure' totalMaterial: $ref: '#/definitions/Measure' avgMaterial: $ref: '#/definitions/Measure' Point: description: Point geometry. type: object allOf: - $ref: '#/definitions/GeoJsonObject' - required: - coordinates type: object properties: coordinates: description: "Gets or sets the coordinate of this point.\r\nIt must be an array of 2 or 3 elements for a 2D or 3D system." maximum: 3 minimum: 2 type: array items: format: double type: number x-ms-discriminator-value: Point Polygon: description: Polygon geometry. type: object allOf: - $ref: '#/definitions/GeoJsonObject' - required: - coordinates type: object properties: coordinates: description: "Gets or sets type of the GeoJSON Object.\r\nIt must be an array of linear ring coordinate arrays.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings." minItems: 1 type: array items: type: array items: type: array items: format: double type: number x-ms-discriminator-value: Polygon Port: description: Schema for storing port values. type: object properties: name: description: Name of the port. maxLength: 50 minLength: 1 type: string type: description: Type of port digital/analog. maxLength: 100 minLength: 0 type: string Prescription: description: Api Model for Prescription object. type: object properties: partyId: description: Party Id. type: string readOnly: true prescriptionMapId: description: Prescription map Id. type: string productCode: description: Product Code. maxLength: 100 minLength: 0 type: string productName: description: Product name. maxLength: 100 minLength: 0 type: string type: description: Prescription type. maxLength: 100 minLength: 0 type: string measurements: description: Measures. type: object additionalProperties: $ref: '#/definitions/Measure' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PrescriptionMap: description: Api Model for Prescription Map object. type: object properties: partyId: description: Party Id. type: string readOnly: true type: description: Prescription map type. maxLength: 100 minLength: 0 type: string seasonId: description: Season Id. type: string cropId: description: Crop Id. type: string fieldId: description: Field Id. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PrescriptionMapListResponse: 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/PrescriptionMap' 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 PrescriptionMetaData: description: Api Model for Prescription object. type: object properties: partyId: description: Party Id. type: string readOnly: true prescriptionMapId: description: Prescription map Id. type: string productCode: description: Product Code. maxLength: 100 minLength: 0 type: string productName: description: Product name. maxLength: 100 minLength: 0 type: string type: description: Prescription type. maxLength: 100 minLength: 0 type: string measurements: description: Measures. type: object additionalProperties: $ref: '#/definitions/Measure' id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 PrescriptionMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/PrescriptionMetaData' 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 ProductDetails: description: Model for representing ProductDetails object. type: object properties: rate: description: Rate of the product. maxLength: 100 minLength: 0 type: string instruction: description: Instruction of the resource. maxLength: 1000 minLength: 0 type: string product: description: Product of the resource. maxLength: 100 minLength: 0 type: string Reference: description: Reference to a dataset record. type: object properties: datasetId: description: Dataset id. maxLength: 100 minLength: 0 type: string recordId: description: Record id. maxLength: 100 minLength: 0 type: string RelativeMaturityMeasure: description: Relative maturity measure. type: object properties: unit: description: Data unit. maxLength: 50 minLength: 1 type: string value: format: double description: Data value. type: number method: description: "The method used to determine the relative maturity of the product. Examples include\r\nComparative Relative Maturity or Heat Units." maxLength: 50 minLength: 1 type: string SatelliteData: description: Data Model for SatelliteIngestionJobRequest. type: object properties: imageNames: description: List of ImageNames. type: array items: type: string example: - NDVI imageFormats: description: 'List of ImageFormats. Available value: TIF.' type: array items: type: string example: - TIF imageResolutions: description: 'List of ImageResolutions in meters. Available values: 10, 20, 60.' type: array items: format: double type: number example: - 10 SatelliteDataIngestionJob: description: Schema of satellite data ingestion job. required: - associatedResource - collection - partyId type: object properties: credentials: $ref: '#/definitions/OAuthClientCredentials' partyId: description: Party Id. minLength: 1 type: string associatedResource: $ref: '#/definitions/GeoResource' startDateTime: format: date-time description: Start Date. type: string endDateTime: format: date-time description: End Date. type: string provider: description: 'Provider of satellite data. Available Value: SentinelHub.' enum: - SentinelHub type: string x-ms-enum: name: SatelliteDataProvider modelAsString: true collection: description: >- Collection of satellite data. Available Value: sentinel-2-l2a, sentinel-2-l1c. minLength: 1 type: string data: $ref: '#/definitions/SatelliteData' itemId: description: Item Id used to get scenes from sentinel hub. 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'." type: string readOnly: 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 Scene: description: Schema of scene resource. type: object properties: sceneDateTime: format: date-time description: 'Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string provider: description: Data provider of the scene. maxLength: 100 minLength: 2 type: string collection: description: Data collection of the scene. maxLength: 100 minLength: 2 type: string imageFiles: description: Collection of image files. type: array items: $ref: '#/definitions/ImageFile' imageFormat: $ref: '#/definitions/ImageFormat' itemId: description: ItemId to fetch scenes from sentinel hub. type: string cloudCoverPercentage: format: double description: Cloud cover percentage of the scene. maximum: 100 minimum: 0 type: number darkPixelPercentage: format: double description: Dark pixel percentage of the scene. maximum: 100 minimum: 0 type: number ndviMedianValue: format: double description: Median of NDVI of the scene. maximum: 1 minimum: 0 type: number partyId: description: Party ID which belongs to the scene. type: string id: description: Unique scene resource ID. type: string eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true associatedResource: $ref: '#/definitions/GeoResource' SceneListResponse: 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/Scene' 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 SearchApplicationDataQuery: description: SearchApplicationDataQuery. type: object properties: minAvgMaterial: format: double description: >- Minimum average amount of material applied during the application (inclusive). type: number maxAvgMaterial: format: double description: >- Maximum average amount of material applied during the application (inclusive). type: number minTotalMaterial: format: double description: >- Minimum total amount of material applied during the application (inclusive). type: number maxTotalMaterial: format: double description: >- Maximum total amount of material applied during the application (inclusive). type: number associatedResourceIds: description: Resource Ids of the resource. type: array items: type: string associatedResourceType: description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." type: string minOperationStartDateTime: format: date-time description: >- Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationStartDateTime: format: date-time description: >- Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationEndDateTime: format: date-time description: >- Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationEndDateTime: format: date-time description: >- Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationModifiedDateTime: format: date-time description: >- Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationModifiedDateTime: format: date-time description: >- Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string sources: description: Sources of the operation data. type: array items: type: string minArea: format: double description: Minimum acreage of the boundary (inclusive). type: number maxArea: format: double description: Maximum acreage of the boundary (inclusive). type: number ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchFieldQuery: description: SearchAllBoundaries and SearchBoundaries parameters. type: object properties: farmIds: description: FarmIds of the resource. type: array items: type: string ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchHarvestDataQuery: description: SearchHarvestDataQuery. type: object properties: minTotalYield: format: double description: Minimum Yield value(inclusive). type: number maxTotalYield: format: double description: Maximum Yield value (inclusive). type: number minAvgYield: format: double description: Minimum AvgYield value(inclusive). type: number maxAvgYield: format: double description: Maximum AvgYield value (inclusive). type: number minTotalWetMass: format: double description: Minimum Total WetMass value(inclusive). type: number maxTotalWetMass: format: double description: Maximum Total WetMass value (inclusive). type: number minAvgWetMass: format: double description: Minimum AvgWetMass value(inclusive). type: number maxAvgWetMass: format: double description: Maximum AvgWetMass value (inclusive). type: number minAvgMoisture: format: double description: Minimum AvgMoisture value(inclusive). type: number maxAvgMoisture: format: double description: Maximum AvgMoisture value (inclusive). type: number minAvgSpeed: format: double description: Minimum AvgSpeed value(inclusive). type: number maxAvgSpeed: format: double description: Maximum AvgSpeed value (inclusive). type: number associatedResourceIds: description: Resource Ids of the resource. type: array items: type: string associatedResourceType: description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." type: string minOperationStartDateTime: format: date-time description: >- Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationStartDateTime: format: date-time description: >- Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationEndDateTime: format: date-time description: >- Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationEndDateTime: format: date-time description: >- Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationModifiedDateTime: format: date-time description: >- Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationModifiedDateTime: format: date-time description: >- Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string sources: description: Sources of the operation data. type: array items: type: string minArea: format: double description: Minimum acreage of the boundary (inclusive). type: number maxArea: format: double description: Maximum acreage of the boundary (inclusive). type: number ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchItemsQuery: description: Search stac Items parameters. required: - endDateTime - startDateTime type: object properties: credentials: $ref: '#/definitions/OAuthClientCredentials' startDateTime: format: date-time description: Start datetime of the time interval in which to search for Items. type: string endDateTime: format: date-time description: End datetime of the time interval in which to search for Items. type: string intersects: $ref: '#/definitions/GeoJsonObject' bbox: description: "Only items that have a geometry that intersects the bounding box are selected.\r\nThe bounding box is provided as four numbers. The coordinate reference system of the values is WGS84 longitude/latitude." type: array items: format: double type: number itemIds: description: Array of item ids to return. type: array items: type: string SearchItemsResponse: description: >- Paged response contains list of items and next property to get the next set of results. required: - items type: object properties: items: description: List of items. type: array items: $ref: '#/definitions/StacItem' nextLink: description: "URL to do the POST request with same filters,\r\nto get next set of items." type: string readOnly: true SearchPlantTissueAnalysisQuery: description: Search All PlantTissueAnalysis and Search PlantTissueAnalyses parameters. type: object properties: fieldIds: description: Field Ids of the resource. type: array items: type: string seasonIds: description: Season Ids of the resource. type: array items: type: string cropProductIds: description: CropVariety Ids of the resource. type: array items: type: string cropIds: description: CropIds of the resource. type: array items: type: string ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchPlantingDataQuery: description: SearchPlantingDataQuery. type: object properties: minAvgPlantingRate: format: double description: Minimum AvgPlantingRate value(inclusive). type: number maxAvgPlantingRate: format: double description: Maximum AvgPlantingRate value (inclusive). type: number minTotalMaterial: format: double description: Minimum TotalMaterial value(inclusive). type: number maxTotalMaterial: format: double description: Maximum TotalMaterial value (inclusive). type: number minAvgMaterial: format: double description: Minimum AvgMaterial value(inclusive). type: number maxAvgMaterial: format: double description: Maximum AvgMaterial value (inclusive). type: number associatedResourceIds: description: Resource Ids of the resource. type: array items: type: string associatedResourceType: description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." type: string minOperationStartDateTime: format: date-time description: >- Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationStartDateTime: format: date-time description: >- Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationEndDateTime: format: date-time description: >- Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationEndDateTime: format: date-time description: >- Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationModifiedDateTime: format: date-time description: >- Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationModifiedDateTime: format: date-time description: >- Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string sources: description: Sources of the operation data. type: array items: type: string minArea: format: double description: Minimum acreage of the boundary (inclusive). type: number maxArea: format: double description: Maximum acreage of the boundary (inclusive). type: number ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchPrescriptionQuery: description: Get Zones query parameters. type: object properties: prescriptionMapIds: description: Prescription Map Ids of the resource. type: array items: type: string types: description: Types of the resource. type: array items: type: string productCodes: description: Product Codes of the resource. type: array items: type: string productNames: description: Product Names of the resource. type: array items: type: string sources: description: Sources of the resource. type: array items: type: string ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchSeasonalFieldQuery: description: SearchAllBoundaries and SearchBoundaries parameters. type: object properties: farmIds: description: FarmIds of the resource. type: array items: type: string fieldIds: description: FieldIds of the resource. type: array items: type: string seasonIds: description: SeasonIds of the resource. type: array items: type: string cropProductIds: description: CropProductIds of the resource. type: array items: type: string cropIds: description: CropIds of the resource. type: array items: type: string ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchTillageDataQuery: description: SearchTillageDataQuery. type: object properties: minTillageDepth: format: double description: Minimum measured tillage depth (inclusive). type: number maxTillageDepth: format: double description: Maximum measured tillage depth (inclusive). type: number minTillagePressure: format: double description: Minimum pressure applied to a tillage implement (inclusive). type: number maxTillagePressure: format: double description: Maximum pressure applied to a tillage implement (inclusive). type: number associatedResourceIds: description: Resource Ids of the resource. type: array items: type: string associatedResourceType: description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." type: string minOperationStartDateTime: format: date-time description: >- Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationStartDateTime: format: date-time description: >- Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationEndDateTime: format: date-time description: >- Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationEndDateTime: format: date-time description: >- Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string minOperationModifiedDateTime: format: date-time description: >- Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string maxOperationModifiedDateTime: format: date-time description: >- Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). type: string sources: description: Sources of the operation data. type: array items: type: string minArea: format: double description: Minimum acreage of the boundary (inclusive). type: number maxArea: format: double description: Maximum acreage of the boundary (inclusive). type: number ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string SearchZoneQuery: description: Get Zones query parameters. type: object properties: types: description: Types of the Zones. type: array items: type: string managementZoneIds: description: ManagementZoneIds of the Zones. type: array items: type: string sources: description: Sources of the Zones. type: array items: type: string ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string Season: description: Schema of season resource. type: object properties: startDateTime: format: date-time description: 'Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string endDateTime: format: date-time description: 'Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string year: format: int32 description: Season year. type: integer geographicIdentifier: description: Geographic Identifier. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 SeasonListResponse: 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/Season' 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 SeasonalField: description: Schema of seasonal field resource. required: - farmId type: object properties: partyId: description: Party Id. type: string readOnly: true farmId: description: Id of the associated Farm. minLength: 1 type: string fieldId: description: Id of the associated Field. type: string seasonId: description: Id of the season it belongs to. type: string cropProductIds: description: CropProduct ids. uniqueItems: true type: array items: type: string cropId: description: Id of the crop it belongs to. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 SeasonalFieldMetaData: description: Schema of seasonal field resource. type: object properties: partyId: description: Party Id. type: string readOnly: true farmId: description: Id of the associated Farm. type: string fieldId: description: Id of the associated Field. type: string seasonId: description: Id of the season it belongs to. type: string cropProductIds: description: CropProduct ids. uniqueItems: true type: array items: type: string cropId: description: Id of the crop it belongs to. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 SeasonalFieldMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/SeasonalFieldMetaData' 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 Sensor: description: Sensor API model. type: object properties: sensorDataModelId: description: Id of the associated sensor data model. type: string integrationId: description: Integration id for the device. type: string hardwareId: description: Id of the associated hardware. type: string deviceId: description: Id of the associated device. type: string type: description: Type of sensor. maxLength: 100 minLength: 0 type: string location: $ref: '#/definitions/Location' port: $ref: '#/definitions/Port' depthInMeters: description: "Depth of each sensor measure in meters.\r\nLike sensor moisture at 2m, 4m, 6m." type: array items: format: double type: number sensorPartnerId: description: Id of the associated sensor partner. type: string readOnly: true 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 SensorDataModel: description: SensorModel API model. required: - measures type: object properties: type: description: Type of sensor. maxLength: 100 minLength: 0 type: string manufacturer: description: Sensor manufacturer. maxLength: 100 minLength: 0 type: string productCode: description: Sensor productCode. maxLength: 100 minLength: 0 type: string measures: description: Map of sensor type to sensor measures. type: object additionalProperties: $ref: '#/definitions/SensorDataModelMeasure' sensorPartnerId: description: Id of the associated sensor partner. type: string readOnly: true 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 SensorDataModelListResponse: 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/SensorDataModel' 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 SensorDataModelMeasure: description: Sensor model measure details. required: - dataType type: object properties: description: description: Description of sensor measure. maxLength: 500 minLength: 0 type: string dataType: description: Sensor measure data type. maxLength: 100 minLength: 2 enum: - Bool - Double - DateTime - Long - String type: string x-ms-enum: name: SensorDataType modelAsString: true type: description: Measurement type of sensor data. maxLength: 100 minLength: 0 type: string unit: description: Unit of sensor measure. maxLength: 100 minLength: 0 type: string properties: description: "A collection of key value pairs for sensor data model.\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 model and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} x-ms-mutability: - read - create - update SensorEvent: description: Sensor event response model. type: object properties: sensorId: description: Id of the sensor. type: string sensorPartnerId: description: Id of the sensor partner. type: string partyId: description: Id of the associated party. type: string associatedResource: $ref: '#/definitions/GeoResource' eventDateTime: format: date-time description: DateTime of sensor event observation. type: string ingestionDateTime: format: date-time description: DateTime of sensor event ingestion to data store. type: string measures: description: Sensor measures. type: object additionalProperties: {} SensorEventListResponse: description: >- Paged response contains list of requested objects and a URL link to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/SensorEvent' skipToken: description: >- Token used in retrieving the next page. If null, there are no additional pages. type: string nextLink: description: >- Continuation link (absolute URI) to the next page of results in the list. type: string SensorListResponse: 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/Sensor' 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 SensorMapping: description: SensorMapping API model. required: - associatedResource type: object properties: sensorId: description: Id of the associated sensor. type: string sensorPartnerId: description: Id of the associated sensor partner. type: string partyId: description: Id of the associated party. type: string associatedResource: $ref: '#/definitions/GeoResource' 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 SensorMappingListResponse: 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/SensorMapping' 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 SensorPartnerIntegrationCheckConsentResponse: description: Sensor partner integration check consent response. type: object properties: consented: description: Flag to determine the status of partner integration consent. type: boolean sensorPartnerId: description: Id of the associated sensor partner. type: string readOnly: true integrationId: description: Id of the integration. type: string readOnly: true SensorPartnerIntegrationGenerateConsentLinkResponse: description: Sensor partner integration generate consent link response. type: object properties: consentLink: description: Consent link. type: string readOnly: true consentExpiryDateTime: format: date-time description: 'Consent expiry date time, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string SensorPartnerIntegrationModel: description: Sensor partner integration model. type: object properties: integrationId: description: Id of the integration. type: string readOnly: true partyId: description: Id of the party. type: string sensorPartnerId: description: Id of the associated sensor partner. type: string readOnly: true 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 SensorPartnerIntegrationModelListResponse: 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/SensorPartnerIntegrationModel' 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 SensorRenewConnectionStringModel: description: Model for renewing sensor's connection string. required: - connectionStringType type: object properties: connectionStringType: description: >- Specifies the type of connection string key to be renewed valid values - Primary/Secondary/Both. maxLength: 100 minLength: 0 enum: - Primary - Secondary - Both type: string x-ms-enum: name: RenewConnectionStringType modelAsString: true SoilMoistureModelSensorDefinition: description: Schema for storing sensor definition keywords. required: - maxProperty - minProperty - sensorMeasurement type: object properties: sensorMeasurement: description: The measurement name for sensor measure in sensorDataModel. minLength: 1 type: string minProperty: description: The measurement name for minimum measurement value. minLength: 1 type: string maxProperty: description: The measurement name for maximum measurement value. minLength: 1 type: string SolutionInference: description: SolutionInference request model. required: - requestPath type: object properties: requestPath: description: "RequestPath containing the api-version, query parameters and path route to be called for partner request.\r\nExpected format is \"/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1\".\r\nNot following this format may result into validation errors." minLength: 1 type: string partnerRequestBody: description: >- Api input parameters required by partner to trigger/cancel job request. type: object additionalProperties: {} partnerRequestHeaders: description: Additional Headers sent to partner. type: object additionalProperties: type: string StacItem: description: "Schema of STAC Item.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#item-fields." required: - assets - id - links - properties - stacVersion - type type: object properties: stacVersion: description: The STAC version the Stac Item implements. minLength: 1 type: string stacExtensions: description: A list of extensions the Stac Item implements. type: array items: type: string id: description: Provider identifier. Globally unique ID by Data provider. minLength: 1 type: string type: description: Type of the GeoJSON Object. It's value is always Feature. minLength: 1 type: string geometry: description: "Defines the full footprint of the asset represented by this item.\r\nIts a GeoJSON geometry." type: object bbox: description: Bounding box of the item. type: array items: format: double type: number properties: description: A dictionary of additional metadata for the item. type: object links: description: List of link objects to resources and related URLs. type: array items: $ref: '#/definitions/StacItemLink' assets: description: Dictionary of asset objects, each with a unique key. type: object additionalProperties: $ref: '#/definitions/StacItemAsset' collection: description: The id of the STAC Collection this Stac Item references. type: string StacItemAsset: description: "Schema of STAC Item's Asset.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#asset-object." required: - href type: object properties: href: description: Link to the asset object. minLength: 1 type: string title: description: The displayed title for clients and users. type: string description: description: >- A description of the Asset providing additional details, such as how it was processed or created. type: string type: description: Media type of the asset. type: string roles: description: The semantic roles of the asset, similar to the use of rel in links. type: array items: type: string StacItemLink: description: "The Link object describes a relationship of this Stac Item with another entity.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#link-object." required: - href - rel type: object properties: href: description: The actual link in the format of an URL. minLength: 1 type: string rel: description: Relationship between the current document and the linked document. minLength: 1 type: string type: description: Media type of the referenced entity. type: string title: description: A human readable title to be used in rendered displays of the link. type: string TillageData: description: Schema of tillage data resource. type: object properties: tillageDepth: $ref: '#/definitions/Measure' tillagePressure: $ref: '#/definitions/Measure' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 TillageDataMetaData: description: Schema of tillage data resource. type: object properties: tillageDepth: $ref: '#/definitions/Measure' tillagePressure: $ref: '#/definitions/Measure' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: >- Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: >- End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 TillageDataMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/TillageDataMetaData' 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 WeatherDataErrors: description: Model for errors encountered for all failed locations. type: object properties: locations: description: List of errors encountered for all failed locations. type: array items: $ref: '#/definitions/ErrorForLocation' WeatherDataForPassthrough: description: Schema of weather data. type: object properties: additionalAttributes: description: >- A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 250 characters. Note: A maximum of 100 key value pairs can be provided for a resource and only string and numeral values are supported. type: object additionalProperties: {} wetBulbTemperature: $ref: '#/definitions/Measures' cloudCover: $ref: '#/definitions/Measures' dayOfWeek: description: Day of week. type: array items: type: string dayOrNight: description: >- This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location. type: array items: type: string expirationTime: description: Expiration time in Utc format. type: array items: type: string iconCode: description: >- This number is the key to the weather icon lookup. The data field shows the icon number that is matched to represent the observed weather conditions. type: array items: format: int32 type: integer iconCodeExtend: description: Code representing full set sensible weather. type: array items: format: int32 type: integer hasPrecipitation: description: Indicates whether there is precipitation or not. type: array items: type: boolean pressureMeanSeaLevel: $ref: '#/definitions/Measures' relativeHumidity: $ref: '#/definitions/Measures' temperature: $ref: '#/definitions/Measures' temperatureDewPoint: $ref: '#/definitions/Measures' temperatureFeelsLike: $ref: '#/definitions/Measures' temperatureHeatIndex: $ref: '#/definitions/Measures' temperatureWindChill: $ref: '#/definitions/Measures' uvDescription: description: >- The UV Index Description which complements the UV Index value by providing an associated level of risk of skin damage due to exposure (-2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate, 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme). type: array items: type: string uvIndex: description: Hourly maximum UV index. type: array items: format: double type: number validTimeLocal: description: Time forecast is valid in local apparent time. type: array items: type: string validTime: description: Time forecast is valid in Utc format. type: array items: type: string visibility: $ref: '#/definitions/Measures' windDirection: $ref: '#/definitions/Measures' windGust: $ref: '#/definitions/Measures' windSpeed: $ref: '#/definitions/Measures' wxPhraseLong: description: Hourly sensible weather phrase containing longer description. type: array items: type: string wxPhraseShort: description: Hourly sensible weather phrase containing short description. type: array items: type: string WeatherDataProviderRequest: description: Schema of weather data provider request. required: - extensionApiName - extensionId - units type: object properties: credentials: $ref: '#/definitions/ApiKeyAuthCredentials' locations: description: >- List of locations for which weather data need to be fetched from the provider. type: array items: $ref: '#/definitions/WeatherLocation' extensionId: description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. maxLength: 100 minLength: 2 type: string extensionApiName: description: Extension api name to which request is to be made. maxLength: 100 minLength: 2 type: string language: description: >- Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'. maxLength: 100 minLength: 0 type: string startTimeHours: format: int32 description: >- Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.) maximum: 240 minimum: 0 type: integer endTimeHours: format: int32 description: End of time range. (Only applicable for DTN.ClearAg extension.) maximum: 240 minimum: 0 type: integer duration: format: int32 description: >- Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.) type: integer units: description: >- Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units. minLength: 1 type: string additionalParams: $ref: '#/definitions/AdditionalProviderParameters' WeatherDataProviderResponse: description: Schema of Weather Data Provider Response. required: - weatherMetadata type: object properties: weatherMetadata: $ref: '#/definitions/WeatherMetadata' status: description: Indicates a Succeeded, Failed, or PartiallySucceeded response. enum: - Succeeded - Failed - PartiallySucceeded type: string x-ms-enum: name: Status modelAsString: true locations: description: List of weather data for all the weather locations. type: array items: $ref: '#/definitions/WeatherLocationData' errors: $ref: '#/definitions/WeatherDataErrors' WeatherLocation: description: Schema of Location data. required: - type - value type: object properties: type: description: Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. maxLength: 25 minLength: 2 enum: - LatLong - IataCode - IcaoCode - PlaceId - PostalKey type: string x-ms-enum: name: LocationType modelAsString: true value: description: Location Value eg. "10,-25" for LocationType Type "LatLong". maxLength: 100 minLength: 2 type: string WeatherLocationData: description: Schema of WeatherLocationData data. type: object properties: location: $ref: '#/definitions/WeatherLocation' requestCompletionTime: description: Request Completion Time in Utc of the location. type: string lastRefreshedDateTime: format: date-time description: >- Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ. type: string example: '2020-12-31T11:10:21Z' data: $ref: '#/definitions/WeatherDataForPassthrough' WeatherMetadata: description: Schema of Weather Metadata. required: - extensionApiName - extensionId - extensionVersion - units - weatherDataType type: object properties: extensionVersion: description: Version of the weather data extension. minLength: 1 type: string weatherDataType: description: Type of weather data (forecast/historical). minLength: 1 type: string extensionId: description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. maxLength: 100 minLength: 2 type: string extensionApiName: description: Extension api name to which request is to be made. maxLength: 100 minLength: 2 type: string language: description: >- Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'. maxLength: 100 minLength: 0 type: string startTimeHours: format: int32 description: >- Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.) maximum: 240 minimum: 0 type: integer endTimeHours: format: int32 description: End of time range. (Only applicable for DTN.ClearAg extension.) maximum: 240 minimum: 0 type: integer duration: format: int32 description: >- Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.) type: integer units: description: >- Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units. minLength: 1 type: string additionalParams: $ref: '#/definitions/AdditionalProviderParameters' Zone: description: Api Model for Zone object. type: object properties: partyId: description: Party Id associated with the Zone. type: string readOnly: true type: description: Type of the Zone. maxLength: 100 minLength: 0 type: string managementZoneId: description: Management Zone Id associated with the Zone. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string geometry: $ref: '#/definitions/GeoJsonObject' 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ZoneMetaData: description: Api Model for Zone object. type: object properties: partyId: description: Party Id associated with the Zone. type: string readOnly: true type: description: Type of the Zone. maxLength: 100 minLength: 0 type: string managementZoneId: description: Management Zone Id associated with the Zone. type: string id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. 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' 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 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 only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ZoneMetaDataListResponse: description: >- Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/ZoneMetaData' 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 securityDefinitions: 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. security: - Bearer: [] tags: - name: ApplicationData - name: Attachments - name: ChemicalProducts - name: CropProducts - name: Crops - name: DatasetRecords - name: Datasets - name: DeviceDataModels - name: Devices - name: FarmEquipments - name: FarmOperations - name: Farms - name: Fields - name: HarvestData - name: ImageProcessing - name: InsightAttachments - name: Insights - name: ManagementZones - name: NutrientAnalyses - name: OAuthProviders - name: OAuthTokens - name: Parties - name: PlantingData - name: PlantTissueAnalyses - name: PrescriptionMaps - name: Prescriptions - name: Scenes - name: SeasonalFields - name: Seasons - name: SensorDataModels - name: SensorEvents - name: SensorMappings - name: SensorPartnerIntegrations - name: Sensors - name: SolutionInference - name: TillageData - name: WeatherData - name: Zones