From a394eccc2ce26369cacbc113cf0c3a9c9501e689 Mon Sep 17 00:00:00 2001 From: Karthik RG Date: Wed, 5 May 2021 21:41:41 +0530 Subject: [PATCH] [Hub Generated] Review request for Microsoft.AgFoodPlatform to add version preview/2021-03-31-preview (#14031) * New Swagger Spec File * New Swagger Example Spec File * New Readme Config File * AgFoodPlatform: Data plane swagger + examples (#14045) * Uploading swagger and sample example * Model validation fix attempt * Fixing example * Removing extra references to examples in swagger * Making swagger pretty * Spell check fix * Added links to examples * Added references to examples * Fixing spell check error * Fixed 2026 error * Added dummy examples * Fixing avocado errors * Seasonal Field examples added * FIx for seasonal field examples * Adding examples for all objects * Made examples prettier * Updated request body in examples * Debug effort v1 * Fixing issue in OAUthProvider example * Time: removing millis * Fixing date formats * Fixing response codes * Response code fix2 * Fixing object reference errors * Fixing pipeline * Fixed examples related errors * Fixing more errors * Down to 6 errors * Fixing errors * Fixing errors * Fixing errors * Fixin geometry related errors * Fixing boundary errros * Byte to binary * Fixing download scenes error * Trying fix for multipart-form * Fixing duration in seconds Co-authored-by: Karthik RG Co-authored-by: Agnivesh Adhikari * Farmbeats Swagger (#14203) * big bang * shapefile and rasterize are words * adding back readme * another copy pasta from v2 * FarmBeats adding examples for rasterize (#14216) * Adding examples for rasterize jobs * Marking rasterize job as LRO * LongRunningResponseStatusCode suppression * [FarmBeats] Use `x-ms-parameterized-host` (#14246) Use the `x-ms-parameterized-host` pattern, which our code generators understand and generate better code for. Co-authored-by: Karthik RG Co-authored-by: Agnivesh Adhikari Co-authored-by: Laurent Mazuel Co-authored-by: Matt Ellis --- custom-words.txt | 6 +- .../preview/2021-03-31-preview/agfood.json | 11757 ++++++++++++++++ .../ApplicationData_CreateOrUpdate.json | 149 + .../examples/ApplicationData_Delete.json | 11 + .../examples/ApplicationData_Get.json | 59 + .../examples/ApplicationData_List.json | 63 + .../ApplicationData_ListByFarmerId.json | 64 + .../examples/Attachments_CreateOrUpdate.json | 41 + .../examples/Attachments_Delete.json | 11 + .../examples/Attachments_Download.json | 13 + .../examples/Attachments_Get.json | 25 + .../examples/Attachments_ListByFarmerId.json | 30 + .../Boundaries_CreateCascadeDeleteJob.json | 32 + .../examples/Boundaries_CreateOrUpdate.json | 137 + .../examples/Boundaries_Delete.json | 11 + .../examples/Boundaries_Get.json | 53 + ...Boundaries_GetCascadeDeleteJobDetails.json | 30 + .../examples/Boundaries_GetOverlap.json | 19 + .../examples/Boundaries_List.json | 57 + .../examples/Boundaries_ListByFarmerId.json | 58 + .../examples/Boundaries_Search.json | 111 + .../examples/Boundaries_SearchByFarmerId.json | 112 + .../CropVarieties_CreateOrUpdate.json | 57 + .../examples/CropVarieties_Delete.json | 11 + .../examples/CropVarieties_Get.json | 28 + .../examples/CropVarieties_List.json | 32 + .../examples/CropVarieties_ListByCropId.json | 33 + .../examples/Crops_CreateOrUpdate.json | 51 + .../examples/Crops_Delete.json | 10 + .../examples/Crops_Get.json | 25 + .../examples/Crops_List.json | 30 + ...FarmOperations_CreateDataIngestionJob.json | 45 + ...Operations_GetDataIngestionJobDetails.json | 32 + .../Farmers_CreateCascadeDeleteJob.json | 31 + .../examples/Farmers_CreateOrUpdate.json | 48 + .../examples/Farmers_Delete.json | 10 + .../examples/Farmers_Get.json | 24 + .../Farmers_GetCascadeDeleteJobDetails.json | 30 + .../examples/Farmers_List.json | 29 + .../Farms_CreateCascadeDeleteJob.json | 32 + .../examples/Farms_CreateOrUpdate.json | 51 + .../examples/Farms_Delete.json | 11 + .../examples/Farms_Get.json | 26 + .../Farms_GetCascadeDeleteJobDetails.json | 30 + .../examples/Farms_List.json | 30 + .../examples/Farms_ListByFarmerId.json | 31 + .../Fields_CreateCascadeDeleteJob.json | 32 + .../examples/Fields_CreateOrUpdate.json | 64 + .../examples/Fields_Delete.json | 11 + .../examples/Fields_Get.json | 32 + .../Fields_GetCascadeDeleteJobDetails.json | 30 + .../examples/Fields_List.json | 36 + .../examples/Fields_ListByFarmerId.json | 37 + .../examples/HarvestData_CreateOrUpdate.json | 242 + .../examples/HarvestData_Delete.json | 11 + .../examples/HarvestData_Get.json | 90 + .../examples/HarvestData_List.json | 94 + .../examples/HarvestData_ListByFarmerId.json | 95 + .../ImageProcessing_CreateRasterizeJob.json | 45 + .../ImageProcessing_GetRasterizeJob.json | 32 + .../OAuthProviders_CreateOrUpdate.json | 54 + .../examples/OAuthProviders_Delete.json | 10 + .../examples/OAuthProviders_Get.json | 26 + .../examples/OAuthProviders_List.json | 31 + .../examples/OAuthTokens_Delete.json | 11 + .../OAuthTokens_GetOAuthConnectionLink.json | 17 + .../examples/OAuthTokens_List.json | 24 + .../examples/PlantingData_CreateOrUpdate.json | 170 + .../examples/PlantingData_Delete.json | 11 + .../examples/PlantingData_Get.json | 66 + .../examples/PlantingData_List.json | 70 + .../examples/PlantingData_ListByFarmerId.json | 71 + ...cenes_CreateSatelliteDataIngestionJob.json | 52 + .../examples/Scenes_Download.json | 12 + ...s_GetSatelliteDataIngestionJobDetails.json | 43 + .../examples/Scenes_List.json | 142 + ...SeasonalFields_CreateCascadeDeleteJob.json | 26 + .../SeasonalFields_CreateOrUpdate.json | 100 + .../examples/SeasonalFields_Delete.json | 11 + .../examples/SeasonalFields_Get.json | 44 + ...onalFields_GetCascadeDeleteJobDetails.json | 24 + .../examples/SeasonalFields_List.json | 48 + .../SeasonalFields_ListByFarmerId.json | 49 + .../examples/Seasons_CreateOrUpdate.json | 57 + .../examples/Seasons_Delete.json | 10 + .../examples/Seasons_Get.json | 27 + .../examples/Seasons_List.json | 32 + .../examples/TillageData_CreateOrUpdate.json | 107 + .../examples/TillageData_Delete.json | 11 + .../examples/TillageData_Get.json | 45 + .../examples/TillageData_List.json | 49 + .../examples/TillageData_ListByFarmerId.json | 50 + .../examples/Weather_CreateDataDeleteJob.json | 43 + .../Weather_CreateDataIngestionJob.json | 49 + .../Weather_GetDataDeleteJobDetails.json | 31 + .../Weather_GetDataIngestionJobDetails.json | 34 + .../examples/Weather_List.json | 143 + specification/agfood/data-plane/readme.md | 43 + 98 files changed, 16279 insertions(+), 1 deletion(-) create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json create mode 100644 specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json create mode 100644 specification/agfood/data-plane/readme.md diff --git a/custom-words.txt b/custom-words.txt index a7daa449c9e2..88dba0b36cfb 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1186,6 +1186,8 @@ nbformat Nccl nchar ndjson +ndvi +NDVI Neighbourhood netapp netdev @@ -1444,6 +1446,7 @@ RAGZRS randint randomnumbers Rankable +rasterize ratelimit ravbhatnagar rawwebsockets @@ -1667,6 +1670,7 @@ setvpnclientipsecparameters sfhealthid sfpkg shamir_share +shapefile sharded sharedkey sharename @@ -2166,4 +2170,4 @@ DOCM PPSX PPTM XLSM -DOCM \ No newline at end of file +DOCM diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json new file mode 100644 index 000000000000..c56b3ee5e448 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json @@ -0,0 +1,11757 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AgFoodPlatform Data Plane Service", + "description": "APIs documentation for Azure AgPlatform DataPlane Service.", + "version": "2021-03-31-preview" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "paths": { + "/farmers/{farmerId}/application-data": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Returns a paginated list of application data resources under a particular farm.", + "operationId": "ApplicationData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationData_ListByFarmerId": { + "$ref": "./examples/ApplicationData_ListByFarmerId.json" + } + } + } + }, + "/application-data": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Returns a paginated list of application data resources across all farmers.", + "operationId": "ApplicationData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationData_List": { + "$ref": "./examples/ApplicationData_List.json" + } + } + } + }, + "/farmers/{farmerId}/application-data/{applicationDataId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a specified application data resource under a particular farmer.", + "operationId": "ApplicationData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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" + } + } + }, + "x-ms-examples": { + "ApplicationData_Get": { + "$ref": "./examples/ApplicationData_Get.json" + } + } + }, + "patch": { + "tags": [ + "ApplicationData" + ], + "description": "Creates or updates an application data resource under a particular farmer.", + "operationId": "ApplicationData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "body", + "description": "Application data resource payload to create or update.", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + }, + "x-ms-examples": { + "ApplicationData_CreateOrUpdate": { + "$ref": "./examples/ApplicationData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ApplicationData" + ], + "description": "Deletes a specified application data resource under a particular farmer.", + "operationId": "ApplicationData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationData_Delete": { + "$ref": "./examples/ApplicationData_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/attachments": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Returns a paginated list of attachment resources under a particular farmer.", + "operationId": "Attachments_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Attachments_ListByFarmerId": { + "$ref": "./examples/Attachments_ListByFarmerId.json" + } + } + } + }, + "/farmers/{farmerId}/attachments/{attachmentId}": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Gets a specified attachment resource under a particular farmer.", + "operationId": "Attachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "Attachments_Get": { + "$ref": "./examples/Attachments_Get.json" + } + } + }, + "patch": { + "tags": [ + "Attachments" + ], + "description": "Creates or updates an attachment resource under a particular farmer.", + "operationId": "Attachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer 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", + "description": "File to be uploaded.", + "type": "file", + "format": "binary" + }, + { + "in": "formData", + "name": "FarmerId", + "description": "Farmer id for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "ResourceId", + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "ResourceType", + "description": "Associated Resource type for this attachment\r\ni.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData.", + "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": "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": "ETag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Attachments_CreateOrUpdate": { + "$ref": "./examples/Attachments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Attachments" + ], + "description": "Deletes a specified attachment resource under a particular farmer.", + "operationId": "Attachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Attachments_Delete": { + "$ref": "./examples/Attachments_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/attachments/{attachmentId}/file": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Downloads and returns attachment as response for the given input filePath.", + "operationId": "Attachments_Download", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "Attachments_Download": { + "$ref": "./examples/Attachments_Download.json" + } + } + } + }, + "/farmers/{farmerId}/boundaries": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Returns a paginated list of boundary resources under a particular farmer.", + "operationId": "Boundaries_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "isPrimary", + "description": "Is the boundary primary.", + "type": "boolean" + }, + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAcreage", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAcreage", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "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/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_ListByFarmerId": { + "$ref": "./examples/Boundaries_ListByFarmerId.json" + } + } + }, + "post": { + "tags": [ + "Boundaries" + ], + "description": "Search for boundaries by fields and intersecting geometry.", + "operationId": "Boundaries_SearchByFarmerId", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Query filters.", + "schema": { + "$ref": "#/definitions/SearchBoundaryQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_SearchByFarmerId": { + "$ref": "./examples/Boundaries_SearchByFarmerId.json" + } + } + } + }, + "/boundaries": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Returns a paginated list of boundary resources across all farmers.", + "operationId": "Boundaries_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "isPrimary", + "description": "Is the boundary primary.", + "type": "boolean" + }, + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAcreage", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAcreage", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "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/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_List": { + "$ref": "./examples/Boundaries_List.json" + } + } + }, + "post": { + "tags": [ + "Boundaries" + ], + "description": "Search for boundaries across all farmers by fields and intersecting geometry.", + "operationId": "Boundaries_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Query filters.", + "schema": { + "$ref": "#/definitions/SearchBoundaryQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_Search": { + "$ref": "./examples/Boundaries_Search.json" + } + } + } + }, + "/boundaries/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get cascade delete job for specified boundary.", + "operationId": "Boundaries_GetCascadeDeleteJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "Boundaries_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Boundaries_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Boundaries" + ], + "description": "Create a cascade delete job for specified boundary.", + "operationId": "Boundaries_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "ID of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "ID of the boundary to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_CreateCascadeDeleteJob": { + "$ref": "./examples/Boundaries_CreateCascadeDeleteJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/farmers/{farmerId}/boundaries/{boundaryId}": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Gets a specified boundary resource under a particular farmer.", + "operationId": "Boundaries_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "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/Boundary" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_Get": { + "$ref": "./examples/Boundaries_Get.json" + } + } + }, + "patch": { + "tags": [ + "Boundaries" + ], + "description": "Creates or updates a boundary resource.", + "operationId": "Boundaries_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Boundary resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Boundary" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_CreateOrUpdate": { + "$ref": "./examples/Boundaries_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Boundaries" + ], + "description": "Deletes a specified boundary resource under a particular farmer.", + "operationId": "Boundaries_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_Delete": { + "$ref": "./examples/Boundaries_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/boundaries/{boundaryId}/overlap": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Returns overlapping acreage between two boundary Ids.", + "operationId": "Boundaries_GetOverlap", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "otherFarmerId", + "description": "FarmerId of the other field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "otherBoundaryId", + "description": "Id of the other boundary.", + "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/BoundaryOverlapResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_GetOverlap": { + "$ref": "./examples/Boundaries_GetOverlap.json" + } + } + } + }, + "/crops": { + "get": { + "tags": [ + "Crops" + ], + "description": "Returns a paginated list of crop resources.", + "operationId": "Crops_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "phenotypes", + "description": "Crop phenotypes of 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/CropListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Crops_List": { + "$ref": "./examples/Crops_List.json" + } + } + } + }, + "/crops/{cropId}": { + "get": { + "tags": [ + "Crops" + ], + "description": "Gets a specified crop resource.", + "operationId": "Crops_Get", + "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" + } + } + }, + "x-ms-examples": { + "Crops_Get": { + "$ref": "./examples/Crops_Get.json" + } + } + }, + "patch": { + "tags": [ + "Crops" + ], + "description": "Creates or updates a crop resource.", + "operationId": "Crops_CreateOrUpdate", + "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": "body", + "description": "Crop resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Crop" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Crops_CreateOrUpdate": { + "$ref": "./examples/Crops_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Crops" + ], + "description": "Deletes Crop for given crop id.", + "operationId": "Crops_Delete", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Crops_Delete": { + "$ref": "./examples/Crops_Delete.json" + } + } + } + }, + "/crops/{cropId}/crop-varieties": { + "get": { + "tags": [ + "CropVarieties" + ], + "description": "Returns a paginated list of crop variety resources under a particular crop.", + "operationId": "CropVarieties_ListByCropId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the associated crop.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Products of 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/CropVarietyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropVarieties_ListByCropId": { + "$ref": "./examples/CropVarieties_ListByCropId.json" + } + } + } + }, + "/crop-varieties": { + "get": { + "tags": [ + "CropVarieties" + ], + "description": "Returns a paginated list of crop variety resources across all crops.", + "operationId": "CropVarieties_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Products of 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/CropVarietyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropVarieties_List": { + "$ref": "./examples/CropVarieties_List.json" + } + } + } + }, + "/crops/{cropId}/crop-varieties/{cropVarietyId}": { + "get": { + "tags": [ + "CropVarieties" + ], + "description": "Gets a specified crop variety resource under a particular crop.", + "operationId": "CropVarieties_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the associated crop.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "cropVarietyId", + "description": "Id of the crop variety.", + "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/CropVariety" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CropVarieties_Get": { + "$ref": "./examples/CropVarieties_Get.json" + } + } + }, + "patch": { + "tags": [ + "CropVarieties" + ], + "description": "Creates or updates a crop variety resource.", + "operationId": "CropVarieties_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "cropVarietyId", + "description": "Id of the crop variety resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Crop variety resource payload to create or update.", + "schema": { + "$ref": "#/definitions/CropVariety" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropVariety" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropVariety" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CropVarieties_CreateOrUpdate": { + "$ref": "./examples/CropVarieties_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "CropVarieties" + ], + "description": "Deletes a specified crop variety resource under a particular crop.", + "operationId": "CropVarieties_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "cropVarietyId", + "description": "Id of the crop variety.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CropVarieties_Delete": { + "$ref": "./examples/CropVarieties_Delete.json" + } + } + } + }, + "/farmers": { + "get": { + "tags": [ + "Farmers" + ], + "description": "Returns a paginated list of farmer resources.", + "operationId": "Farmers_List", + "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/FarmerListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farmers_List": { + "$ref": "./examples/Farmers_List.json" + } + } + } + }, + "/farmers/{farmerId}": { + "get": { + "tags": [ + "Farmers" + ], + "description": "Gets a specified farmer resource.", + "operationId": "Farmers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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/Farmer" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_Get": { + "$ref": "./examples/Farmers_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farmers" + ], + "description": "Creates or updates a farmer resource.", + "operationId": "Farmers_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Farmer resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Farmer" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farmer" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farmer" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_CreateOrUpdate": { + "$ref": "./examples/Farmers_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farmers" + ], + "description": "Deletes a specified farmer resource.", + "operationId": "Farmers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of farmer to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_Delete": { + "$ref": "./examples/Farmers_Delete.json" + } + } + } + }, + "/farmers/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Farmers" + ], + "description": "Get a cascade delete job for specified farmer.", + "operationId": "Farmers_GetCascadeDeleteJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "Farmers_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farmers_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Farmers" + ], + "description": "Create a cascade delete job for specified farmer.", + "operationId": "Farmers_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "ID of the farmer to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_CreateCascadeDeleteJob": { + "$ref": "./examples/Farmers_CreateCascadeDeleteJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/farm-operations/ingest-data/{jobId}": { + "put": { + "tags": [ + "FarmOperations" + ], + "description": "Create a farm operation data ingestion job.", + "operationId": "FarmOperations_CreateDataIngestionJob", + "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": "body", + "description": "Job parameters supplied by user.", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmOperations_CreateDataIngestionJob": { + "$ref": "./examples/FarmOperations_CreateDataIngestionJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FarmOperations" + ], + "description": "Get a farm operation data ingestion job.", + "operationId": "FarmOperations_GetDataIngestionJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "FarmOperations_GetDataIngestionJobDetails": { + "$ref": "./examples/FarmOperations_GetDataIngestionJobDetails.json" + } + } + } + }, + "/farmers/{farmerId}/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources under a particular farmer.", + "operationId": "Farms_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_ListByFarmerId": { + "$ref": "./examples/Farms_ListByFarmerId.json" + } + } + } + }, + "/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources across all farmers.", + "operationId": "Farms_List", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_List": { + "$ref": "./examples/Farms_List.json" + } + } + } + }, + "/farmers/{farmerId}/farms/{farmId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Gets a specified farm resource under a particular farmer.", + "operationId": "Farms_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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" + } + } + }, + "x-ms-examples": { + "Farms_Get": { + "$ref": "./examples/Farms_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farms" + ], + "description": "Creates or updates a farm resource under a particular farmer.", + "operationId": "Farms_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer 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": "body", + "description": "Farm resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Farm" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farms_CreateOrUpdate": { + "$ref": "./examples/Farms_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farms" + ], + "description": "Deletes a specified farm resource under a particular farmer.", + "operationId": "Farms_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farms_Delete": { + "$ref": "./examples/Farms_Delete.json" + } + } + } + }, + "/farms/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Get a cascade delete job for specified farm.", + "operationId": "Farms_GetCascadeDeleteJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "Farms_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farms_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Farms" + ], + "description": "Create a cascade delete job for specified farm.", + "operationId": "Farms_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farms_CreateCascadeDeleteJob": { + "$ref": "./examples/Farms_CreateCascadeDeleteJob.json" + } + } + } + }, + "/farmers/{farmerId}/fields": { + "get": { + "tags": [ + "Fields" + ], + "description": "Returns a paginated list of field resources under a particular farmer.", + "operationId": "Fields_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmIds", + "description": "Farm Ids of 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/FieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fields_ListByFarmerId": { + "$ref": "./examples/Fields_ListByFarmerId.json" + } + } + } + }, + "/fields": { + "get": { + "tags": [ + "Fields" + ], + "description": "Returns a paginated list of field resources across all farmers.", + "operationId": "Fields_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmIds", + "description": "Farm Ids of 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/FieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fields_List": { + "$ref": "./examples/Fields_List.json" + } + } + } + }, + "/farmers/{farmerId}/fields/{fieldId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Gets a specified field resource under a particular farmer.", + "operationId": "Fields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "Fields_Get": { + "$ref": "./examples/Fields_Get.json" + } + } + }, + "patch": { + "tags": [ + "Fields" + ], + "description": "Creates or Updates a field resource under a particular farmer.", + "operationId": "Fields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer 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": "body", + "description": "Field resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Field" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fields_CreateOrUpdate": { + "$ref": "./examples/Fields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Fields" + ], + "description": "Deletes a specified field resource under a particular farmer.", + "operationId": "Fields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fields_Delete": { + "$ref": "./examples/Fields_Delete.json" + } + } + } + }, + "/fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a cascade delete job for specified field.", + "operationId": "Fields_GetCascadeDeleteJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "Fields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Fields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Fields" + ], + "description": "Create a cascade delete job for specified field.", + "operationId": "Fields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fields_CreateCascadeDeleteJob": { + "$ref": "./examples/Fields_CreateCascadeDeleteJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/farmers/{farmerId}/harvest-data": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Returns a paginated list of harvest data resources under a particular farm.", + "operationId": "HarvestData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minTotalYield", + "description": "Minimum Yield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalYield", + "description": "Maximum Yield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgYield", + "description": "Minimum AvgYield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYield", + "description": "Maximum AvgYield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalWetMass", + "description": "Minimum Total WetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalWetMass", + "description": "Maximum Total WetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgWetMass", + "description": "Minimum AvgWetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgWetMass", + "description": "Maximum AvgWetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMoisture", + "description": "Minimum AvgMoisture value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMoisture", + "description": "Maximum AvgMoisture value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgSpeed", + "description": "Minimum AvgSpeed value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSpeed", + "description": "Maximum AvgSpeed value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HarvestData_ListByFarmerId": { + "$ref": "./examples/HarvestData_ListByFarmerId.json" + } + } + } + }, + "/harvest-data": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Returns a paginated list of harvest data resources across all farmers.", + "operationId": "HarvestData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minTotalYield", + "description": "Minimum Yield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalYield", + "description": "Maximum Yield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgYield", + "description": "Minimum AvgYield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYield", + "description": "Maximum AvgYield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalWetMass", + "description": "Minimum Total WetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalWetMass", + "description": "Maximum Total WetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgWetMass", + "description": "Minimum AvgWetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgWetMass", + "description": "Maximum AvgWetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMoisture", + "description": "Minimum AvgMoisture value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMoisture", + "description": "Maximum AvgMoisture value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgSpeed", + "description": "Minimum AvgSpeed value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSpeed", + "description": "Maximum AvgSpeed value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HarvestData_List": { + "$ref": "./examples/HarvestData_List.json" + } + } + } + }, + "/farmers/{farmerId}/harvest-data/{harvestDataId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a specified harvest data resource under a particular farmer.", + "operationId": "HarvestData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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" + } + } + }, + "x-ms-examples": { + "HarvestData_Get": { + "$ref": "./examples/HarvestData_Get.json" + } + } + }, + "patch": { + "tags": [ + "HarvestData" + ], + "description": "Creates or updates harvest data resource under a particular farmer.", + "operationId": "HarvestData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the farmer.", + "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": "body", + "description": "Harvest data resource payload to create or update.", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + }, + "x-ms-examples": { + "HarvestData_CreateOrUpdate": { + "$ref": "./examples/HarvestData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "HarvestData" + ], + "description": "Deletes a specified harvest data resource under a particular farmer.", + "operationId": "HarvestData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HarvestData_Delete": { + "$ref": "./examples/HarvestData_Delete.json" + } + } + } + }, + "/image-processing/rasterize/{jobId}": { + "put": { + "tags": [ + "ImageProcessingJob" + ], + "description": "Create a ImageProcessing Rasterize job.", + "operationId": "ImageProcessing_CreateRasterizeJob", + "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": "body", + "description": "Job parameters supplied by user.", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error" + } + }, + "x-ms-examples": { + "OAuthProviders_List": { + "$ref": "./examples/ImageProcessing_CreateRasterizeJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ImageProcessingJob" + ], + "description": "Get ImageProcessing Rasterize job's details.", + "operationId": "ImageProcessing_GetRasterizeJob", + "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" + } + } + }, + "x-ms-examples": { + "OAuthProviders_List": { + "$ref": "./examples/ImageProcessing_GetRasterizeJob.json" + } + } + } + }, + "/oauth/providers": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Returns a paginated list of oauthProvider resources.", + "operationId": "OAuthProviders_List", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthProviders_List": { + "$ref": "./examples/OAuthProviders_List.json" + } + } + } + }, + "/oauth/providers/{oauthProviderId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get a specified oauthProvider resource.", + "operationId": "OAuthProviders_Get", + "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" + } + } + }, + "x-ms-examples": { + "OAuthProviders_Get": { + "$ref": "./examples/OAuthProviders_Get.json" + } + } + }, + "patch": { + "tags": [ + "OAuthProviders" + ], + "description": "Creates or updates an oauthProvider resource.", + "operationId": "OAuthProviders_CreateOrUpdate", + "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": "body", + "description": "OauthProvider resource payload to create or update.", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthProviders_CreateOrUpdate": { + "$ref": "./examples/OAuthProviders_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OAuthProviders" + ], + "description": "Deletes an specified oauthProvider resource.", + "operationId": "OAuthProviders_Delete", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthProviders_Delete": { + "$ref": "./examples/OAuthProviders_Delete.json" + } + } + } + }, + "/oauth/tokens": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns a list of OAuthToken documents.", + "operationId": "OAuthTokens_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "authProviderIds", + "description": "Name of AuthProvider.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "farmerIds", + "description": "List of farmers.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthTokens_List": { + "$ref": "./examples/OAuthTokens_List.json" + } + } + } + }, + "/oauth/tokens/:remove": { + "post": { + "tags": [ + "OAuthTokens" + ], + "description": "Deletes OAuth Token for given oauth provider Id and farmer Id.", + "operationId": "OAuthTokens_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the associated oauth provider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthTokens_Delete": { + "$ref": "./examples/OAuthTokens_Delete.json" + } + } + } + }, + "/oauth/tokens/:connect": { + "post": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns Connection link needed in the OAuth flow.", + "operationId": "OAuthTokens_GetOAuthConnectionLink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "OAuth Connect Request.", + "schema": { + "$ref": "#/definitions/OAuthConnectRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthTokens_GetOAuthConnectionLink": { + "$ref": "./examples/OAuthTokens_GetOAuthConnectionLink.json" + } + } + } + }, + "/farmers/{farmerId}/planting-data": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Returns a paginated list of planting data resources under a particular farm.", + "operationId": "PlantingData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minAvgPlantingRate", + "description": "Minimum AvgPlantingRate value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgPlantingRate", + "description": "Maximum AvgPlantingRate value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum TotalMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum TotalMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum AvgMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum AvgMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantingData_ListByFarmerId": { + "$ref": "./examples/PlantingData_ListByFarmerId.json" + } + } + } + }, + "/planting-data": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Returns a paginated list of planting data resources across all farmers.", + "operationId": "PlantingData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minAvgPlantingRate", + "description": "Minimum AvgPlantingRate value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgPlantingRate", + "description": "Maximum AvgPlantingRate value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum TotalMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum TotalMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum AvgMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum AvgMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantingData_List": { + "$ref": "./examples/PlantingData_List.json" + } + } + } + }, + "/farmers/{farmerId}/planting-data/{plantingDataId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a specified planting data resource under a particular farmer.", + "operationId": "PlantingData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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" + } + } + }, + "x-ms-examples": { + "PlantingData_Get": { + "$ref": "./examples/PlantingData_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantingData" + ], + "description": "Creates or updates an planting data resource under a particular farmer.", + "operationId": "PlantingData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "body", + "description": "Planting data resource payload to create or update.", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + }, + "x-ms-examples": { + "PlantingData_CreateOrUpdate": { + "$ref": "./examples/PlantingData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantingData" + ], + "description": "Deletes a specified planting data resource under a particular farmer.", + "operationId": "PlantingData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlantingData_Delete": { + "$ref": "./examples/PlantingData_Delete.json" + } + } + } + }, + "/scenes": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Returns a paginated list of scene resources.", + "operationId": "Scenes_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "provider", + "description": "Provider name of scene data.", + "required": true, + "type": "string", + "default": "Microsoft" + }, + { + "in": "query", + "name": "farmerId", + "description": "FarmerId.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "BoundaryId.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "source", + "description": "Source name of scene data, default value Sentinel_2_L2A (Sentinel 2 L2A).", + "type": "string", + "default": "Sentinel_2_L2A" + }, + { + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Scenes_List": { + "$ref": "./examples/Scenes_List.json" + } + } + } + }, + "/scenes/satellite/ingest-data/{jobId}": { + "put": { + "tags": [ + "Scenes" + ], + "description": "Create a satellite data ingestion job.", + "operationId": "Scenes_CreateSatelliteDataIngestionJob", + "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": "body", + "description": "Job parameters supplied by user.", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Scenes_CreateSatelliteDataIngestionJob": { + "$ref": "./examples/Scenes_CreateSatelliteDataIngestionJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Scenes" + ], + "description": "Get a satellite data ingestion job.", + "operationId": "Scenes_GetSatelliteDataIngestionJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "Scenes_GetSatelliteDataIngestionJobDetails": { + "$ref": "./examples/Scenes_GetSatelliteDataIngestionJobDetails.json" + } + } + } + }, + "/scenes/downloadFiles": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Downloads and returns file stream as response for the given input filePath.", + "operationId": "Scenes_Download", + "produces": [ + "application/octet-stream", + "application/json" + ], + "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" + } + } + }, + "x-ms-examples": { + "Scenes_Download": { + "$ref": "./examples/Scenes_Download.json" + } + } + } + }, + "/farmers/{farmerId}/seasonal-fields": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Returns a paginated list of seasonal field resources under a particular farmer.", + "operationId": "SeasonalFields_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmIds", + "description": "Farm 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": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropVarietyIds", + "description": "CropVarietyIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Ids of the crop it belongs to.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAvgYieldValue", + "description": "Minimum average yield value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYieldValue", + "description": "Maximum average yield value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgYieldUnit", + "description": "Unit of the average yield value attribute.", + "type": "string" + }, + { + "in": "query", + "name": "minAvgSeedPopulationValue", + "description": "Minimum average seed population value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSeedPopulationValue", + "description": "Maximum average seed population value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgSeedPopulationUnit", + "description": "Unit of average seed population value attribute.", + "type": "string" + }, + { + "in": "query", + "name": "minPlantingDateTime", + "description": "Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPlantingDateTime", + "description": "Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "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/SeasonalFieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SeasonalFields_ListByFarmerId": { + "$ref": "./examples/SeasonalFields_ListByFarmerId.json" + } + } + } + }, + "/seasonal-fields": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Returns a paginated list of seasonal field resources across all farmers.", + "operationId": "SeasonalFields_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmIds", + "description": "Farm 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": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropVarietyIds", + "description": "CropVarietyIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Ids of the crop it belongs to.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAvgYieldValue", + "description": "Minimum average yield value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYieldValue", + "description": "Maximum average yield value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgYieldUnit", + "description": "Unit of the average yield value attribute.", + "type": "string" + }, + { + "in": "query", + "name": "minAvgSeedPopulationValue", + "description": "Minimum average seed population value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSeedPopulationValue", + "description": "Maximum average seed population value of the seasonal field(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgSeedPopulationUnit", + "description": "Unit of average seed population value attribute.", + "type": "string" + }, + { + "in": "query", + "name": "minPlantingDateTime", + "description": "Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPlantingDateTime", + "description": "Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "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/SeasonalFieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SeasonalFields_List": { + "$ref": "./examples/SeasonalFields_List.json" + } + } + } + }, + "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Gets a specified seasonal field resource under a particular farmer.", + "operationId": "SeasonalFields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "SeasonalFields_Get": { + "$ref": "./examples/SeasonalFields_Get.json" + } + } + }, + "patch": { + "tags": [ + "SeasonalFields" + ], + "description": "Creates or Updates a seasonal field resource under a particular farmer.", + "operationId": "SeasonalFields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer 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": "body", + "description": "Seasonal field resource payload to create or update.", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SeasonalFields_CreateOrUpdate": { + "$ref": "./examples/SeasonalFields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SeasonalFields" + ], + "description": "Deletes a specified seasonal-field resource under a particular farmer.", + "operationId": "SeasonalFields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SeasonalFields_Delete": { + "$ref": "./examples/SeasonalFields_Delete.json" + } + } + } + }, + "/seasonal-fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_GetCascadeDeleteJobDetails", + "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" + } + } + }, + "x-ms-examples": { + "SeasonalFields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/SeasonalFields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "SeasonalFields" + ], + "description": "Create a cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SeasonalFields_CreateCascadeDeleteJob": { + "$ref": "./examples/SeasonalFields_CreateCascadeDeleteJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/seasons": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Returns a paginated list of season resources.", + "operationId": "Seasons_List", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Seasons_List": { + "$ref": "./examples/Seasons_List.json" + } + } + } + }, + "/seasons/{seasonId}": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Gets a specified season resource.", + "operationId": "Seasons_Get", + "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" + } + } + }, + "x-ms-examples": { + "Seasons_Get": { + "$ref": "./examples/Seasons_Get.json" + } + } + }, + "patch": { + "tags": [ + "Seasons" + ], + "description": "Creates or updates a season resource.", + "operationId": "Seasons_CreateOrUpdate", + "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": "body", + "description": "Season resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Season" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Seasons_CreateOrUpdate": { + "$ref": "./examples/Seasons_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Seasons" + ], + "description": "Deletes a specified season resource.", + "operationId": "Seasons_Delete", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Seasons_Delete": { + "$ref": "./examples/Seasons_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/tillage-data": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Returns a paginated list of tillage data resources under a particular farm.", + "operationId": "TillageData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minTillageDepth", + "description": "Minimum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillageDepth", + "description": "Maximum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTillagePressure", + "description": "Minimum pressure applied by a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillagePressure", + "description": "Maximum pressure applied by a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TillageData_ListByFarmerId": { + "$ref": "./examples/TillageData_ListByFarmerId.json" + } + } + } + }, + "/tillage-data": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Returns a paginated list of tillage data resources across all farmers.", + "operationId": "TillageData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minTillageDepth", + "description": "Minimum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillageDepth", + "description": "Maximum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTillagePressure", + "description": "Minimum pressure applied by a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillagePressure", + "description": "Maximum pressure applied by a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "Operation boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TillageData_List": { + "$ref": "./examples/TillageData_List.json" + } + } + } + }, + "/farmers/{farmerId}/tillage-data/{tillageDataId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a specified tillage data resource under a particular farmer.", + "operationId": "TillageData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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" + } + } + }, + "x-ms-examples": { + "TillageData_Get": { + "$ref": "./examples/TillageData_Get.json" + } + } + }, + "patch": { + "tags": [ + "TillageData" + ], + "description": "Creates or updates an tillage data resource under a particular farmer.", + "operationId": "TillageData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "body", + "description": "Tillage data resource payload to create or update.", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + }, + "x-ms-examples": { + "TillageData_CreateOrUpdate": { + "$ref": "./examples/TillageData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "TillageData" + ], + "description": "Deletes a specified tillage data resource under a particular farmer.", + "operationId": "TillageData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the associated farmer 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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TillageData_Delete": { + "$ref": "./examples/TillageData_Delete.json" + } + } + } + }, + "/weather": { + "get": { + "tags": [ + "Weather" + ], + "description": "Returns a paginated list of weather data.", + "operationId": "Weather_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmerId", + "description": "Farmer ID.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "Boundary ID.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "extensionId", + "description": "ID of the weather extension.", + "required": true, + "type": "string", + "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$" + }, + { + "in": "query", + "name": "weatherDataType", + "description": "Type of weather data (forecast/historical).", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "granularity", + "description": "Granularity of weather data (daily/hourly).", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "startDateTime", + "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "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/WeatherDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Weather_List": { + "$ref": "./examples/Weather_List.json" + } + } + } + }, + "/weather/ingest-data/{jobId}": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get weather ingestion job.", + "operationId": "Weather_GetDataIngestionJobDetails", + "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/WeatherDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Weather_GetDataIngestionJobDetails": { + "$ref": "./examples/Weather_GetDataIngestionJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Weather" + ], + "description": "Create a weather data ingestion job.", + "operationId": "Weather_CreateDataIngestionJob", + "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": "body", + "description": "Job parameters supplied by user.", + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Weather_CreateDataIngestionJob": { + "$ref": "./examples/Weather_CreateDataIngestionJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/weather/delete-data/{jobId}": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get weather data delete job.", + "operationId": "Weather_GetDataDeleteJobDetails", + "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/WeatherDataDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Weather_GetDataDeleteJobDetails": { + "$ref": "./examples/Weather_GetDataDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Weather" + ], + "description": "Create a weather data delete job.", + "operationId": "Weather_CreateDataDeleteJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Job parameters supplied by user.", + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Weather_CreateDataDeleteJob": { + "$ref": "./examples/Weather_CreateDataDeleteJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "The endpoint of your FarmBeats resource (protocol and hostname, for example: https://{resourceName}.farmbeats.azure.net).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + }, + "definitions": { + "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" + } + } + }, + "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" + } + } + }, + "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" + }, + "source": { + "description": "Source of the operation data.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "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" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "type": "string" + }, + "farmerId": { + "description": "Farmer 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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationData" + } + }, + "$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" + } + } + }, + "InnerError": { + "description": "Inner error containing list of errors.\r\nInnerError reference document.", + "type": "object", + "properties": { + "code": { + "description": "Specific error code than was provided by the\r\ncontaining error.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Error": { + "description": "An error from the Azure AgPlatform service.", + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "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" + } + } + }, + "ErrorResponse": { + "description": "An error response from the Azure AgPlatform service.\r\nErrorResponse reference document..", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + }, + "traceId": { + "description": "Unique trace Id.", + "type": "string" + } + } + }, + "Attachment": { + "description": "Schema of attachment resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer id for this attachment.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + "resourceType": { + "description": "Associated Resource type for this attachment\r\ni.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData.", + "type": "string" + }, + "originalFileName": { + "description": "Original File Name 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 + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "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.", + "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" + } + } + }, + "GeoJsonObjectType": { + "description": "GeoJSON object type.", + "enum": [ + "Point", + "Polygon", + "MultiPolygon" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": true + } + }, + "GeoJsonObject": { + "description": "GeoJSON abstract class.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonObjectType" + } + }, + "discriminator": "type" + }, + "Boundary": { + "description": "Schema of boundary resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "Id of the parent(field or seasonalField) it belongs to.", + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "isPrimary": { + "description": "Is the boundary primary.", + "type": "boolean" + }, + "acreage": { + "format": "double", + "description": "Boundary area in acres.", + "type": "number", + "readOnly": true + }, + "parentType": { + "description": "Type of the parent it belongs to.", + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "example": { + "name": "string", + "description": "string", + "parentId": "string", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "BoundaryListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Boundary" + } + }, + "$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" + } + } + }, + "SearchBoundaryQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "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\neg. \"{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" + }, + "$maxPageSize": { + "format": "int32", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + "$skipToken": { + "description": "Skip token for getting next set of results.", + "type": "string" + }, + "isPrimary": { + "description": "Is the boundary primary.", + "type": "boolean" + }, + "parentType": { + "description": "Type of the parent it belongs to.", + "type": "string" + }, + "parentIds": { + "description": "Parent Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minAcreage": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxAcreage": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + } + } + }, + "CascadeDeleteJob": { + "description": "Schema of cascade delete job.", + "required": [ + "farmerId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string" + }, + "resourceId": { + "description": "The id of the resource.", + "type": "string" + }, + "resourceType": { + "description": "The type of the resource.", + "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": { + "description": "Duration of the job in seconds.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "BoundaryOverlapResponse": { + "description": "Schema of boundary overlap response.", + "type": "object", + "properties": { + "boundaryAcreage": { + "format": "double", + "description": "Acreage of Main boundary.", + "type": "number" + }, + "otherBoundaryAcreage": { + "format": "double", + "description": "Acreage of other boundary.", + "type": "number" + }, + "intersectingAcreage": { + "format": "double", + "description": "Acreage of intersecting boundary.", + "type": "number" + } + } + }, + "Crop": { + "description": "Schema of crop resource.", + "type": "object", + "properties": { + "phenotype": { + "description": "Crop phenotype.", + "maxLength": 100, + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "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.", + "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" + } + } + }, + "CropVariety": { + "description": "Schema of crop variety resource.", + "type": "object", + "properties": { + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string", + "readOnly": true + }, + "brand": { + "description": "CropVariety Brand.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "CropVariety product.", + "maxLength": 100, + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropVarietyListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CropVariety" + } + }, + "$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" + } + } + }, + "Farmer": { + "description": "Schema of farmer 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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmerListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Farmer" + } + }, + "$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", + "farmerId", + "startYear" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string" + }, + "authProviderId": { + "description": "Authentication provider Id.", + "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" + }, + "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": { + "description": "Duration of the job in seconds.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "Farm": { + "description": "Schema of farm resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer 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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "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" + } + } + }, + "Field": { + "description": "Schema of field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "farmerId": { + "description": "Farmer Id.", + "type": "string", + "readOnly": true + }, + "primaryBoundaryId": { + "description": "Primary boundary id.", + "type": "string", + "readOnly": true + }, + "boundaryIds": { + "description": "Boundary Ids.", + "uniqueItems": true, + "type": "array", + "items": { + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Field" + } + }, + "$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" + } + } + }, + "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" + }, + "source": { + "description": "Source of the operation data.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "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" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "type": "string" + }, + "farmerId": { + "description": "Farmer 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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestData" + } + }, + "$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" + } + } + }, + "ImageProcessingRasterizeJob": { + "description": "ImageProcessingRasterizeJob.", + "required": [ + "farmerId", + "shapefileAttachmentId", + "shapefileColumnNames" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string" + }, + "shapefileAttachmentId": { + "description": "Shapefile attachment Id.", + "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": { + "description": "Duration of the job in seconds.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "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.", + "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", + "farmerId" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer ID for this OAuth config.", + "type": "string" + }, + "authProviderId": { + "description": "ID of the OAuth provider resource containing app information.", + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + } + } + }, + "OAuthTokenListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "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" + } + } + }, + "OAuthConnectRequest": { + "description": "Get OAuth config query parameters.", + "required": [ + "farmerId", + "oAuthProviderId", + "userRedirectLink" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer.", + "type": "string" + }, + "oAuthProviderId": { + "description": "Id of the OAuthProvider.", + "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" + } + } + }, + "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" + } + } + }, + "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" + }, + "source": { + "description": "Source of the operation data.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "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" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "type": "string" + }, + "farmerId": { + "description": "Farmer 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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingData" + } + }, + "$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" + } + } + }, + "ImageFormat": { + "description": "Supported image formats for scene resource.", + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "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.", + "type": "string" + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "resolution": { + "format": "double", + "description": "Resolution of image file in meters.", + "type": "number" + } + } + }, + "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" + }, + "source": { + "description": "Data source 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" + }, + "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" + }, + "boundaryId": { + "description": "Boundary ID which belongs to the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "farmerId": { + "description": "Farmer 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 + } + } + }, + "SceneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "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" + } + } + }, + "DataProvider": { + "description": "Provider of satellite data.", + "enum": [ + "Microsoft" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "Source": { + "description": "Source of satellite data.", + "enum": [ + "Sentinel_2_L2A" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "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": [ + "boundaryId", + "endDateTime", + "farmerId", + "startDateTime" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which satellite data is being fetched.", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "Start Date.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End Date.", + "type": "string" + }, + "provider": { + "$ref": "#/definitions/DataProvider" + }, + "source": { + "$ref": "#/definitions/Source" + }, + "data": { + "$ref": "#/definitions/SatelliteData" + }, + "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": { + "description": "Duration of the job in seconds.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalField": { + "description": "Schema of seasonal field resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string", + "readOnly": true + }, + "primaryBoundaryId": { + "description": "Primary boundary id.", + "type": "string", + "readOnly": true + }, + "boundaryIds": { + "description": "Boundary Ids.", + "uniqueItems": true, + "type": "array", + "items": { + "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" + }, + "cropVarietyIds": { + "description": "CropVariety ids.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "avgYieldValue": { + "format": "double", + "description": "Average yield value of the seasonal field.", + "type": "number" + }, + "avgYieldUnit": { + "description": "Unit of the average yield value attribute.", + "maxLength": 32, + "minLength": 2, + "type": "string" + }, + "avgSeedPopulationValue": { + "format": "double", + "description": "Average seed population value of the seasonal field.", + "type": "number" + }, + "avgSeedPopulationUnit": { + "description": "Unit of average seed population value attribute.", + "maxLength": 32, + "minLength": 2, + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "Planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SeasonalField" + } + }, + "$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" + } + } + }, + "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" + }, + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "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.", + "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" + } + } + }, + "TillageData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "source": { + "description": "Source of the operation data.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "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" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "type": "string" + }, + "farmerId": { + "description": "Farmer 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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, 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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/TillageData" + } + }, + "$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" + } + } + }, + "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" + } + } + }, + "WeatherData": { + "description": "Schema of weather data.", + "required": [ + "boundaryId", + "dateTime", + "extensionId", + "extensionVersion", + "farmerId", + "granularity", + "location", + "weatherDataType" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer ID.", + "type": "string" + }, + "boundaryId": { + "description": "Boundary ID.", + "type": "string" + }, + "extensionId": { + "description": "ID of the weather extension.", + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "dateTime": { + "format": "date-time", + "description": "Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "unitSystemCode": { + "description": "Unit System like US/SI etc.", + "type": "string" + }, + "extensionVersion": { + "description": "Version of the weather data extension.", + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "type": "string" + }, + "granularity": { + "description": "Granularity of weather data (daily/hourly).", + "type": "string" + }, + "cloudCover": { + "$ref": "#/definitions/Measure" + }, + "dewPoint": { + "$ref": "#/definitions/Measure" + }, + "growingDegreeDay": { + "$ref": "#/definitions/Measure" + }, + "precipitation": { + "$ref": "#/definitions/Measure" + }, + "pressure": { + "$ref": "#/definitions/Measure" + }, + "relativeHumidity": { + "$ref": "#/definitions/Measure" + }, + "soilMoisture": { + "$ref": "#/definitions/Measure" + }, + "soilTemperature": { + "$ref": "#/definitions/Measure" + }, + "temperature": { + "$ref": "#/definitions/Measure" + }, + "visibility": { + "$ref": "#/definitions/Measure" + }, + "wetBulbTemperature": { + "$ref": "#/definitions/Measure" + }, + "windChill": { + "$ref": "#/definitions/Measure" + }, + "windDirection": { + "$ref": "#/definitions/Measure" + }, + "windGust": { + "$ref": "#/definitions/Measure" + }, + "windSpeed": { + "$ref": "#/definitions/Measure" + }, + "id": { + "description": "Weather data ID.", + "type": "string" + }, + "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 + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherData" + } + }, + "$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" + } + } + }, + "WeatherDataIngestionJob": { + "description": "Schema of weather ingestion job.", + "required": [ + "boundaryId", + "extensionApiInput", + "extensionApiName", + "extensionId", + "farmerId" + ], + "type": "object", + "properties": { + "boundaryId": { + "description": "The id of the boundary object for which weather data is being fetched.", + "type": "string" + }, + "farmerId": { + "description": "The id of the farmer object for which weather data is being fetched.", + "type": "string" + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "extensionApiInput": { + "description": "Extension api input dictionary which would be used to feed request query/body/parameter information.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "extensionDataProviderAppId": { + "description": "App id of the weather data provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "extensionDataProviderApiKey": { + "description": "Api key of the weather data provider.", + "maxLength": 200, + "minLength": 2, + "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": { + "description": "Duration of the job in seconds.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataDeleteJob": { + "description": "Schema of weather data delete job.", + "required": [ + "boundaryId", + "extensionId", + "farmerId" + ], + "type": "object", + "properties": { + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", + "type": "string" + }, + "farmerId": { + "description": "The id of the farmer object for which weather data is being fetched.", + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which weather data is being fetched.", + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data. Possible values include: 'forecast' , 'historical'.", + "type": "string" + }, + "granularity": { + "description": "Granularity of weather data. Possible values include: 'daily' , 'hourly'.", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "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": { + "description": "Duration of the job in seconds.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "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" + }, + "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 and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "MultiPolygon": { + "description": "MultiPolygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/MultiPolygonCoordinates" + } + ], + "x-ms-discriminator-value": "MultiPolygon" + }, + "MultiPolygonCoordinates": { + "description": "Schema of multi polygon coordinates.", + "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.", + "minLength": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + }, + "Point": { + "description": "Point geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/PointCoordinates" + } + ], + "x-ms-discriminator-value": "Point" + }, + "PointCoordinates": { + "description": "Schema of the coordinates of a point.", + "type": "object", + "required": [ + "coordinates" + ], + "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" + } + } + } + }, + "Polygon": { + "description": "Polygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/PolygonCoordinates" + } + ], + "x-ms-discriminator-value": "Polygon" + }, + "PolygonCoordinates": { + "description": "Schema of polygon coordinates.", + "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.", + "minLength": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + }, + "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": [] + } + ] +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json new file mode 100644 index 000000000000..a4744781e51a --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "applicationDataId": "APPLICATION123", + "api-version": "2021-03-31-preview", + "body": { + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "operationBoundaryId": "APPLICATIONOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "operationBoundaryId": "APPLICATIONOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "farmerId": "FARMER123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "operationBoundaryId": "APPLICATIONOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json new file mode 100644 index 000000000000..20dc9e559382 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "applicationDataId": "APPLICATION123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json new file mode 100644 index 000000000000..b9daa7a1fd1f --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "applicationDataId": "APPLICATION123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "operationBoundaryId": "APPLICATIONOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json new file mode 100644 index 000000000000..5f76b4ef2d0d --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "operationBoundaryId": "APPLICATIONOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json new file mode 100644 index 000000000000..5b0d758e3ae4 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "operationBoundaryId": "APPLICATIONOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json new file mode 100644 index 000000000000..690aa0d90592 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "attachmentId": "ATTACHMENT123", + "api-version": "2021-03-31-preview", + "file": "101010101" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "ATTACHMENT123", + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json new file mode 100644 index 000000000000..e6fddfaa62cf --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "attachmentId": "ATTACHMENT123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json new file mode 100644 index 000000000000..75312a623832 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "attachmentId": "ATTACHMENT123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json new file mode 100644 index 000000000000..635f927d9a43 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "attachmentId": "ATTACHMENT123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json new file mode 100644 index 000000000000..5fd6ec10225c --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ATTACHMENT123", + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..5487345f12fd --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "farmerId": "FARMER123", + "resourceId": "BOUNDARY123", + "resourceType": "boundary", + "name": "John Smith's Boundary", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json new file mode 100644 index 000000000000..d5c323cc2168 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "api-version": "2021-03-31-preview", + "body": { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + }, + "responses": { + "200": { + "body": { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + }, + "201": { + "body": { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json new file mode 100644 index 000000000000..6f54f0c0e68b --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json new file mode 100644 index 000000000000..8b367ca8b678 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..cd0d436c4e5a --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "name": "John Smith's Boundary", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "farmerId": "FARMER123", + "resourceId": "BOUNDARY123", + "resourceType": "boundary" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json new file mode 100644 index 000000000000..35d8e2ae0f84 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "otherFarmerId": "FARMER456", + "otherBoundaryId": "BOUNDARY56", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "boundaryAcreage": 35, + "otherBoundaryAcreage": 25, + "intersectingAcreage": 10 + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json new file mode 100644 index 000000000000..8ca2e70efba1 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json new file mode 100644 index 000000000000..d4779fd7e53b --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json new file mode 100644 index 000000000000..713d5e4f3859 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "body": { + "ids": [ + "BOUNDARY123" + ], + "names": [ + "John Smith's Boundary" + ], + "propertyFilters": [ + "RetailerId" + ], + "statuses": [ + "Active" + ], + "minCreatedDateTime": "2021-04-22T12:53:39Z", + "maxCreatedDateTime": "2021-04-22T12:53:39Z", + "minLastModifiedDateTime": "2021-04-22T12:53:39Z", + "maxLastModifiedDateTime": "2021-04-22T12:53:39Z", + "$maxPageSize": 50, + "$skipToken": "string", + "isPrimary": true, + "parentType": "field", + "parentIds": [ + "FIELD123" + ], + "minAcreage": 200, + "maxAcreage": 800, + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 10.98958969116211, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.284911882713146 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json new file mode 100644 index 000000000000..01153167765b --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview", + "body": { + "ids": [ + "BOUNDARY123" + ], + "names": [ + "John Smith's Boundary" + ], + "propertyFilters": [ + "RetailerId" + ], + "statuses": [ + "Active" + ], + "minCreatedDateTime": "2021-04-22T12:53:39Z", + "maxCreatedDateTime": "2021-04-22T12:53:39Z", + "minLastModifiedDateTime": "2021-04-22T12:53:39Z", + "maxLastModifiedDateTime": "2021-04-22T12:53:39Z", + "$maxPageSize": 50, + "$skipToken": "string", + "isPrimary": true, + "parentType": "field", + "parentIds": [ + "FIELD123" + ], + "minAcreage": 200, + "maxAcreage": 800, + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 10.98958969116211, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.284911882713146 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "John Smith's Boundary", + "description": "Some description", + "parentId": "FIELD123", + "isPrimary": false, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json new file mode 100644 index 000000000000..ea0aabc0386d --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123", + "cropVarietyId": "SEED123", + "body": { + "brand": "BRAND123", + "product": "AGTECH", + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "cropId": "CORN123", + "brand": "BRAND123", + "product": "AGTECH", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEED123", + "cropId": "CORN123", + "brand": "BRAND123", + "product": "AGTECH", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json new file mode 100644 index 000000000000..c62fd820d5c2 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123", + "cropVarietyId": "SEED123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json new file mode 100644 index 000000000000..be3eca9dbfa1 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123", + "cropVarietyId": "SEED123" + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "cropId": "CORN123", + "brand": "BRAND123", + "product": "AGTECH", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json new file mode 100644 index 000000000000..ccde0d486bd2 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEED123", + "cropId": "CORN123", + "brand": "BRAND123", + "product": "AGTECH", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json new file mode 100644 index 000000000000..8eb7a9d2af11 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEED123", + "cropId": "CORN123", + "brand": "BRAND123", + "product": "AGTECH", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json new file mode 100644 index 000000000000..5850e7633b26 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123", + "body": { + "phenotype": "Corn", + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json new file mode 100644 index 000000000000..a096ebe1f94b --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json new file mode 100644 index 000000000000..5caa58d6da6c --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "cropId": "CORN123" + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json new file mode 100644 index 000000000000..54f133d7d4e3 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "CORN123", + "phenotype": "Corn", + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json new file mode 100644 index 000000000000..a026fe4ba440 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview", + "body": { + "farmerId": "TEST-FARMER", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "name": "Farm Operations Job", + "description": "For TEST-FARMER", + "properties": { + "Operation": "All" + } + } + }, + "responses": { + "202": { + "body": { + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "durationInSeconds": "14.79", + "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7", + "status": "Waiting", + "message": "string", + "createdDateTime": "2021-03-15T07:14:14Z", + "lastActionDateTime": "2021-03-15T07:14:14Z", + "startTime": "2021-03-15T07:14:14Z", + "endTime": "2021-03-15T07:14:14Z", + "name": "Farm Operations Job", + "description": "For TEST-FARMER", + "properties": { + "Operation": "All" + }, + "farmerId": "TEST-FARMER", + "authProviderId": "JOHNDEERE" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..df7b21127fe4 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": "11.2", + "id": "farm-operations-job", + "status": "Succeeded", + "message": "string", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "Farm operations Job", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "farmerId": "FARMER123", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012 + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0a9fdea9a3c2 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer", + "name": "John Smith", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json new file mode 100644 index 000000000000..1ac6b08d4e24 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview", + "body": { + "status": "Active", + "name": "John Smith", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FARMER123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FARMER123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json new file mode 100644 index 000000000000..eaa1e89032a9 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json new file mode 100644 index 000000000000..606647a7877c --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123" + }, + "responses": { + "200": { + "body": { + "id": "FARMER123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..f96169d79349 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "name": "John Smith", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json new file mode 100644 index 000000000000..ddfbfa7bde25 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARMER123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..71ab1497dd85 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "farmId": "FARM123", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "farmerId": "FARMER123", + "resourceId": "FARM123", + "resourceType": "farm", + "name": "John Smith's Field", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json new file mode 100644 index 000000000000..a725452fc2c8 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "farmId": "FARM123", + "api-version": "2021-03-31-preview", + "body": { + "status": "Active", + "name": "John Smith's Farm", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "farmerId": "FARMER123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FARM123", + "farmerId": "FARMER123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json new file mode 100644 index 000000000000..36d748d9f396 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "farmId": "FARM123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json new file mode 100644 index 000000000000..d33a4ffeb592 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "farmId": "FARM123" + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "farmerId": "FARMER123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..a36872564481 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "name": "John Smith's Farm", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "farmerId": "FARMER123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json new file mode 100644 index 000000000000..fc004b6a3578 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "farmerId": "FARMER123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json new file mode 100644 index 000000000000..79b77c8abd9e --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "farmerId": "FARMER123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..cd45d5362c98 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "fieldId": "FIELD123", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "farmerId": "FARMER123", + "resourceId": "FIELD123", + "resourceType": "field", + "name": "John Smith's Field", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json new file mode 100644 index 000000000000..d1edc5d0a0d6 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "fieldId": "FIELD123", + "api-version": "2021-03-31-preview", + "body": { + "farmId": "FARM123", + "status": "Active", + "name": "John Smith's Field", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json new file mode 100644 index 000000000000..c47512aa50af --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "fieldId": "FIELD123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json new file mode 100644 index 000000000000..da17b84a03ac --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "fieldId": "FIELD123" + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..51ace08535cc --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "name": "John Smith's Field", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "farmerId": "FARMER123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json new file mode 100644 index 000000000000..4978fe7edd6e --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json new file mode 100644 index 000000000000..bf218911d277 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json new file mode 100644 index 000000000000..3b4bcc97d9c2 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "harvestDataId": "HARVESTOP123", + "body": { + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "HARVESTOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "operationBoundaryId": "HARVESTOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "farmerId": "FARMER123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "operationBoundaryId": "HARVESTOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json new file mode 100644 index 000000000000..88c5785f4045 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json new file mode 100644 index 000000000000..caae9cb85c56 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "operationBoundaryId": "HARVESTOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json new file mode 100644 index 000000000000..7eecebcce739 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "HARVESTOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/harvestData?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json new file mode 100644 index 000000000000..fdab67c54d14 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "operationBoundaryId": "HARVESTOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/harvestData?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json new file mode 100644 index 000000000000..5ffa333dcfae --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview", + "body": { + "farmerId": "test_farmer", + "shapefileAttachmentId": "harvesting_data_shapefile123", + "shapefileColumnNames": [ + "Wet_yield", + "Dry_yield" + ], + "name": "Harvest_Data_Rasterize_Job", + "description": "Rasterize harvest data shape file", + "properties": { + "region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": "12.4", + "id": "weather-job", + "status": "Waiting", + "message": "Created job to fetch weather data for job name 'TestWeatherJob', farmer id 'test_farmer' and field id 'test_field'.", + "createdDateTime": "2021-04-16T11:33:45Z", + "lastActionDateTime": "2021-04-16T11:33:45Z", + "startTime": "2021-04-16T11:33:45Z", + "endTime": "2021-04-16T11:33:45Z", + "farmerId": "test_farmer", + "shapefileAttachmentId": "harvesting_data_shapefile123", + "shapefileColumnNames": [ + "Wet_yield", + "Dry_yield" + ], + "name": "Harvest_Data_Rasterize_Job", + "description": "Rasterize harvest data shape file", + "properties": { + "region": "Asia" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json new file mode 100644 index 000000000000..a4596141afa6 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": "12.4", + "id": "weather-job", + "status": "Succeeded", + "message": "Weather data is available for startTime to endTime", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "farmerId": "test_farmer", + "shapefileAttachmentId": "harvesting_data_shapefile123", + "shapefileColumnNames": [ + "Wet_yield", + "Dry_yield" + ], + "name": "Harvest_Data_Rasterize_Job", + "description": "Rasterize harvest data shape file", + "properties": { + "region": "Asia" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json new file mode 100644 index 000000000000..d5fbeedcfef6 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview", + "body": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + }, + "201": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json new file mode 100644 index 000000000000..3a02f6d27ae6 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json new file mode 100644 index 000000000000..994c7a7013be --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Farmer": "123" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json new file mode 100644 index 000000000000..3777236bf4b3 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Farmer": "123" + } + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_Delete.json new file mode 100644 index 000000000000..3c9a774f982d --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json new file mode 100644 index 000000000000..31c435205661 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "body": { + "farmerId": "FARMER123", + "oAuthProviderId": "JOHNDEERE", + "userRedirectLink": "https://docs.microsoft.com", + "userRedirectState": "code" + } + }, + "responses": { + "200": { + "body": "Connection string" + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json new file mode 100644 index 000000000000..7ccb4143441b --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "authProviderId": "JOHNDEERE", + "isValid": true, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:49:25Z", + "modifiedDateTime": "2021-04-22T18:49:25Z" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json new file mode 100644 index 000000000000..74b1100cb380 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "plantingDataId": "PLANTINGOP123", + "body": { + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "farmerId": "FARMER123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json new file mode 100644 index 000000000000..8b17313f1110 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json new file mode 100644 index 000000000000..155712c370fd --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json new file mode 100644 index 000000000000..b6c59eaee01a --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/plantingData?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json new file mode 100644 index 000000000000..7bb636bba095 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/plantingData?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json new file mode 100644 index 000000000000..ce92d1f96180 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview", + "body": { + "boundaryId": "BOUNDARY123", + "farmerId": "FARMER123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + }, + "properties": { + "Region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": "12.4", + "id": "satellite-job", + "status": "Created", + "message": "Created job 'satellite-job' to fetch satellite data for boundary 'BOUNDARY123' for startDate '01/01/2019 00:00:00' and endDate '03/30/2019 00:00:00' (both inclusive)", + "createdDateTime": "2021-04-16T07:56:05Z", + "lastActionDateTime": "2021-04-16T07:56:05Z", + "startDateTime": "2021-04-16T07:56:05Z", + "endDateTime": "2021-04-16T07:56:05Z", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json new file mode 100644 index 000000000000..0fe996302727 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "filePath": "https://filePath", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json new file mode 100644 index 000000000000..c7d0deb21e36 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": "12.4", + "id": "satellite-job", + "status": "Succeeded", + "message": "Satellite data is available for 73 days from provider in the requested date range. Successfully fetched data for 73 days.", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "boundaryId": "BOUNDARY123", + "farmerId": "FARMER123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json new file mode 100644 index 000000000000..cd555fe0682f --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "provider": "Microsoft", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "400e200f-ccc4-0cea-c120-3fdc6a41f99f", + "sceneDateTime": "2019-01-27T00:00:00Z", + "boundaryId": "BOUNDARY123", + "farmerId": "FARMER123", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "cloudCoverPercentage": 67.2, + "darkPixelPercentage": 2.4, + "imageFormat": "TIF", + "imageFiles": [ + { + "name": "B08", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b08_10.tif" + }, + { + "name": "B03", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b03_10.tif" + }, + { + "name": "B11", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b11_10.tif" + }, + { + "name": "SNW", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/snw_10.tif" + }, + { + "name": "B05", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b05_10.tif" + }, + { + "name": "B06", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b06_10.tif" + }, + { + "name": "dataMask", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/datamask_10.tif" + }, + { + "name": "B07", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b07_10.tif" + }, + { + "name": "CLP", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/clp_10.tif" + }, + { + "name": "NDVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/ndvi_10.tif" + }, + { + "name": "SCL", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/scl_10.tif" + }, + { + "name": "B09", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b09_10.tif" + }, + { + "name": "B01", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b01_10.tif" + }, + { + "name": "NDWI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/ndwi_10.tif" + }, + { + "name": "AOT", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/aot_10.tif" + }, + { + "name": "CLD", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/cld_10.tif" + }, + { + "name": "CLM", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/clm_10.tif" + }, + { + "name": "B02", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b02_10.tif" + }, + { + "name": "B04", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b04_10.tif" + }, + { + "name": "B8A", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b8a_10.tif" + }, + { + "name": "EVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/evi_10.tif" + }, + { + "name": "B12", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b12_10.tif" + } + ] + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/scenes?provider=Microsoft&farmerId=FARMER123&boundaryId=BOUNDARY123&api-version=2020-10-16-preview&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1PTnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAdOfBwAAAAAA7Z8HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..ada8ce54b205 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "farmerId": "FARMER123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json new file mode 100644 index 000000000000..6201ad8661b6 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2021-03-31-preview", + "body": { + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "cropVarietyIds": [ + "WHEAT_VARIETY_123", + "WHEAT_VARIETY_456" + ], + "avgYieldValue": 321.6, + "avgYieldUnit": "Bushels per acre", + "avgSeedPopulationValue": 45, + "avgSeedPopulationUnit": "Kilogram per acre", + "plantingDateTime": "2021-04-21T06:49:30Z", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "cropVarietyIds": [ + "WHEAT_VARIETY_123", + "WHEAT_VARIETY_456" + ], + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "avgYieldValue": 321.6, + "avgYieldUnit": "Bushels per acre", + "avgSeedPopulationValue": 45, + "avgSeedPopulationUnit": "Kilogram per acre", + "plantingDateTime": "2021-04-21T06:49:30Z", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEASONALFIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "cropVarietyIds": [ + "WHEAT_VARIETY_123", + "WHEAT_VARIETY_456" + ], + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "avgYieldValue": 321.6, + "avgYieldUnit": "Bushels per acre", + "avgSeedPopulationValue": 45, + "avgSeedPopulationUnit": "Kilogram per acre", + "plantingDateTime": "2021-04-21T06:49:30Z", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json new file mode 100644 index 000000000000..e88c3e014d9d --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json new file mode 100644 index 000000000000..531e3c81b5e5 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "cropVarietyIds": [ + "WHEAT_VARIETY_123", + "WHEAT_VARIETY_456" + ], + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "avgYieldValue": 321.6, + "avgYieldUnit": "Bushels per acre", + "avgSeedPopulationValue": 45, + "avgSeedPopulationUnit": "Kilogram per acre", + "plantingDateTime": "2021-04-21T06:49:30Z", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..bfa32f7b30b9 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": "14.7977857", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "farmerId": "FARMER123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json new file mode 100644 index 000000000000..e2df1c6e4d09 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEASONALFIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "cropVarietyIds": [ + "WHEAT_VARIETY_123", + "WHEAT_VARIETY_456" + ], + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "avgYieldValue": 321.6, + "avgYieldUnit": "Bushels per acre", + "avgSeedPopulationValue": 45, + "avgSeedPopulationUnit": "Kilogram per acre", + "plantingDateTime": "2021-04-21T06:49:30Z", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json new file mode 100644 index 000000000000..1ff5c7b115ed --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEASONALFIELD123", + "farmerId": "FARMER123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "cropVarietyIds": [ + "WHEAT_VARIETY_123", + "WHEAT_VARIETY_456" + ], + "primaryBoundaryId": "BOUNDARY123", + "boundaryIds": [ + "BOUNDARY123", + "BOUNDARY456" + ], + "avgYieldValue": 321.6, + "avgYieldUnit": "Bushels per acre", + "avgSeedPopulationValue": 45, + "avgSeedPopulationUnit": "Kilogram per acre", + "plantingDateTime": "2021-04-21T06:49:30Z", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json new file mode 100644 index 000000000000..cbc30de4d122 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "seasonId": "SEASON123", + "body": { + "startDateTime": "2021-04-22T17:56:28Z", + "endDateTime": "2021-04-22T17:56:28Z", + "year": 2012, + "status": "Active", + "name": "John Smith's Season", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json new file mode 100644 index 000000000000..65b69d8f4cff --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "seasonId": "SEASON123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json new file mode 100644 index 000000000000..bb211e68d035 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "seasonId": "SEASON123" + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json new file mode 100644 index 000000000000..5c0053b60f65 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "$skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json new file mode 100644 index 000000000000..a72b676eed9f --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "tillageDataId": "TILLAGEOP123", + "body": { + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "farmerId": "FARMER123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json new file mode 100644 index 000000000000..8ab38e14e5fb --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json new file mode 100644 index 000000000000..a9499ed7990f --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "200": { + "body": { + "farmerId": "FARMER123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Asia", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json new file mode 100644 index 000000000000..52e57fe5de5e --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/plantingData?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json new file mode 100644 index 000000000000..240a3548c76b --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "FARMER123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationBoundaryId": "PLANTINGOPBOUNDARY1", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-02-29T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "$skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/plantingData?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json new file mode 100644 index 000000000000..bbaeefc1a613 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview", + "body": { + "extensionId": "dtn.clearAg", + "farmerId": "test_farmer", + "boundaryId": "test_farmer", + "weatherDataType": "forecast", + "granularity": "daily", + "startDateTime": "2021-04-18T01:32:42Z", + "endDateTime": "2021-04-18T01:32:42Z", + "name": "Delete Job", + "description": "For extension dtn.clearAg", + "properties": { + "region": "US" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": "12.4", + "id": "delete-weather-job", + "status": "Waiting", + "message": "Created job to delete weather data for job name 'delete-weather-job', farmer id 'test_farmer' and boundary id 'test_boundary'.", + "createdDateTime": "2021-04-16T11:33:45Z", + "lastActionDateTime": "2021-04-16T11:33:45Z", + "startTime": "2021-04-16T11:33:45Z", + "endTime": "2021-04-16T11:33:45Z", + "farmerId": "test_farmer", + "boundaryId": "test_farmer", + "extensionId": "dtn.clearAg", + "name": "Delete Job", + "description": "For extension dtn.clearAg", + "properties": { + "region": "US" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json new file mode 100644 index 000000000000..3ce2e54292c4 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview", + "body": { + "farmerId": "test_farmer", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "extensionApiName": "dailyforecast", + "extensionApiInput": { + "start": 0, + "end": 5 + }, + "name": "TestWeatherJob", + "description": "Daily Forecast data for 5 days", + "properties": { + "region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": "12.4", + "id": "weather-job", + "status": "Waiting", + "message": "Created job to fetch weather data for job name 'TestWeatherJob', farmer id 'test_farmer' and field id 'test_field'.", + "createdDateTime": "2021-04-16T11:33:45Z", + "lastActionDateTime": "2021-04-16T11:33:45Z", + "startTime": "2021-04-16T11:33:45Z", + "endTime": "2021-04-16T11:33:45Z", + "farmerId": "test_farmer", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "extensionApiName": "dailyforecast", + "extensionApiInput": { + "start": 0, + "end": 5 + }, + "name": "TestWeatherJob", + "description": "Daily Forecast data for 5 days", + "properties": { + "region": "Asia" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json new file mode 100644 index 000000000000..d844f5594058 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": "12.4", + "id": "weather-delete-job", + "status": "Succeeded", + "message": "Weather data is deleted for startTime to endTime", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "extensionId": "dtn.clearAg", + "farmerId": "test_farmer", + "boundaryId": "test_farmer", + "weatherDataType": "forecast", + "granularity": "daily", + "startDateTime": "2021-04-18T01:32:42Z", + "endDateTime": "2021-04-18T01:32:42Z", + "name": "Delete Job", + "description": "For extension dtn.clearAg", + "properties": { + "region": "US" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..54a11810c592 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "JOB123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": "12.4", + "id": "weather-job", + "status": "Succeeded", + "message": "Weather data is available for startTime to endTime", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "farmerId": "test_farmer", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "extensionApiName": "dailyforecast", + "extensionApiInput": { + "start": 0, + "end": 5 + }, + "name": "TestWeatherJob", + "description": "Daily Forecast data for 5 days", + "properties": { + "region": "Asia" + } + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json new file mode 100644 index 000000000000..837c992aaa74 --- /dev/null +++ b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "extensionId": "DTN.ClearAg", + "weatherDataType": "Historical", + "granularity": "Daily", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ecd327e7-07f1-31b1-65ee-2162e193c055", + "farmerId": "test_farmer", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "location": { + "latitude": 77.75695801443568, + "longitude": 12.30932563432023 + }, + "dateTime": "2020-12-23T00:00:00Z", + "unitSystemCode": "us-std", + "extensionVersion": "1.0", + "weatherDataType": "forecast", + "granularity": "daily", + "cloudCover": { + "unit": "%", + "value": 81.1 + }, + "dewPoint": { + "unit": "F", + "value": 26.0 + }, + "precipitation": { + "unit": "in", + "value": 0.1 + }, + "relativeHumidity": { + "unit": "%", + "value": 74.0 + }, + "temperature": { + "unit": "F", + "value": 33.0 + }, + "windGust": { + "unit": "mph", + "value": 50.0 + }, + "windSpeed": { + "unit": "mph", + "value": 31.0 + }, + "eTag": "\"2b00a419-0000-0700-0000-5fe1ae4c0000\"", + "properties": { + "air_temp_max": { + "unit": "F", + "value": 36.0 + }, + "air_temp_min": "29", + "cloudCoverDescriptor": "Becoming Broken Overcast", + "precipitationDescriptor": "Light Snow Likely", + "weatherDescriptor": "Light Snow Likely", + "windDirectionDescriptor": "East", + "windTrendDescriptor": "None", + "dewPointMax": { + "unit": "F", + "value": 28.0 + }, + "dewPointMin": { + "unit": "F", + "value": 22.0 + }, + "iceAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "liquidAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "longWaveRadiationAvg": { + "unit": "W/m^2", + "value": 291.0 + }, + "petPeriod": { + "unit": "in", + "value": 0.04 + }, + "precipProb": { + "unit": "%", + "value": 75.0 + }, + "relativeHumidityMax": { + "unit": "%", + "value": 81.0 + }, + "relativeHumidityMin": { + "unit": "%", + "value": 69.0 + }, + "shortWaveRadiationAvg": { + "unit": "W/m^2", + "value": 0.0 + }, + "snowAccPeriod": { + "unit": "in", + "value": 0.7 + }, + "sunshineDuration": { + "unit": "hours", + "value": 0.0 + }, + "windSpeed2mAvg": { + "unit": "mph", + "value": 24.0 + }, + "windSpeed2mMax": { + "unit": "mph", + "value": 32.0 + }, + "windSpeed2mMin": { + "unit": "mph", + "value": 17.0 + }, + "windSpeedMax": { + "unit": "mph", + "value": 42.0 + }, + "windSpeedMin": { + "unit": "mph", + "value": 23.0 + } + } + } + ] + } + } + } +} diff --git a/specification/agfood/data-plane/readme.md b/specification/agfood/data-plane/readme.md new file mode 100644 index 000000000000..3d36db0e3711 --- /dev/null +++ b/specification/agfood/data-plane/readme.md @@ -0,0 +1,43 @@ +# agfood + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for agfood. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the agfood. + +```yaml +openapi-type: data-plane +tag: package-2021-03-31-preview + +directive: + - suppress: LongRunningResponseStatusCode + reason: The validation tools do not properly recognize 202 as a supported response code. +``` + +### Tag: package-2021-03-31-preview + +These settings apply only when `--tag=package-2021-03-31-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-03-31-preview' +input-file: + - Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json +```