diff --git a/custom-words.txt b/custom-words.txt index d2138957dce2..e5dea9a49fe7 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -933,6 +933,7 @@ jobschedule jobscheduler jobschedules johnc +JOHNDEERE johnsmith JSONLD Jtoken @@ -1208,6 +1209,8 @@ nchar ndjson ndvi NDVI +ndwi +NDWI Neighbourhood netapp netdev @@ -1470,6 +1473,7 @@ RAGZRS randint Rankable rasterize +rasterized ratelimit ravbhatnagar rawwebsockets @@ -1695,6 +1699,7 @@ sfhealthid sfpkg shamir_share shapefile +shapefiles sharded sharedkey sharename diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json index 39079c72e51f..68b143c1d0ed 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json @@ -1,26 +1,17 @@ { "swagger": "2.0", "info": { - "title": "Azure AgriFoodPlatform Data Plane Service", + "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.", + "description": "Get a paginated list of application data resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "ApplicationData_ListByFarmerId", "produces": [ "application/json" @@ -29,42 +20,42 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "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).", + "description": "Application data with average material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgMaterial", - "description": "Maximum average amount of material applied during the application (inclusive).", + "description": "Application data with average material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTotalMaterial", - "description": "Minimum total amount of material applied during the application (inclusive).", + "description": "Application data with total material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalMaterial", - "description": "Maximum total amount of material applied during the application (inclusive).", + "description": "Application data with total material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Application data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -74,7 +65,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the application operation was done.", "type": "array", "items": { "type": "string" @@ -84,7 +75,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the application operation was carried out.", "type": "array", "items": { "type": "string" @@ -94,63 +85,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Application operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Application operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Application operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Application operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Application operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Application operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Application operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Application operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of application operations to be returned.", "type": "array", "items": { "type": "string" @@ -160,7 +151,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of application operations to be returned.", "type": "array", "items": { "type": "string" @@ -170,7 +161,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -180,7 +171,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Application data with only given statuses are returned.", "type": "array", "items": { "type": "string" @@ -190,35 +181,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "$maxPageSize", - "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -234,7 +225,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -268,7 +259,7 @@ "tags": [ "ApplicationData" ], - "description": "Returns a paginated list of application data resources across all farmers.", + "description": "Get a paginated list of application data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "ApplicationData_List", "produces": [ "application/json" @@ -277,35 +268,35 @@ { "in": "query", "name": "minAvgMaterial", - "description": "Minimum average amount of material applied during the application (inclusive).", + "description": "Application data with average material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgMaterial", - "description": "Maximum average amount of material applied during the application (inclusive).", + "description": " Application data with average material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTotalMaterial", - "description": "Minimum total amount of material applied during the application (inclusive).", + "description": "Application data with total material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalMaterial", - "description": "Maximum total amount of material applied during the application (inclusive).", + "description": "Application data with total material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Application data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -315,7 +306,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the application operation was done.", "type": "array", "items": { "type": "string" @@ -325,7 +316,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the application operation was carried out.", "type": "array", "items": { "type": "string" @@ -335,63 +326,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Application operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Application operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Application operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Application operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Application operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Application operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Application operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Application operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of application operations to be returned.", "type": "array", "items": { "type": "string" @@ -401,7 +392,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of application operations to be returned.", "type": "array", "items": { "type": "string" @@ -411,7 +402,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -421,7 +412,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Application data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -431,35 +422,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -475,7 +466,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -509,7 +500,7 @@ "tags": [ "ApplicationData" ], - "description": "Get a specified application data resource under a particular farmer.", + "description": "Get a specified application data resource for a given farmer.\n\n", "operationId": "ApplicationData_Get", "produces": [ "application/json" @@ -518,21 +509,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "applicationDataId", - "description": "ID of the application data resource.", + "description": "Id of the application data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -561,7 +552,7 @@ "tags": [ "ApplicationData" ], - "description": "Creates or updates an application data resource under a particular farmer.", + "description": "Create or update an application data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "ApplicationData_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -573,28 +564,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "applicationDataId", - "description": "ID of the application data resource.", + "description": "Id of the application data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "applicationData", - "description": "Application data resource payload to create or update.", + "description": "Application data resource payload to Create or update.", "schema": { "$ref": "#/definitions/ApplicationData" } @@ -630,7 +621,7 @@ "tags": [ "ApplicationData" ], - "description": "Deletes a specified application data resource under a particular farmer.", + "description": "Delete a specified application data resource for a given farmer.\n\n", "operationId": "ApplicationData_Delete", "produces": [ "application/json" @@ -639,21 +630,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "applicationDataId", - "description": "ID of the application data.", + "description": "Id of the application data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -676,12 +667,122 @@ } } }, + "/application-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get details of a cascade delete job for application data resource.\n\n", + "operationId": "ApplicationData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the application data cascade delete 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": { + "ApplicationData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ApplicationData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "ApplicationData" + ], + "description": "Create cascade delete job for application data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "ApplicationData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the application data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ApplicationData_CreateCascadeDeleteJob": { + "$ref": "./examples/ApplicationData_CreateCascadeDeleteJob.json" + } + } + } + }, "/farmers/{farmerId}/attachments": { "get": { "tags": [ "Attachments" ], - "description": "Returns a paginated list of attachment resources under a particular farmer.", + "description": "Get a paginated list of attachment resources for a given farmer and search criteria.\n\n", "operationId": "Attachments_ListByFarmerId", "produces": [ "application/json" @@ -690,14 +791,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "resourceIds", - "description": "Resource Ids of the resource.", + "description": "Attachments belonging to the given list of resources will be returned.", "type": "array", "items": { "type": "string" @@ -707,7 +808,7 @@ { "in": "query", "name": "resourceTypes", - "description": "Resource Types of the resource.", + "description": "Attachments belonging to the resources of the given resource types will be returned. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData.", "type": "array", "items": { "type": "string" @@ -717,7 +818,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "Ids of the attachments to be returned.", "type": "array", "items": { "type": "string" @@ -727,7 +828,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of attachments to be returned.", "type": "array", "items": { "type": "string" @@ -737,7 +838,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -747,7 +848,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Attachments with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -757,35 +858,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Attachments created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Attachments created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Attachments last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Attachments last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -801,7 +902,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -835,7 +936,7 @@ "tags": [ "Attachments" ], - "description": "Gets a specified attachment resource under a particular farmer.", + "description": "Get a specified attachment resource for a given farmer.\n\n", "operationId": "Attachments_Get", "produces": [ "application/json" @@ -844,21 +945,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "attachmentId", - "description": "ID of the attachment.", + "description": "Id of the attachment.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -887,7 +988,7 @@ "tags": [ "Attachments" ], - "description": "Creates or updates an attachment resource under a particular farmer.", + "description": "Create or update an attachment resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "Attachments_CreateOrUpdate", "consumes": [ "multipart/form-data" @@ -899,21 +1000,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "attachmentId", - "description": "ID of the attachment resource.", + "description": "Id of the attachment. This Id is unique for a given farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -927,37 +1028,37 @@ { "in": "formData", "name": "FarmerId", - "description": "Farmer id for this attachment.", + "description": "Id of the associated farmer.", "type": "string" }, { "in": "formData", "name": "ResourceId", - "description": "Associated Resource id for this attachment.", + "description": "This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data.", "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.", + "description": "Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData.", "type": "string" }, { "in": "formData", "name": "OriginalFileName", - "description": "Original File Name for this attachment.", + "description": "Original file name of the attachment.", "type": "string" }, { "in": "formData", "name": "Id", - "description": "Unique id.", + "description": "Unique Id of the attachment. This Id is unique for a given farmer.", "type": "string" }, { "in": "formData", "name": "Status", - "description": "Status of the resource.", + "description": "User provided status of the attachment.", "type": "string", "maxLength": 100, "minLength": 0 @@ -965,21 +1066,21 @@ { "in": "formData", "name": "CreatedDateTime", - "description": "Date when resource was created.", + "description": "UTC Date-time at which the attachment was created (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "formData", "name": "ModifiedDateTime", - "description": "Date when resource was last modified.", + "description": "UTC Date-time at which the attachment was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "formData", "name": "Name", - "description": "Name to identify resource.", + "description": "Name of the attachment.", "type": "string", "maxLength": 100, "minLength": 0 @@ -987,7 +1088,7 @@ { "in": "formData", "name": "Description", - "description": "Textual description of resource.", + "description": "Brief description of the attachment.", "type": "string", "maxLength": 500, "minLength": 0 @@ -995,7 +1096,7 @@ { "in": "formData", "name": "ETag", - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string" } ], @@ -1029,7 +1130,7 @@ "tags": [ "Attachments" ], - "description": "Deletes a specified attachment resource under a particular farmer.", + "description": "Delete a specified attachment resource for a given farmer.\n\n", "operationId": "Attachments_Delete", "produces": [ "application/json" @@ -1038,21 +1139,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "attachmentId", - "description": "ID of the attachment.", + "description": "Id of the attachment.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1080,7 +1181,7 @@ "tags": [ "Attachments" ], - "description": "Downloads and returns attachment as response for the given input filePath.", + "description": "Return attachment as a file stream for a given input filePath.\n\n", "operationId": "Attachments_Download", "produces": [ "application/octet-stream", @@ -1090,21 +1191,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "attachmentId", - "description": "ID of attachment to be downloaded.", + "description": "Id of attachment to be downloaded.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1136,7 +1237,7 @@ "tags": [ "Boundaries" ], - "description": "Returns a paginated list of boundary resources under a particular farmer.", + "description": "Get a paginated list of boundary resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Boundaries_ListByFarmerId", "produces": [ "application/json" @@ -1145,26 +1246,26 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "isPrimary", - "description": "Is the boundary primary.", + "description": "If set, only primary boundaries are returned.", "type": "boolean" }, { "in": "query", "name": "parentType", - "description": "Type of the parent it belongs to.", + "description": "Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'.", "type": "string" }, { "in": "query", "name": "parentIds", - "description": "Parent Ids of the resource.", + "description": "Boundaries associated with the given parent Ids are returned.", "type": "array", "items": { "type": "string" @@ -1174,21 +1275,21 @@ { "in": "query", "name": "minAcreage", - "description": "Minimum acreage of the boundary (inclusive).", + "description": "Boundaries with acreage equal to or greater than the given value are returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAcreage", - "description": "Maximum acreage of the boundary (inclusive).", + "description": "Boundaries with acreage equal to or lesser than the given value are returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of boundaries to be returned.", "type": "array", "items": { "type": "string" @@ -1198,7 +1299,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of boundaries to be returned.", "type": "array", "items": { "type": "string" @@ -1208,7 +1309,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -1218,7 +1319,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Boundaries with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -1228,35 +1329,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -1272,7 +1373,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1304,7 +1405,7 @@ "tags": [ "Boundaries" ], - "description": "Search for boundaries by fields and intersecting geometry.", + "description": "Search for boundaries of a farmer intersecting with a given geometry.\nThis API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List by Farmer Id' API for boundaries.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Boundaries_SearchByFarmerId", "consumes": [ "application/json" @@ -1316,14 +1417,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -1365,7 +1466,7 @@ "tags": [ "Boundaries" ], - "description": "Returns a paginated list of boundary resources across all farmers.", + "description": "Get a paginated list of boundary resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Boundaries_List", "produces": [ "application/json" @@ -1374,19 +1475,19 @@ { "in": "query", "name": "isPrimary", - "description": "Is the boundary primary.", + "description": "If set, only primary boundaries are returned.", "type": "boolean" }, { "in": "query", "name": "parentType", - "description": "Type of the parent it belongs to.", + "description": "Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'.", "type": "string" }, { "in": "query", "name": "parentIds", - "description": "Parent Ids of the resource.", + "description": "Boundaries associated with the given parent Ids are returned.", "type": "array", "items": { "type": "string" @@ -1396,21 +1497,21 @@ { "in": "query", "name": "minAcreage", - "description": "Minimum acreage of the boundary (inclusive).", + "description": "Boundaries with acreage equal to or greater than the given value are returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAcreage", - "description": "Maximum acreage of the boundary (inclusive).", + "description": "Boundaries with acreage equal to or lesser than the given value are returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of boundaries to be returned.", "type": "array", "items": { "type": "string" @@ -1420,7 +1521,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of boundaries to be returned.", "type": "array", "items": { "type": "string" @@ -1430,7 +1531,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -1440,7 +1541,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Boundaries with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -1450,35 +1551,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -1494,7 +1595,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1526,7 +1627,7 @@ "tags": [ "Boundaries" ], - "description": "Search for boundaries across all farmers by fields and intersecting geometry.", + "description": "Search for boundaries across all the farmers intersecting with a given geometry.\nThis API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List' API for boundaries.\n\n\r\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘Search by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Boundaries_Search", "consumes": [ "application/json" @@ -1538,7 +1639,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -1580,7 +1681,7 @@ "tags": [ "Boundaries" ], - "description": "Get cascade delete job for specified boundary.", + "description": "Get details of cascade delete job for a specified boundary.\n\n", "operationId": "Boundaries_GetCascadeDeleteJobDetails", "produces": [ "application/json" @@ -1589,14 +1690,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the boundary cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1625,7 +1726,7 @@ "tags": [ "Boundaries" ], - "description": "Create a cascade delete job for specified boundary.", + "description": "Create a cascade delete job for a specified boundary.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "Boundaries_CreateCascadeDeleteJob", "produces": [ "application/json" @@ -1634,28 +1735,28 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of the boundary cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "boundaryId", - "description": "ID of the boundary to be deleted.", + "description": "Id of the boundary to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1690,7 +1791,7 @@ "tags": [ "Boundaries" ], - "description": "Gets a specified boundary resource under a particular farmer.", + "description": "Get a specified boundary resource for a given farmer.\n\n", "operationId": "Boundaries_Get", "produces": [ "application/json" @@ -1699,21 +1800,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "boundaryId", - "description": "ID of the boundary.", + "description": "Id of the boundary.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1742,7 +1843,7 @@ "tags": [ "Boundaries" ], - "description": "Creates or updates a boundary resource.", + "description": "Create or update a boundary resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Boundaries_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -1754,28 +1855,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "boundaryId", - "description": "ID of the boundary resource.", + "description": "Unique Id of the boundary. This Id is unique for a given farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "boundary", - "description": "Boundary resource payload to create or update.", + "description": "Boundary resource payload to Create or update.", "schema": { "$ref": "#/definitions/Boundary" } @@ -1811,7 +1912,7 @@ "tags": [ "Boundaries" ], - "description": "Deletes a specified boundary resource under a particular farmer.", + "description": "Delete a specified boundary resource for a given farmer. It can only be deleted if it has no linked attachments, satellite or weather data.\n\n", "operationId": "Boundaries_Delete", "produces": [ "application/json" @@ -1820,21 +1921,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "boundaryId", - "description": "ID of the boundary.", + "description": "Id of the boundary to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1862,7 +1963,7 @@ "tags": [ "Boundaries" ], - "description": "Returns overlapping acreage between two boundary Ids.", + "description": "Get overlapping (intersecting) acreage between two boundaries.\n\n", "operationId": "Boundaries_GetOverlap", "produces": [ "application/json" @@ -1871,35 +1972,35 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the farmer associated with the given boundary.", "required": true, "type": "string" }, { "in": "path", "name": "boundaryId", - "description": "ID of the boundary.", + "description": "Id of the given boundary.", "required": true, "type": "string" }, { "in": "query", "name": "otherFarmerId", - "description": "FarmerId of the other field.", + "description": "Id of the farmer associated with the other boundary.", "required": true, "type": "string" }, { "in": "query", "name": "otherBoundaryId", - "description": "ID of the other boundary.", + "description": "Id of the other boundary.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -1930,7 +2031,7 @@ "tags": [ "Crops" ], - "description": "Returns a paginated list of crop resources.", + "description": "Get a paginated list of crop resources.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Crops_List", "produces": [ "application/json" @@ -1939,7 +2040,7 @@ { "in": "query", "name": "phenotypes", - "description": "Crop phenotypes of the resource.", + "description": "Crops with the given list of phenotypes are returned.", "type": "array", "items": { "type": "string" @@ -1949,7 +2050,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of crops to be returned.", "type": "array", "items": { "type": "string" @@ -1959,7 +2060,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of crops to be returned.", "type": "array", "items": { "type": "string" @@ -1969,7 +2070,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -1979,7 +2080,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Crops with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -1989,35 +2090,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -2033,7 +2134,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2067,7 +2168,7 @@ "tags": [ "Crops" ], - "description": "Gets a specified crop resource.", + "description": "Get a specified crop resource.\n\n", "operationId": "Crops_Get", "produces": [ "application/json" @@ -2076,14 +2177,14 @@ { "in": "path", "name": "cropId", - "description": "ID of the crop.", + "description": "Id of the crop.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2112,7 +2213,7 @@ "tags": [ "Crops" ], - "description": "Creates or updates a crop resource.", + "description": "Create or update a crop resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Crops_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -2124,14 +2225,14 @@ { "in": "path", "name": "cropId", - "description": "ID of the crop resource.", + "description": "Id of the crop resource. This Id is unique for a given tenant.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -2174,7 +2275,7 @@ "tags": [ "Crops" ], - "description": "Deletes Crop for given crop id.", + "description": "Delete a specified crop resource.\n\n", "operationId": "Crops_Delete", "produces": [ "application/json" @@ -2183,14 +2284,14 @@ { "in": "path", "name": "cropId", - "description": "ID of crop to be deleted.", + "description": "Id of crop to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2218,7 +2319,7 @@ "tags": [ "CropVarieties" ], - "description": "Returns a paginated list of crop variety resources under a particular crop.", + "description": "Get a paginated list of crop variety resources for a given crop and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "CropVarieties_ListByCropId", "produces": [ "application/json" @@ -2227,14 +2328,14 @@ { "in": "path", "name": "cropId", - "description": "ID of the associated crop.", + "description": "Id of the associated crop.", "required": true, "type": "string" }, { "in": "query", "name": "cropIds", - "description": "CropIds of the resource.", + "description": "Crop varieties associated with the given list of crop ids are returned.", "type": "array", "items": { "type": "string" @@ -2244,7 +2345,7 @@ { "in": "query", "name": "brands", - "description": "Brands of the resource.", + "description": "Crop varieties associated with the given list of brands are returned.", "type": "array", "items": { "type": "string" @@ -2254,7 +2355,7 @@ { "in": "query", "name": "products", - "description": "Products of the resource.", + "description": "Crop varieties associated with the given list of products are returned.", "type": "array", "items": { "type": "string" @@ -2264,7 +2365,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of crop varieties to be returned.", "type": "array", "items": { "type": "string" @@ -2274,7 +2375,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of crop varieties to be returned.", "type": "array", "items": { "type": "string" @@ -2284,7 +2385,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -2294,7 +2395,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Crop varieties with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -2304,35 +2405,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -2348,7 +2449,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2382,7 +2483,7 @@ "tags": [ "CropVarieties" ], - "description": "Returns a paginated list of crop variety resources across all crops.", + "description": "Get a paginated list of crop variety resources across all the crops for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the crop Id is available, it is strongly recommended to use **‘List by Crop Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "CropVarieties_List", "produces": [ "application/json" @@ -2391,7 +2492,7 @@ { "in": "query", "name": "cropIds", - "description": "CropIds of the resource.", + "description": "Crop varieties associated with the given list of crop ids are returned.", "type": "array", "items": { "type": "string" @@ -2401,7 +2502,7 @@ { "in": "query", "name": "brands", - "description": "Brands of the resource.", + "description": "Crop varieties associated with the given list of brands are returned.", "type": "array", "items": { "type": "string" @@ -2411,7 +2512,7 @@ { "in": "query", "name": "products", - "description": "Products of the resource.", + "description": "Crop varieties associated with the given list of products are returned.", "type": "array", "items": { "type": "string" @@ -2421,7 +2522,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of crop varieties to be returned.", "type": "array", "items": { "type": "string" @@ -2431,7 +2532,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of crop varieties to be returned.", "type": "array", "items": { "type": "string" @@ -2441,7 +2542,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -2451,7 +2552,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Crop varieties with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -2461,35 +2562,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -2505,7 +2606,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2539,7 +2640,7 @@ "tags": [ "CropVarieties" ], - "description": "Gets a specified crop variety resource under a particular crop.", + "description": "Get a specified crop variety resource for a given crop.\n\n", "operationId": "CropVarieties_Get", "produces": [ "application/json" @@ -2548,21 +2649,21 @@ { "in": "path", "name": "cropId", - "description": "ID of the associated crop.", + "description": "Id of the associated crop.", "required": true, "type": "string" }, { "in": "path", "name": "cropVarietyId", - "description": "ID of the crop variety.", + "description": "Id of the crop variety.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2591,7 +2692,7 @@ "tags": [ "CropVarieties" ], - "description": "Creates or updates a crop variety resource.", + "description": "Create or update a crop variety resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "CropVarieties_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -2603,21 +2704,21 @@ { "in": "path", "name": "cropId", - "description": "ID of the crop resource.", + "description": "Id of the associated crop.", "required": true, "type": "string" }, { "in": "path", "name": "cropVarietyId", - "description": "ID of the crop variety resource.", + "description": "Unique Id of the crop variety. This Is is unique for a given crop.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -2660,7 +2761,7 @@ "tags": [ "CropVarieties" ], - "description": "Deletes a specified crop variety resource under a particular crop.", + "description": "Delete a specified crop variety resource for a given crop.\n\n", "operationId": "CropVarieties_Delete", "produces": [ "application/json" @@ -2669,21 +2770,21 @@ { "in": "path", "name": "cropId", - "description": "ID of the crop.", + "description": "Id of the associated crop.", "required": true, "type": "string" }, { "in": "path", "name": "cropVarietyId", - "description": "ID of the crop variety.", + "description": "Id of the crop variety to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2711,7 +2812,7 @@ "tags": [ "Farmers" ], - "description": "Returns a paginated list of farmer resources.", + "description": "Get a paginated list of farmer resources for a given search criteria.\n\n", "operationId": "Farmers_List", "produces": [ "application/json" @@ -2720,7 +2821,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of farmers to be returned.", "type": "array", "items": { "type": "string" @@ -2730,7 +2831,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of farmers to be returned.", "type": "array", "items": { "type": "string" @@ -2740,7 +2841,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -2750,7 +2851,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Farmers with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -2760,35 +2861,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -2804,7 +2905,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2838,7 +2939,7 @@ "tags": [ "Farmers" ], - "description": "Gets a specified farmer resource.", + "description": "Get a specified farmer resource.\n\n", "operationId": "Farmers_Get", "produces": [ "application/json" @@ -2847,14 +2948,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "ID of the farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2883,7 +2984,7 @@ "tags": [ "Farmers" ], - "description": "Creates or updates a farmer resource.", + "description": "Create or update a farmer resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Farmers_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -2895,14 +2996,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer resource.", + "description": "Id of the farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -2945,7 +3046,7 @@ "tags": [ "Farmers" ], - "description": "Deletes a specified farmer resource.", + "description": "Delete a specified farmer resource. It can only be deleted if it has no linked attachments or farms.\n\n", "operationId": "Farmers_Delete", "produces": [ "application/json" @@ -2954,14 +3055,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of farmer to be deleted.", + "description": "Id of farmer to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -2989,7 +3090,7 @@ "tags": [ "Farmers" ], - "description": "Get a cascade delete job for specified farmer.", + "description": "Get details of a cascade delete job for a specified farmer.\n\n", "operationId": "Farmers_GetCascadeDeleteJobDetails", "produces": [ "application/json" @@ -2998,14 +3099,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the farmer cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3034,7 +3135,7 @@ "tags": [ "Farmers" ], - "description": "Create a cascade delete job for specified farmer.", + "description": "Create a cascade delete job for a specified farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "Farmers_CreateCascadeDeleteJob", "produces": [ "application/json" @@ -3043,21 +3144,21 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of the farmer cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "farmerId", - "description": "ID of the farmer to be deleted.", + "description": "Id of the farmer to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3092,7 +3193,7 @@ "tags": [ "FarmOperations" ], - "description": "Create a farm operation data ingestion job.", + "description": "Create a farm operation data ingestion job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "FarmOperations_CreateDataIngestionJob", "consumes": [ "application/json" @@ -3104,21 +3205,21 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by user.", + "description": "Id of the farm operation data ingestion job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "job", - "description": "Job parameters supplied by user.", + "description": "Job parameters supplied by the user.", "schema": { "$ref": "#/definitions/FarmOperationDataIngestionJob" } @@ -3152,7 +3253,7 @@ "tags": [ "FarmOperations" ], - "description": "Get a farm operation data ingestion job.", + "description": "Get details of a farm operation data ingestion job.\n\n", "operationId": "FarmOperations_GetDataIngestionJobDetails", "produces": [ "application/json" @@ -3161,14 +3262,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the farm operation data ingestion job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3199,7 +3300,7 @@ "tags": [ "Farms" ], - "description": "Returns a paginated list of farm resources under a particular farmer.", + "description": "Get a paginated list of farm resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Farms_ListByFarmerId", "produces": [ "application/json" @@ -3208,14 +3309,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of farms to be returned.", "type": "array", "items": { "type": "string" @@ -3225,7 +3326,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of farms to be returned.", "type": "array", "items": { "type": "string" @@ -3235,7 +3336,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -3245,7 +3346,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Farms with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -3255,35 +3356,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -3299,7 +3400,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3333,7 +3434,7 @@ "tags": [ "Farms" ], - "description": "Returns a paginated list of farm resources across all farmers.", + "description": "Get a paginated list of farm resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Farms_List", "produces": [ "application/json" @@ -3342,7 +3443,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of farms to be returned.", "type": "array", "items": { "type": "string" @@ -3352,7 +3453,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of farms to be returned.", "type": "array", "items": { "type": "string" @@ -3362,7 +3463,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -3372,7 +3473,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Farms with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -3382,35 +3483,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -3426,7 +3527,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3460,7 +3561,7 @@ "tags": [ "Farms" ], - "description": "Gets a specified farm resource under a particular farmer.", + "description": "Get a specified farm resource for a given farmer.\n\n", "operationId": "Farms_Get", "produces": [ "application/json" @@ -3469,21 +3570,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "farmId", - "description": "ID of the farm resource.", + "description": "ID of the farm.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3512,7 +3613,7 @@ "tags": [ "Farms" ], - "description": "Creates or updates a farm resource under a particular farmer.", + "description": "Create or update a farm resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Farms_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -3524,21 +3625,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "farmId", - "description": "ID of the farm resource.", + "description": "Unique Id of the farm. This Id is unique for a given farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -3581,7 +3682,7 @@ "tags": [ "Farms" ], - "description": "Deletes a specified farm resource under a particular farmer.", + "description": "Delete a specified farm resource for a given farmer. It can only be deleted if it has no linked attachments, fields or seasonal fields.\n\n", "operationId": "Farms_Delete", "produces": [ "application/json" @@ -3590,21 +3691,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the farmer.", "required": true, "type": "string" }, { "in": "path", "name": "farmId", - "description": "ID of the farm.", + "description": "Id of the farm to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3632,7 +3733,7 @@ "tags": [ "Farms" ], - "description": "Get a cascade delete job for specified farm.", + "description": "Get details of cascade delete job for a specified farm.\n\n", "operationId": "Farms_GetCascadeDeleteJobDetails", "produces": [ "application/json" @@ -3641,14 +3742,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the farm cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3677,7 +3778,7 @@ "tags": [ "Farms" ], - "description": "Create a cascade delete job for specified farm.", + "description": "Create a cascade delete job for a specified farm.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "Farms_CreateCascadeDeleteJob", "produces": [ "application/json" @@ -3686,7 +3787,7 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of the farm cascade delete job.", "required": true, "type": "string" }, @@ -3707,7 +3808,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3742,7 +3843,7 @@ "tags": [ "Fields" ], - "description": "Returns a paginated list of field resources under a particular farmer.", + "description": "Get a paginated list of field resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Fields_ListByFarmerId", "produces": [ "application/json" @@ -3751,14 +3852,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "farmIds", - "description": "Farm Ids of the resource.", + "description": "Fields associated with the given list of farms are returned.", "type": "array", "items": { "type": "string" @@ -3768,7 +3869,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of fields to be returned.", "type": "array", "items": { "type": "string" @@ -3778,7 +3879,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of fields to be returned.", "type": "array", "items": { "type": "string" @@ -3788,7 +3889,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -3798,7 +3899,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Fields with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -3808,35 +3909,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -3852,7 +3953,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -3886,7 +3987,7 @@ "tags": [ "Fields" ], - "description": "Returns a paginated list of field resources across all farmers.", + "description": "Get a paginated list of field resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Fields_List", "produces": [ "application/json" @@ -3895,7 +3996,7 @@ { "in": "query", "name": "farmIds", - "description": "Farm Ids of the resource.", + "description": "Fields associated with the given list of farms are returned.", "type": "array", "items": { "type": "string" @@ -3905,7 +4006,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of fields to be returned.", "type": "array", "items": { "type": "string" @@ -3915,7 +4016,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of fields to be returned.", "type": "array", "items": { "type": "string" @@ -3925,7 +4026,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -3935,7 +4036,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Fields with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -3945,35 +4046,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -3989,7 +4090,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4023,7 +4124,7 @@ "tags": [ "Fields" ], - "description": "Gets a specified field resource under a particular farmer.", + "description": "Get a specified field resource for a given farmer.\n\n", "operationId": "Fields_Get", "produces": [ "application/json" @@ -4032,21 +4133,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "fieldId", - "description": "ID of the field.", + "description": "Id of the field.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4075,7 +4176,7 @@ "tags": [ "Fields" ], - "description": "Creates or Updates a field resource under a particular farmer.", + "description": "Create or update a field resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Fields_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -4087,28 +4188,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "fieldId", - "description": "ID of the field resource.", + "description": "Unique Id of the field. This Id is unique for a given farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "field", - "description": "Field resource payload to create or update.", + "description": "Field resource payload to Create or update.", "schema": { "$ref": "#/definitions/Field" } @@ -4144,7 +4245,7 @@ "tags": [ "Fields" ], - "description": "Deletes a specified field resource under a particular farmer.", + "description": "Delete a specified field resource for a given farmer. It can only be deleted if it has no linked attachments, boundaries or seasonal fields.\n\n", "operationId": "Fields_Delete", "produces": [ "application/json" @@ -4153,21 +4254,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "fieldId", - "description": "ID of the field.", + "description": "Id of the field to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4195,7 +4296,7 @@ "tags": [ "Fields" ], - "description": "Get a cascade delete job for specified field.", + "description": "Get details of cascade delete job for a specified field.\n\n", "operationId": "Fields_GetCascadeDeleteJobDetails", "produces": [ "application/json" @@ -4204,14 +4305,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of field cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4240,7 +4341,7 @@ "tags": [ "Fields" ], - "description": "Create a cascade delete job for specified field.", + "description": "Create a cascade delete job for specified field.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "Fields_CreateCascadeDeleteJob", "produces": [ "application/json" @@ -4249,14 +4350,14 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of field cascade delete job. This Id is unique for a given tenant.", "required": true, "type": "string" }, { "in": "query", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, @@ -4270,7 +4371,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4305,7 +4406,7 @@ "tags": [ "HarvestData" ], - "description": "Returns a paginated list of harvest data resources under a particular farm.", + "description": "Get a paginated list of harvest data resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "HarvestData_ListByFarmerId", "produces": [ "application/json" @@ -4314,98 +4415,98 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "minTotalYield", - "description": "Minimum Yield value(inclusive).", + "description": "Harvest data with total yield greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalYield", - "description": "Maximum Yield value (inclusive).", + "description": "Harvest data with total yield lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgYield", - "description": "Minimum AvgYield value(inclusive).", + "description": "Harvest data with average yield greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgYield", - "description": "Maximum AvgYield value (inclusive).", + "description": "Harvest data with average yield lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTotalWetMass", - "description": "Minimum Total WetMass value(inclusive).", + "description": "Harvest data with total wet mass greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalWetMass", - "description": "Maximum Total WetMass value (inclusive).", + "description": "Harvest data with total wet mass lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgWetMass", - "description": "Minimum AvgWetMass value(inclusive).", + "description": "Harvest data with average wet mass greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgWetMass", - "description": "Maximum AvgWetMass value (inclusive).", + "description": "Harvest data with average wet mass lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgMoisture", - "description": "Minimum AvgMoisture value(inclusive).", + "description": "Harvest data with average moisture greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgMoisture", - "description": "Maximum AvgMoisture value (inclusive).", + "description": "Harvest data with average moisture lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgSpeed", - "description": "Minimum AvgSpeed value(inclusive).", + "description": "Harvest data with average speed greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgSpeed", - "description": "Maximum AvgSpeed value (inclusive).", + "description": "Harvest data with average speed lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Harvest data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -4415,7 +4516,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the harvest operation was done.", "type": "array", "items": { "type": "string" @@ -4425,7 +4526,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out.", "type": "array", "items": { "type": "string" @@ -4435,63 +4536,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Harvest operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Harvest operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Harvest operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Harvest operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Harvest operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Harvest operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Harvest operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Harvest operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of harvest operations to be returned.", "type": "array", "items": { "type": "string" @@ -4501,7 +4602,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of harvest operations to be returned.", "type": "array", "items": { "type": "string" @@ -4511,7 +4612,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -4521,7 +4622,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Harvest data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -4531,35 +4632,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -4575,7 +4676,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4609,7 +4710,7 @@ "tags": [ "HarvestData" ], - "description": "Returns a paginated list of harvest data resources across all farmers.", + "description": "Get a paginated list of harvest data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "HarvestData_List", "produces": [ "application/json" @@ -4618,91 +4719,91 @@ { "in": "query", "name": "minTotalYield", - "description": "Minimum Yield value(inclusive).", + "description": "Harvest data with total yield greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalYield", - "description": "Maximum Yield value (inclusive).", + "description": "Harvest data with total yield lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgYield", - "description": "Minimum AvgYield value(inclusive).", + "description": "Harvest data with average yield greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgYield", - "description": "Maximum AvgYield value (inclusive).", + "description": "Harvest data with average yield lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTotalWetMass", - "description": "Minimum Total WetMass value(inclusive).", + "description": "Harvest data with total wet mass greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalWetMass", - "description": "Maximum Total WetMass value (inclusive).", + "description": "Harvest data with total wet mass lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgWetMass", - "description": "Minimum AvgWetMass value(inclusive).", + "description": "Harvest data with average wet mass greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgWetMass", - "description": "Maximum AvgWetMass value (inclusive).", + "description": "Harvest data with average wet mass lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgMoisture", - "description": "Minimum AvgMoisture value(inclusive).", + "description": "Harvest data with average moisture greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgMoisture", - "description": "Maximum AvgMoisture value (inclusive).", + "description": "Harvest data with average moisture lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgSpeed", - "description": "Minimum AvgSpeed value(inclusive).", + "description": "Harvest data with average speed greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgSpeed", - "description": "Maximum AvgSpeed value (inclusive).", + "description": "Harvest data with average speed lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Harvest data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -4712,7 +4813,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the harvest operation was done.", "type": "array", "items": { "type": "string" @@ -4722,7 +4823,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out.", "type": "array", "items": { "type": "string" @@ -4732,63 +4833,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Harvest operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Harvest operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Harvest operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Harvest operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Harvest operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Harvest operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Harvest operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Harvest operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of harvest operations to be returned.", "type": "array", "items": { "type": "string" @@ -4798,7 +4899,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of harvest operations to be returned.", "type": "array", "items": { "type": "string" @@ -4808,7 +4909,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -4818,7 +4919,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Harvest data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -4828,35 +4929,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -4872,7 +4973,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4906,7 +5007,7 @@ "tags": [ "HarvestData" ], - "description": "Get a specified harvest data resource under a particular farmer.", + "description": "Get a specified harvest data resource for a given farmer.\n\n", "operationId": "HarvestData_Get", "produces": [ "application/json" @@ -4915,21 +5016,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "harvestDataId", - "description": "ID of the harvest data resource.", + "description": "Id of the harvest data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -4958,7 +5059,7 @@ "tags": [ "HarvestData" ], - "description": "Creates or updates harvest data resource under a particular farmer.", + "description": "Create or update harvest data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "HarvestData_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -4970,28 +5071,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "harvestDataId", - "description": "ID of the harvest data resource.", + "description": "IDd of the harvest data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "harvestData", - "description": "Harvest data resource payload to create or update.", + "description": "Harvest data resource payload to Create or update.", "schema": { "$ref": "#/definitions/HarvestData" } @@ -5027,7 +5128,7 @@ "tags": [ "HarvestData" ], - "description": "Deletes a specified harvest data resource under a particular farmer.", + "description": "Delete a specified harvest data resource for a given farmer.\n\n", "operationId": "HarvestData_Delete", "produces": [ "application/json" @@ -5036,21 +5137,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "harvestDataId", - "description": "ID of the harvest data.", + "description": "Id of the harvest data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5073,12 +5174,122 @@ } } }, + "/harvest-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get details of a cascade delete job for harvest data resource.\n\n", + "operationId": "HarvestData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the harvest data cascade delete 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": { + "HarvestData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/HarvestData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "HarvestData" + ], + "description": "Create cascade delete job for harvest data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "HarvestData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the harvest data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "HarvestData_CreateCascadeDeleteJob": { + "$ref": "./examples/HarvestData_CreateCascadeDeleteJob.json" + } + } + } + }, "/image-processing/rasterize/{jobId}": { "put": { "tags": [ "ImageProcessing" ], - "description": "Create a ImageProcessing Rasterize job.", + "description": "Create a job which converts shape files into raster images.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "ImageProcessing_CreateRasterizeJob", "consumes": [ "application/json" @@ -5090,21 +5301,21 @@ { "in": "path", "name": "jobId", - "description": "JobId provided by user.", + "description": "Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "job", - "description": "Job parameters supplied by user.", + "description": "Job parameters supplied by the user.", "schema": { "$ref": "#/definitions/ImageProcessingRasterizeJob" } @@ -5135,7 +5346,7 @@ "tags": [ "ImageProcessing" ], - "description": "Get ImageProcessing Rasterize job's details.", + "description": "Get details of rasterize job. Rasterize job converts shape files into raster images.\n\n", "operationId": "ImageProcessing_GetRasterizeJob", "produces": [ "application/json" @@ -5144,14 +5355,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the image processing (rasterize) job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5176,7 +5387,7 @@ "tags": [ "OAuthProviders" ], - "description": "Returns a paginated list of oauthProvider resources.", + "description": "Get a paginated list of OAuth provider resources for a given search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "OAuthProviders_List", "produces": [ "application/json" @@ -5185,7 +5396,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of OAuth providers to be returned.", "type": "array", "items": { "type": "string" @@ -5195,7 +5406,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of OAuth providers to be returned.", "type": "array", "items": { "type": "string" @@ -5205,7 +5416,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -5215,7 +5426,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "OAuth providers with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -5225,35 +5436,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -5269,7 +5480,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5303,7 +5514,7 @@ "tags": [ "OAuthProviders" ], - "description": "Get a specified oauthProvider resource.", + "description": "Get a specified OAuth provider resource.\n\n", "operationId": "OAuthProviders_Get", "produces": [ "application/json" @@ -5312,14 +5523,14 @@ { "in": "path", "name": "oauthProviderId", - "description": "ID of the oauthProvider resource.", + "description": "Id of the OAuth provider resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5348,7 +5559,7 @@ "tags": [ "OAuthProviders" ], - "description": "Creates or updates an oauthProvider resource.", + "description": "Create or update an OAuth provider resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "OAuthProviders_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -5360,21 +5571,21 @@ { "in": "path", "name": "oauthProviderId", - "description": "ID of oauthProvider resource.", + "description": "Id of the OAuth provider resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "oauthProvider", - "description": "OauthProvider resource payload to create or update.", + "description": "OauthProvider resource payload to Create or update.", "schema": { "$ref": "#/definitions/OAuthProvider" } @@ -5410,7 +5621,7 @@ "tags": [ "OAuthProviders" ], - "description": "Deletes an specified oauthProvider resource.", + "description": "Delete a specified OAuth provider resource.\n\n", "operationId": "OAuthProviders_Delete", "produces": [ "application/json" @@ -5419,14 +5630,14 @@ { "in": "path", "name": "oauthProviderId", - "description": "ID of oauthProvider.", + "description": "Id of the OAuth provider resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5449,75 +5660,178 @@ } } }, - "/oauth/tokens": { + "/oauth/providers/cascade-delete/{jobId}": { "get": { "tags": [ - "OAuthTokens" + "OAuthProviders" ], - "description": "Returns a list of OAuthToken documents.", - "operationId": "OAuthTokens_List", + "description": "Get details of cascade delete job for an OAuth provider resource.\n\n", + "operationId": "OAuthProviders_GetCascadeDeleteJobDetails", "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": "path", + "name": "jobId", + "description": "Id of the OAuth provider cascade delete job.", + "required": true, + "type": "string" }, { "in": "query", - "name": "isValid", - "description": "If the token object is valid.", - "type": "boolean" + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } }, - { - "in": "query", - "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", - "type": "string", + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthProviders_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthProviders_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthProviders" + ], + "description": "Create cascade delete job for an OAuth provider resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "OAuthProviders_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the OAuth provider cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the OAuth provider resource.", + "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/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthProviders_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthProviders_CreateCascadeDeleteJob.json" + } + } + } + }, + "/oauth/tokens": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Get a list of OAuthToken documents for a given search criteria.\n\n", + "operationId": "OAuthTokens_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "authProviderIds", + "description": "List of Ids of OAuth providers to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "farmerIds", + "description": "List of Ids of associated farmers.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "isValid", + "description": "If set, only valid (non expired) OAuth tokens are returned.", + "type": "boolean" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -5533,7 +5847,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5567,7 +5881,7 @@ "tags": [ "OAuthTokens" ], - "description": "Returns Connection link needed in the OAuth flow.", + "description": "Get connection link needed in the OAuth flow.\n\n", "operationId": "OAuthTokens_GetOAuthConnectionLink", "consumes": [ "application/json" @@ -5579,7 +5893,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, @@ -5618,7 +5932,7 @@ "tags": [ "OAuthTokens" ], - "description": "Get cascade delete job details for OAuth tokens for specified job ID.", + "description": "Get details of OAuth token remove job.\n\n", "operationId": "OAuthTokens_GetCascadeDeleteJobDetails", "produces": [ "application/json" @@ -5627,14 +5941,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the OAuth token removal job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5663,7 +5977,7 @@ "tags": [ "OAuthTokens" ], - "description": "Create a cascade delete job for OAuth tokens.", + "description": "Create job to remove OAuth token.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "OAuthTokens_CreateCascadeDeleteJob", "produces": [ "application/json" @@ -5672,28 +5986,28 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of the OAuth token removal job.", "required": true, "type": "string" }, { "in": "query", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "oauthProviderId", - "description": "ID of the OAuthProvider.", + "description": "Id of the OAuth provider resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5728,7 +6042,7 @@ "tags": [ "PlantingData" ], - "description": "Returns a paginated list of planting data resources under a particular farm.", + "description": "Get a paginated list of planting data resources for a given farm and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "PlantingData_ListByFarmerId", "produces": [ "application/json" @@ -5737,56 +6051,56 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "minAvgPlantingRate", - "description": "Minimum AvgPlantingRate value(inclusive).", + "description": "Planting data with average planting rate greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgPlantingRate", - "description": "Maximum AvgPlantingRate value (inclusive).", + "description": "Planting data with average planting rate lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTotalMaterial", - "description": "Minimum TotalMaterial value(inclusive).", + "description": "Planting data with total material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalMaterial", - "description": "Maximum TotalMaterial value (inclusive).", + "description": "Planting data with total material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgMaterial", - "description": "Minimum AvgMaterial value(inclusive).", + "description": "Planting data with average material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgMaterial", - "description": "Maximum AvgMaterial value (inclusive).", + "description": "Planting data with total material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Planting data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -5796,7 +6110,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the planting operation was done.", "type": "array", "items": { "type": "string" @@ -5806,7 +6120,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the planting operation was carried out.", "type": "array", "items": { "type": "string" @@ -5816,63 +6130,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Planting operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Planting operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Planting operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Planting operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Planting operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Planting operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Planting operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Planting operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of planting operations to be returned.", "type": "array", "items": { "type": "string" @@ -5882,7 +6196,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of planting operations to be returned.", "type": "array", "items": { "type": "string" @@ -5892,7 +6206,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -5902,7 +6216,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Planting data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -5912,35 +6226,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -5956,7 +6270,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -5990,7 +6304,7 @@ "tags": [ "PlantingData" ], - "description": "Returns a paginated list of planting data resources across all farmers.", + "description": "Get a paginated list of planting data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "PlantingData_List", "produces": [ "application/json" @@ -5999,49 +6313,49 @@ { "in": "query", "name": "minAvgPlantingRate", - "description": "Minimum AvgPlantingRate value(inclusive).", + "description": "Planting data with average planting rate greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgPlantingRate", - "description": "Maximum AvgPlantingRate value (inclusive).", + "description": "Planting data with average planting rate lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTotalMaterial", - "description": "Minimum TotalMaterial value(inclusive).", + "description": "Planting data with total material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTotalMaterial", - "description": "Maximum TotalMaterial value (inclusive).", + "description": "Planting data with total material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minAvgMaterial", - "description": "Minimum AvgMaterial value(inclusive).", + "description": "Planting data with average material greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgMaterial", - "description": "Maximum AvgMaterial value (inclusive).", + "description": "Planting data with average material lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Planting data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -6051,7 +6365,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the planting operation was done.", "type": "array", "items": { "type": "string" @@ -6061,7 +6375,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the planting operation was carried out.", "type": "array", "items": { "type": "string" @@ -6071,63 +6385,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Planting operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Planting operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Planting operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Planting operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Planting operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Planting operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Planting operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Planting operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of planting operations to be returned.", "type": "array", "items": { "type": "string" @@ -6137,7 +6451,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of planting operations to be returned.", "type": "array", "items": { "type": "string" @@ -6147,7 +6461,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -6157,7 +6471,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Planting data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -6167,35 +6481,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -6211,7 +6525,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6245,7 +6559,7 @@ "tags": [ "PlantingData" ], - "description": "Get a specified planting data resource under a particular farmer.", + "description": "Get a specified planting data resource for a given farmer.\n\n", "operationId": "PlantingData_Get", "produces": [ "application/json" @@ -6254,21 +6568,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "plantingDataId", - "description": "ID of the planting data resource.", + "description": "Id of the planting data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6297,7 +6611,7 @@ "tags": [ "PlantingData" ], - "description": "Creates or updates an planting data resource under a particular farmer.", + "description": "Create or update a planting data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "PlantingData_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -6309,28 +6623,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "plantingDataId", - "description": "ID of the planting data resource.", + "description": "Id of the planting data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "plantingData", - "description": "Planting data resource payload to create or update.", + "description": "Planting data resource payload to Create or update.", "schema": { "$ref": "#/definitions/PlantingData" } @@ -6366,7 +6680,7 @@ "tags": [ "PlantingData" ], - "description": "Deletes a specified planting data resource under a particular farmer.", + "description": "Delete a specified planting data resource under a particular farmer.\n\n", "operationId": "PlantingData_Delete", "produces": [ "application/json" @@ -6375,21 +6689,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "plantingDataId", - "description": "ID of the planting data.", + "description": "Id of the planting data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6412,12 +6726,122 @@ } } }, + "/planting-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get details of a cascade delete job for planting data resource.\n\n", + "operationId": "PlantingData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the planting data cascade delete 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": { + "PlantingData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantingData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "PlantingData" + ], + "description": "Create cascade delete job for planting data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "PlantingData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the planting data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantingData_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantingData_CreateCascadeDeleteJob.json" + } + } + } + }, "/scenes": { "get": { "tags": [ "Scenes" ], - "description": "Returns a paginated list of scene resources.", + "description": "Get a paginated list of scene resources for a given search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n2. This API will retrieve scenes present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested satellite data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user.\n\n", "operationId": "Scenes_List", "produces": [ "application/json" @@ -6426,7 +6850,7 @@ { "in": "query", "name": "provider", - "description": "Provider name of scene data.", + "description": "Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider.", "required": true, "type": "string", "default": "Microsoft" @@ -6434,42 +6858,42 @@ { "in": "query", "name": "farmerId", - "description": "FarmerId.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "boundaryId", - "description": "BoundaryId.", + "description": "Id of the associated boundary.", "required": true, "type": "string" }, { "in": "query", "name": "source", - "description": "Source name of scene data, default value Sentinel_2_L2A (Sentinel 2 L2A).", + "description": "Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation.", "type": "string", "default": "Sentinel_2_L2A" }, { "in": "query", "name": "startDateTime", - "description": "Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.", + "description": "Scenes that were captured/made available (at source) at or after this UTC Date-time is returned (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.", + "description": "Scenes that were captured/made available (at source) at or before this UTC Date-time is returned (format: yyyy-MM-ddTHH: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].", + "description": "Scenes with cloud cover less than or equal to the given value are returned. Range [0 to 100.0].", "type": "number", "format": "double", "default": 100, @@ -6479,7 +6903,7 @@ { "in": "query", "name": "maxDarkPixelCoveragePercentage", - "description": "Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].", + "description": "Scenes with dark pixel cover less than or equal to the given value are returned. Range [0 to 100.0].", "type": "number", "format": "double", "default": 100, @@ -6489,7 +6913,7 @@ { "in": "query", "name": "imageNames", - "description": "List of image names to be filtered.", + "description": "List of names of images to be fetched.\r\nFor Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', 'dataMask', sunAzimuthAngles, sunZenithAngles, viewAzimuthMean and viewZenithMean.", "type": "array", "items": { "type": "string" @@ -6499,7 +6923,7 @@ { "in": "query", "name": "imageResolutions", - "description": "List of image resolutions in meters to be filtered.", + "description": "List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60.", "type": "array", "items": { "format": "double", @@ -6510,7 +6934,7 @@ { "in": "query", "name": "imageFormats", - "description": "List of image formats to be filtered.", + "description": "Format in which the scenes are to be returned. Available value: TIF.", "type": "array", "items": { "type": "string" @@ -6520,7 +6944,7 @@ { "in": "query", "name": "$maxPageSize", - "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -6536,7 +6960,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6570,7 +6994,7 @@ "tags": [ "Scenes" ], - "description": "Create a satellite data ingestion job.", + "description": "Create a satellite data ingestion job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Scenes_CreateSatelliteDataIngestionJob", "consumes": [ "application/json" @@ -6582,21 +7006,21 @@ { "in": "path", "name": "jobId", - "description": "JobId provided by user.", + "description": "Id of the satellite data ingestion job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "job", - "description": "Job parameters supplied by user.", + "description": "Job parameters supplied by the user.", "schema": { "$ref": "#/definitions/SatelliteDataIngestionJob" } @@ -6630,7 +7054,7 @@ "tags": [ "Scenes" ], - "description": "Get a satellite data ingestion job.", + "description": "Get details of a satellite data ingestion job.\n\n", "operationId": "Scenes_GetSatelliteDataIngestionJobDetails", "produces": [ "application/json" @@ -6639,14 +7063,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the satellite data ingestion job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6677,7 +7101,7 @@ "tags": [ "Scenes" ], - "description": "Downloads and returns file stream as response for the given input filePath.", + "description": "Return scenes as a file stream for a given input filePath.\n\n", "operationId": "Scenes_Download", "produces": [ "application/octet-stream", @@ -6687,14 +7111,14 @@ { "in": "query", "name": "filePath", - "description": "cloud storage path of scene file.", + "description": "Relative path where the scene is stored in cloud storage.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6726,7 +7150,7 @@ "tags": [ "SeasonalFields" ], - "description": "Returns a paginated list of seasonal field resources under a particular farmer.", + "description": "Get a paginated list of seasonal field resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "SeasonalFields_ListByFarmerId", "produces": [ "application/json" @@ -6735,14 +7159,14 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "farmIds", - "description": "Farm Ids of the resource.", + "description": "Seasonal fields associated with the given farms are returned.", "type": "array", "items": { "type": "string" @@ -6752,7 +7176,7 @@ { "in": "query", "name": "fieldIds", - "description": "Field Ids of the resource.", + "description": "Seasonal fields associated with the given fields are returned.", "type": "array", "items": { "type": "string" @@ -6762,7 +7186,7 @@ { "in": "query", "name": "seasonIds", - "description": "Season Ids of the resource.", + "description": "Seasonal fields associated with the given seasons are returned.", "type": "array", "items": { "type": "string" @@ -6772,7 +7196,7 @@ { "in": "query", "name": "cropVarietyIds", - "description": "CropVarietyIds of the resource.", + "description": "Seasonal fields associated with at least one of the given crop varieties are returned.", "type": "array", "items": { "type": "string" @@ -6782,7 +7206,7 @@ { "in": "query", "name": "cropIds", - "description": "Ids of the crop it belongs to.", + "description": "Seasonal fields associated with at least one of the given crops are returned.", "type": "array", "items": { "type": "string" @@ -6792,61 +7216,61 @@ { "in": "query", "name": "minAvgYieldValue", - "description": "Minimum average yield value of the seasonal field(inclusive).", + "description": "Seasonal fields with average yield greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgYieldValue", - "description": "Maximum average yield value of the seasonal field(inclusive).", + "description": "Seasonal fields with average yield lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "avgYieldUnit", - "description": "Unit of the average yield value attribute.", + "description": "Unit of the average yield.", "type": "string" }, { "in": "query", "name": "minAvgSeedPopulationValue", - "description": "Minimum average seed population value of the seasonal field(inclusive).", + "description": "Seasonal fields with average seed population greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgSeedPopulationValue", - "description": "Maximum average seed population value of the seasonal field(inclusive).", + "description": "Seasonal fields with average seed population lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "avgSeedPopulationUnit", - "description": "Unit of average seed population value attribute.", + "description": "Unit of average seed population.", "type": "string" }, { "in": "query", "name": "minPlantingDateTime", - "description": "Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "Seasonal fields with planting date at or after the value specified will be returned (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.", + "description": "Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of seasonal fields to be returned.", "type": "array", "items": { "type": "string" @@ -6856,7 +7280,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of seasonal fields to be returned.", "type": "array", "items": { "type": "string" @@ -6866,7 +7290,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -6876,7 +7300,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Seasonal fields with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -6886,35 +7310,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -6930,7 +7354,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -6964,7 +7388,7 @@ "tags": [ "SeasonalFields" ], - "description": "Returns a paginated list of seasonal field resources across all farmers.", + "description": "Get a paginated list of seasonal field resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "SeasonalFields_List", "produces": [ "application/json" @@ -6973,7 +7397,7 @@ { "in": "query", "name": "farmIds", - "description": "Farm Ids of the resource.", + "description": "Seasonal fields associated with the given farms are returned.", "type": "array", "items": { "type": "string" @@ -6983,7 +7407,7 @@ { "in": "query", "name": "fieldIds", - "description": "Field Ids of the resource.", + "description": "Seasonal fields associated with the given fields are returned.", "type": "array", "items": { "type": "string" @@ -6993,7 +7417,7 @@ { "in": "query", "name": "seasonIds", - "description": "Season Ids of the resource.", + "description": "Seasonal fields associated with the given seasons are returned.", "type": "array", "items": { "type": "string" @@ -7003,7 +7427,7 @@ { "in": "query", "name": "cropVarietyIds", - "description": "CropVarietyIds of the resource.", + "description": "Seasonal fields associated with at least one of the given crop varieties are returned.", "type": "array", "items": { "type": "string" @@ -7013,7 +7437,7 @@ { "in": "query", "name": "cropIds", - "description": "Ids of the crop it belongs to.", + "description": "Seasonal fields associated with at least one of the given crops are returned.", "type": "array", "items": { "type": "string" @@ -7023,61 +7447,61 @@ { "in": "query", "name": "minAvgYieldValue", - "description": "Minimum average yield value of the seasonal field(inclusive).", + "description": "Seasonal fields with average yield greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgYieldValue", - "description": "Maximum average yield value of the seasonal field(inclusive).", + "description": "Seasonal fields with average yield lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "avgYieldUnit", - "description": "Unit of the average yield value attribute.", + "description": "Unit of the average yield.", "type": "string" }, { "in": "query", "name": "minAvgSeedPopulationValue", - "description": "Minimum average seed population value of the seasonal field(inclusive).", + "description": "Seasonal fields with average seed population greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxAvgSeedPopulationValue", - "description": "Maximum average seed population value of the seasonal field(inclusive).", + "description": "Seasonal fields with average seed population lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "avgSeedPopulationUnit", - "description": "Unit of average seed population value attribute.", + "description": "Unit of average seed population.", "type": "string" }, { "in": "query", "name": "minPlantingDateTime", - "description": "Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "Seasonal fields with planting date at or after the value specified will be returned (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.", + "description": "Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of seasonal fields to be returned.", "type": "array", "items": { "type": "string" @@ -7087,7 +7511,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of seasonal fields to be returned.", "type": "array", "items": { "type": "string" @@ -7097,7 +7521,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -7107,7 +7531,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Seasonal fields with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -7117,35 +7541,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -7161,7 +7585,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7195,7 +7619,7 @@ "tags": [ "SeasonalFields" ], - "description": "Gets a specified seasonal field resource under a particular farmer.", + "description": "Get a specified seasonal field resource for a given farmer.\n\n", "operationId": "SeasonalFields_Get", "produces": [ "application/json" @@ -7204,21 +7628,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "seasonalFieldId", - "description": "ID of the seasonal field.", + "description": "Id of the seasonal field.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7247,7 +7671,7 @@ "tags": [ "SeasonalFields" ], - "description": "Creates or Updates a seasonal field resource under a particular farmer.", + "description": "Create or update a seasonal field resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "SeasonalFields_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -7259,28 +7683,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "seasonalFieldId", - "description": "ID of the seasonal field resource.", + "description": "Unique Id of the seasonal field. This Id is unique for a given farmer.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "seasonalField", - "description": "Seasonal field resource payload to create or update.", + "description": "Seasonal field resource payload to Create or update.", "schema": { "$ref": "#/definitions/SeasonalField" } @@ -7316,7 +7740,7 @@ "tags": [ "SeasonalFields" ], - "description": "Deletes a specified seasonal-field resource under a particular farmer.", + "description": "Delete a specified seasonal field resource for a given farmer. It can only be deleted if it has no linked attachments or boundaries.\n\n", "operationId": "SeasonalFields_Delete", "produces": [ "application/json" @@ -7325,21 +7749,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "seasonalFieldId", - "description": "ID of the seasonal field.", + "description": "Id of the seasonal field to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7367,7 +7791,7 @@ "tags": [ "SeasonalFields" ], - "description": "Get cascade delete job for specified seasonal field.", + "description": "Get details of cascade delete job for a specified seasonal field.\n\n", "operationId": "SeasonalFields_GetCascadeDeleteJobDetails", "produces": [ "application/json" @@ -7376,14 +7800,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the seasonal field cascade delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7412,7 +7836,7 @@ "tags": [ "SeasonalFields" ], - "description": "Create a cascade delete job for specified seasonal field.", + "description": "Create a cascade delete job for a specified seasonal field.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", "operationId": "SeasonalFields_CreateCascadeDeleteJob", "produces": [ "application/json" @@ -7421,28 +7845,28 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of the seasonal field cascade delete job. This Id is unique for a given tenant.", "required": true, "type": "string" }, { "in": "query", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "seasonalFieldId", - "description": "ID of the seasonalField to be deleted.", + "description": "Id of the seasonal field to be deleted.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7477,7 +7901,7 @@ "tags": [ "Seasons" ], - "description": "Returns a paginated list of season resources.", + "description": "Get a paginated list of season resources.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "Seasons_List", "produces": [ "application/json" @@ -7486,35 +7910,35 @@ { "in": "query", "name": "minStartDateTime", - "description": "Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "Seasons which start at or after the given UTC date-time are returned (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.", + "description": "Seasons which start at or before the given UTC date-time are returned (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.", + "description": "Seasons which end at or after the given UTC date-time are returned (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.", + "description": "Seasons which end at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "years", - "description": "Years of the resource.", + "description": "Seasons with given list of years are returned.", "type": "array", "items": { "format": "int32", @@ -7525,7 +7949,7 @@ { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of seasons to be returned.", "type": "array", "items": { "type": "string" @@ -7535,7 +7959,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of seasons to be returned.", "type": "array", "items": { "type": "string" @@ -7545,7 +7969,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -7555,7 +7979,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Seasons with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -7565,35 +7989,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -7609,7 +8033,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7643,7 +8067,7 @@ "tags": [ "Seasons" ], - "description": "Gets a specified season resource.", + "description": "Get a specified season resource.\n\n", "operationId": "Seasons_Get", "produces": [ "application/json" @@ -7652,14 +8076,14 @@ { "in": "path", "name": "seasonId", - "description": "ID of the season.", + "description": "Id of the season.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7688,7 +8112,7 @@ "tags": [ "Seasons" ], - "description": "Creates or updates a season resource.", + "description": "Create or update a season resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Seasons_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -7700,21 +8124,21 @@ { "in": "path", "name": "seasonId", - "description": "ID of the season resource.", + "description": "Unique Id of the season. This Id is unique for a given tenant.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "season", - "description": "Season resource payload to create or update.", + "description": "Season resource payload to Create or update.", "schema": { "$ref": "#/definitions/Season" } @@ -7750,7 +8174,7 @@ "tags": [ "Seasons" ], - "description": "Deletes a specified season resource.", + "description": "Delete a specified season resource.\n\n", "operationId": "Seasons_Delete", "produces": [ "application/json" @@ -7759,14 +8183,14 @@ { "in": "path", "name": "seasonId", - "description": "ID of the season.", + "description": "Id of the season.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -7794,7 +8218,7 @@ "tags": [ "TillageData" ], - "description": "Returns a paginated list of tillage data resources under a particular farm.", + "description": "Get a paginated list of tillage data resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "TillageData_ListByFarmerId", "produces": [ "application/json" @@ -7803,42 +8227,42 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "minTillageDepth", - "description": "Minimum measured tillage depth (inclusive).", + "description": "Tillage data with tillage depth greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTillageDepth", - "description": "Maximum measured tillage depth (inclusive).", + "description": "Tillage data with tillage depth lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTillagePressure", - "description": "Minimum pressure applied by a tillage implement (inclusive).", + "description": "Tillage data with tillage pressure greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTillagePressure", - "description": "Maximum pressure applied by a tillage implement (inclusive).", + "description": "Tillage data with tillage pressure lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Tillage data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -7848,7 +8272,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the tillage operation was done.", "type": "array", "items": { "type": "string" @@ -7858,7 +8282,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out.", "type": "array", "items": { "type": "string" @@ -7868,63 +8292,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Tillage operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Tillage operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Tillage operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Tillage operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Tillage operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Tillage operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Tillage operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Tillage operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of tillage operations to be returned.", "type": "array", "items": { "type": "string" @@ -7934,7 +8358,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of tillage operations to be returned.", "type": "array", "items": { "type": "string" @@ -7944,7 +8368,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -7954,7 +8378,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Tillage data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -7964,35 +8388,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -8008,7 +8432,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8042,7 +8466,7 @@ "tags": [ "TillageData" ], - "description": "Returns a paginated list of tillage data resources across all farmers.", + "description": "Get a paginated list of tillage data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", "operationId": "TillageData_List", "produces": [ "application/json" @@ -8051,35 +8475,35 @@ { "in": "query", "name": "minTillageDepth", - "description": "Minimum measured tillage depth (inclusive).", + "description": "Tillage data with tillage depth greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTillageDepth", - "description": "Maximum measured tillage depth (inclusive).", + "description": "Tillage data with tillage depth lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "minTillagePressure", - "description": "Minimum pressure applied by a tillage implement (inclusive).", + "description": "Tillage data with tillage pressure greater than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxTillagePressure", - "description": "Maximum pressure applied by a tillage implement (inclusive).", + "description": "Tillage data with tillage pressure lesser than or equal to the value specified will be returned.", "type": "number", "format": "double" }, { "in": "query", "name": "sources", - "description": "Sources of the operation data.", + "description": "Tillage data obtained from the given list of sources will be returned.", "type": "array", "items": { "type": "string" @@ -8089,7 +8513,7 @@ { "in": "query", "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", + "description": "List of boundary Ids of the field/seasonal field on which the tillage operation was done.", "type": "array", "items": { "type": "string" @@ -8099,7 +8523,7 @@ { "in": "query", "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", + "description": "List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out.", "type": "array", "items": { "type": "string" @@ -8109,63 +8533,63 @@ { "in": "query", "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "description": "Tillage operations that began at or after the given UTC date-time is returned.", "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).", + "description": "Tillage operations that began at or before the given UTC date-time is returned.", "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).", + "description": "Tillage operations that ended at or after the given UTC date-time is returned.", "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).", + "description": "Tillage operations that ended at or before the given UTC date-time is returned.", "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).", + "description": "Tillage operations that were modified (at source) at or after the given UTC date-time is returned.", "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).", + "description": "Tillage operations that were modified (at source) at or before the given UTC date-time is returned.", "type": "string", "format": "date-time" }, { "in": "query", "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", + "description": "Tillage operations carried over area greater than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", + "description": "Tillage operations carried over area lesser than or equal to the given value is returned.", "type": "number", "format": "double" }, { "in": "query", "name": "ids", - "description": "Ids of the resource.", + "description": "List of Ids of tillage operations to be returned.", "type": "array", "items": { "type": "string" @@ -8175,7 +8599,7 @@ { "in": "query", "name": "names", - "description": "Names of the resource.", + "description": "List of names of tillage operations to be returned.", "type": "array", "items": { "type": "string" @@ -8185,7 +8609,7 @@ { "in": "query", "name": "propertyFilters", - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" @@ -8195,7 +8619,7 @@ { "in": "query", "name": "statuses", - "description": "Statuses of the resource.", + "description": "Tillage data with only the given statuses are returned.", "type": "array", "items": { "type": "string" @@ -8205,35 +8629,35 @@ { "in": "query", "name": "minCreatedDateTime", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxCreatedDateTime", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "minLastModifiedDateTime", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "format": "date-time" }, { "in": "query", "name": "maxLastModifiedDateTime", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -8249,7 +8673,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8283,7 +8707,7 @@ "tags": [ "TillageData" ], - "description": "Get a specified tillage data resource under a particular farmer.", + "description": "Get a specified tillage data resource for a given farmer.\n\n", "operationId": "TillageData_Get", "produces": [ "application/json" @@ -8292,21 +8716,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "tillageDataId", - "description": "ID of the tillage data resource.", + "description": "Id of the tillage data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8335,7 +8759,7 @@ "tags": [ "TillageData" ], - "description": "Creates or updates an tillage data resource under a particular farmer.", + "description": "Create or update a tillage data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "TillageData_CreateOrUpdate", "consumes": [ "application/merge-patch+json" @@ -8347,28 +8771,28 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "tillageDataId", - "description": "ID of the tillage data resource.", + "description": "Id of the tillage data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "tillageData", - "description": "Tillage data resource payload to create or update.", + "description": "Tillage data resource payload to Create or update.", "schema": { "$ref": "#/definitions/TillageData" } @@ -8404,7 +8828,7 @@ "tags": [ "TillageData" ], - "description": "Deletes a specified tillage data resource under a particular farmer.", + "description": "Delete a specified tillage data resource for a given farmer.\n\n", "operationId": "TillageData_Delete", "produces": [ "application/json" @@ -8413,21 +8837,21 @@ { "in": "path", "name": "farmerId", - "description": "ID of the associated farmer resource.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "path", "name": "tillageDataId", - "description": "ID of the tillage data.", + "description": "Id of the tillage data resource.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8450,12 +8874,122 @@ } } }, + "/tillage-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get details of a cascade delete job for tillage data resource.\n\n", + "operationId": "TillageData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the tillage data cascade delete 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": { + "TillageData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/TillageData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "TillageData" + ], + "description": "Create cascade delete job for tillage data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "TillageData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the tillage data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "TillageData_CreateCascadeDeleteJob": { + "$ref": "./examples/TillageData_CreateCascadeDeleteJob.json" + } + } + } + }, "/weather": { "get": { "tags": [ "Weather" ], - "description": "Returns a paginated list of weather data.", + "description": "Get a paginated list of weather data resources for a given search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n2. This API will retrieve weather data present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested historical weather data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for historical data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user.\n\n", "operationId": "Weather_List", "produces": [ "application/json" @@ -8464,21 +8998,21 @@ { "in": "query", "name": "farmerId", - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "required": true, "type": "string" }, { "in": "query", "name": "boundaryId", - "description": "Boundary ID.", + "description": "Id of the associated boundary.", "required": true, "type": "string" }, { "in": "query", "name": "extensionId", - "description": "ID of the weather extension.", + "description": "Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg).", "required": true, "type": "string", "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$" @@ -8504,21 +9038,21 @@ { "in": "query", "name": "startDateTime", - "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "Weather data at or after the given UTC Date-time will be returned (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.", + "description": "Weather data at or before the given UTC Date-time will be returned (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.", + "description": "Maximum number of items to be returned in a single page.", "type": "integer", "format": "int32", "default": 50, @@ -8534,7 +9068,7 @@ { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8568,7 +9102,7 @@ "tags": [ "Weather" ], - "description": "Get weather ingestion job.", + "description": "Get details of a weather data ingestion job.\n\n", "operationId": "Weather_GetDataIngestionJobDetails", "produces": [ "application/json" @@ -8577,14 +9111,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the weather data ingestion job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8613,7 +9147,7 @@ "tags": [ "Weather" ], - "description": "Create a weather data ingestion job.", + "description": "Create a weather data ingestion job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Weather_CreateDataIngestionJob", "consumes": [ "application/json" @@ -8625,21 +9159,21 @@ { "in": "path", "name": "jobId", - "description": "Job id supplied by user.", + "description": "Id of the weather data ingestion job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "job", - "description": "Job parameters supplied by user.", + "description": "Job parameters supplied by the user.", "schema": { "$ref": "#/definitions/WeatherDataIngestionJob" } @@ -8675,7 +9209,7 @@ "tags": [ "Weather" ], - "description": "Get weather data delete job.", + "description": "Get details of a weather data delete job.\n\n", "operationId": "Weather_GetDataDeleteJobDetails", "produces": [ "application/json" @@ -8684,14 +9218,14 @@ { "in": "path", "name": "jobId", - "description": "ID of the job.", + "description": "Id of the weather data delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" } @@ -8720,7 +9254,7 @@ "tags": [ "Weather" ], - "description": "Create a weather data delete job.", + "description": "Create a weather data delete job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", "operationId": "Weather_CreateDataDeleteJob", "consumes": [ "application/json" @@ -8732,21 +9266,21 @@ { "in": "path", "name": "jobId", - "description": "Job ID supplied by end user.", + "description": "Id of the weather data delete job.", "required": true, "type": "string" }, { "in": "query", "name": "api-version", - "description": "The requested API version", + "description": "The requested API version.", "required": true, "type": "string" }, { "in": "body", "name": "job", - "description": "Job parameters supplied by user.", + "description": "Job parameters supplied by the user.", "schema": { "$ref": "#/definitions/WeatherDataDeleteJob" } @@ -8808,17 +9342,17 @@ } }, "ApplicationProductDetail": { - "description": "Schema of product used during application.", + "description": "Schema of a product used during application.", "type": "object", "properties": { "productName": { - "description": "Name of the product applied.", + "description": "Name of a product applied.", "maxLength": 100, "minLength": 1, "type": "string" }, "isCarrier": { - "description": "A flag indicating whether product is a carrier for a tank mix.", + "description": "Indicates if the product is a carrier for a tank mix.", "default": false, "type": "boolean" }, @@ -8851,86 +9385,86 @@ "$ref": "#/definitions/Measure" }, "source": { - "description": "Source of the operation data.", + "description": "Represents the source from which the application data was obtained.", "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.", + "description": "UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", "type": "string" }, "operationStartDateTime": { "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC date-time at which the operation started (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.", + "description": "UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "attachmentsLink": { - "description": "Link for attachments.", + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", "type": "string", "readOnly": true }, "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", + "description": "Id of the boundary of the field/seasonal field on which the application operation was done.", "type": "string" }, "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "description": "Id of the boundary that is created using the geographical area on which the application operation was carried out.", "type": "string" }, "farmerId": { - "description": "Farmer ID which belongs to the operation data.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the operation (application). This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the application operation.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the application operation.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -8958,7 +9492,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -8968,7 +9502,7 @@ "type": "object", "properties": { "code": { - "description": "Specific error code than was provided by the\r\ncontaining error.", + "description": "Specific error code than was provided by the containing error.", "type": "string" }, "innererror": { @@ -8980,7 +9514,7 @@ } }, "Error": { - "description": "An error from the Azure AgPlatform service.", + "description": "An error from Azure FarmBeats service.", "type": "object", "properties": { "code": { @@ -9008,77 +9542,156 @@ } }, "ErrorResponse": { - "description": "An error response from the Azure AgPlatform service.\r\nErrorResponse reference document..", + "description": "An error response from Azure AgPlatform service.\r\nErrorResponse reference document..", "type": "object", "properties": { "error": { "$ref": "#/definitions/Error" }, "traceId": { - "description": "Unique trace ID.", + "description": "Unique trace Id.", "type": "string" } } }, + "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 which is to be deleted (along with the subtree & associated data).", + "type": "string" + }, + "resourceType": { + "description": "Signifies the type of the resource that is being deleted (along with the subtree & associated data).", + "type": "string" + }, + "id": { + "description": "Unique Id of the cascade delete job. This Id is unique for a given tenant.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "enum": [ + "Waiting", + "Running", + "Succeeded", + "Failed", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "durationInSeconds": { + "format": "double", + "description": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + } + } + }, "Attachment": { "description": "Schema of attachment resource.", "type": "object", "properties": { "farmerId": { - "description": "Farmer id for this attachment.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "resourceId": { - "description": "Associated Resource id for this attachment.", + "description": "This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data.", "type": "string" }, "resourceType": { - "description": "Associated Resource type for this attachment\r\ni.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData.", + "description": "Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData.", "type": "string" }, "originalFileName": { - "description": "Original File Name for this attachment.", + "description": "Original file name of the attachment.", "type": "string", "readOnly": true }, "id": { - "description": "Unique id.", + "description": "Unique Id of the attachment. This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined status of the resource.", "maxLength": 100, "minLength": 0, "type": "string" }, "createdDateTime": { "format": "date-time", - "description": "Date when resource was created.", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "modifiedDateTime": { "format": "date-time", - "description": "Date when resource was last modified.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the attachment.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of resource.", + "description": "Brief description of the attachment.", "maxLength": 500, "minLength": 0, "type": "string" }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true } @@ -9100,7 +9713,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -9136,74 +9749,74 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "parentId": { - "description": "ID of the parent(field or seasonalField) it belongs to.", + "description": "If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field.", "type": "string" }, "geometry": { "$ref": "#/definitions/GeoJsonObject" }, "isPrimary": { - "description": "Is the boundary primary.", + "description": "Indicates if the boundary is a primary boundary for the associated parent (if any).", "type": "boolean" }, "acreage": { "format": "double", - "description": "Boundary area in acres.", + "description": "Area of the boundary in acres.", "type": "number", "readOnly": true }, "parentType": { - "description": "Type of the parent it belongs to.", + "description": "Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'.", "type": "string", "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the boundary. This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the boundary.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the boundary.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -9268,7 +9881,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -9278,28 +9891,28 @@ "type": "object", "properties": { "ids": { - "description": "Ids of the resource.", + "description": "List of boundary Ids to be searched.", "type": "array", "items": { "type": "string" } }, "names": { - "description": "Names of the resource.", + "description": "List of names of boundaries to be searched.", "type": "array", "items": { "type": "string" } }, "propertyFilters": { - "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", "type": "array", "items": { "type": "string" } }, "statuses": { - "description": "Statuses of the resource.", + "description": "List of statuses of boundaries to be searched.", "type": "array", "items": { "type": "string" @@ -9307,46 +9920,46 @@ }, "minCreatedDateTime": { "format": "date-time", - "description": "Minimum creation date of resource (inclusive).", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "maxCreatedDateTime": { "format": "date-time", - "description": "Maximum creation date of resource (inclusive).", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "minLastModifiedDateTime": { "format": "date-time", - "description": "Minimum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "maxLastModifiedDateTime": { "format": "date-time", - "description": "Maximum last modified date of resource (inclusive).", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "$maxPageSize": { "format": "int32", - "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "description": "Maximum number of items to be returned in a single page.", "default": 50, "maximum": 1000, "minimum": 10, "type": "integer" }, "$skipToken": { - "description": "Skip token for getting next set of results.", + "description": "Token used in retrieving the next page. If null, there are no additional pages.", "type": "string" }, "isPrimary": { - "description": "Is the boundary primary.", + "description": "If set, search result will contain only primary boundaries.", "type": "boolean" }, "parentType": { - "description": "Type of the parent it belongs to.", + "description": "Used to search based on the parent type (Field/ SeasonalField).", "type": "string" }, "parentIds": { - "description": "Parent Ids of the resource.", + "description": "List of parent Ids whose boundaries are to be retrieved.", "type": "array", "items": { "type": "string" @@ -9367,114 +9980,23 @@ } } }, - "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": { - "format": "double", - "description": "Duration of the job in seconds.", - "type": "number", - "readOnly": true - }, - "message": { - "description": "Status message to capture more details of the job.", - "type": "string", - "readOnly": true - }, - "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.", + "description": "Acreage of the main boundary.", "type": "number" }, "otherBoundaryAcreage": { "format": "double", - "description": "Acreage of other boundary.", + "description": "Acreage of the other boundary.", "type": "number" }, "intersectingAcreage": { "format": "double", - "description": "Acreage of intersecting boundary.", + "description": "Acreage of the intersecting area between the given boundaries.", "type": "number" } } @@ -9484,53 +10006,53 @@ "type": "object", "properties": { "phenotype": { - "description": "Crop phenotype.", + "description": "Phenotype of the crop.", "maxLength": 100, "minLength": 0, "type": "string" }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the crop.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the crop.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the crop.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -9558,7 +10080,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -9568,64 +10090,64 @@ "type": "object", "properties": { "cropId": { - "description": "ID of the crop it belongs to.", + "description": "Id of the associated crop.", "type": "string", "readOnly": true }, "brand": { - "description": "CropVariety Brand.", + "description": "Brand of the crop variety.", "maxLength": 100, "minLength": 0, "type": "string" }, "product": { - "description": "CropVariety product.", + "description": "Commercial name of the crop variety.", "maxLength": 100, "minLength": 0, "type": "string" }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the crop variety. This Id is unique for a given crop.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the crop variety.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the crop variety.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -9653,7 +10175,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -9663,47 +10185,47 @@ "type": "object", "properties": { "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the farmer.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the farmer.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -9731,7 +10253,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -9746,15 +10268,15 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the farmer whose farm operations are to be fetched.", "type": "string" }, "authProviderId": { - "description": "Authentication provider ID.", + "description": "Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere.", "type": "string" }, "operations": { - "description": "List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.", + "description": "List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage.", "type": "array", "items": { "type": "string" @@ -9762,11 +10284,11 @@ }, "startYear": { "format": "int32", - "description": "Start Year (Minimum = 2000, Maximum = CurrentYear).", + "description": "The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year).", "type": "integer" }, "id": { - "description": "Unique job id.", + "description": "Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant.", "type": "string", "readOnly": true }, @@ -9777,53 +10299,53 @@ }, "durationInSeconds": { "format": "double", - "description": "Duration of the job in seconds.", + "description": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", "type": "number", "readOnly": true }, "message": { - "description": "Status message to capture more details of the job.", + "description": "Brief description of the result of the job.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", - "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which the job was created (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.", + "description": "UTC Date-time at which the job was last acted upon (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.", + "description": "UTC Date-time at which the processing of the job started (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.", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the farm operations data ingestion job.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the farm operations data ingestion job.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -9836,56 +10358,56 @@ } }, "Farm": { - "description": "Schema of farm resource.", + "description": "Schema of a farm resource.", "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the farm. This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the farm.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the farm.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -9913,31 +10435,31 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } }, "Field": { - "description": "Schema of field resource.", + "description": "Schema of a field resource.", "type": "object", "properties": { "farmId": { - "description": "ID of the associated Farm.", + "description": "Id of the associated farm.", "type": "string" }, "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "primaryBoundaryId": { - "description": "Primary boundary id.", + "description": "Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary.", "type": "string", "readOnly": true }, "boundaryIds": { - "description": "Boundary Ids.", + "description": "List of Ids of boundaries associated with the field.", "uniqueItems": true, "type": "array", "items": { @@ -9946,47 +10468,47 @@ "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the field. This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the field.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the field.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -10014,17 +10536,17 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } }, "HarvestProductDetail": { - "description": "Schema of product used during harvesting.", + "description": "Schema of a harvested product.", "type": "object", "properties": { "productName": { - "description": "Name of the product.", + "description": "Name of a harvested product.", "maxLength": 100, "minLength": 1, "type": "string" @@ -10072,7 +10594,7 @@ "$ref": "#/definitions/Measure" }, "harvestProductDetails": { - "description": "Harvest product details.", + "description": "Details of harvested products.", "type": "array", "items": { "$ref": "#/definitions/HarvestProductDetail" @@ -10082,86 +10604,86 @@ "$ref": "#/definitions/Measure" }, "source": { - "description": "Source of the operation data.", + "description": "Represents the source from which the harvest data was obtained.", "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.", + "description": "UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", "type": "string" }, "operationStartDateTime": { "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC date-time at which the harvest operation started (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.", + "description": "UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "attachmentsLink": { - "description": "Link for attachments.", + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", "type": "string", "readOnly": true }, "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", + "description": "Id of the boundary of the field/seasonal field on which the harvest operation was done.", "type": "string" }, "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "description": "Id of the boundary that is created using the geographical area on which the harvest operation was carried out.", "type": "string" }, "farmerId": { - "description": "Farmer ID which belongs to the operation data.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the operation (harvest). This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the harvest operation.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the harvest operation.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -10189,7 +10711,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -10204,22 +10726,22 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string" }, "shapefileAttachmentId": { - "description": "Shapefile attachment ID.", + "description": "Attachment id of the input shapefile which must be rasterized.", "type": "string" }, "shapefileColumnNames": { - "description": "List of shapefile column names to create raster attachments.", + "description": "List of shapefile column names that must be rasterized.", "type": "array", "items": { "type": "string" } }, "id": { - "description": "Unique job id.", + "description": "Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant.", "type": "string", "readOnly": true }, @@ -10230,53 +10752,53 @@ }, "durationInSeconds": { "format": "double", - "description": "Duration of the job in seconds.", + "description": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", "type": "number", "readOnly": true }, "message": { - "description": "Status message to capture more details of the job.", + "description": "Brief description of the result of the job.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", - "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which the job was created (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.", + "description": "UTC Date-time at which the job was last acted upon (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.", + "description": "UTC Date-time at which the processing of the job started (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.", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the image processing (rasterize) job.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the image processing (rasterize) job.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -10293,64 +10815,64 @@ "type": "object", "properties": { "appId": { - "description": "OAuth App ID for given OAuth Provider.", + "description": "OAuth App Id for a 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.", + "description": "OAuth App secret for a given OAuth Provider.\r\nNote: The app secret will not be part of the 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.", + "description": "OAuth Api key for a given Provider.\r\nNote: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp.", "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.", + "description": "An optional flag to determine if the OAuth App is ready to be used for production scenarios.\r\nNote: This is applicable only for John Deere.", "default": false, "type": "boolean" }, "id": { - "description": "Unique OAuth provider ID.", + "description": "FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the OAuth provider.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the OAuth provider.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -10378,8 +10900,89 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", + "type": "string" + } + } + }, + "OAuthProviderCascadeDeleteJob": { + "description": "Schema of oauth provider cascade delete job.", + "required": [ + "oauthProviderId" + ], + "type": "object", + "properties": { + "oauthProviderId": { + "description": "FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE'.", + "type": "string" + }, + "id": { + "description": "Unique Id of the OAuth provider delete job. This Id must be unique for a given tenant.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the OAuth provider cascade delete job.", + "maxLength": 100, + "minLength": 0, "type": "string" + }, + "description": { + "description": "Brief description of the OAuth provider cascade delete job..", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } } } }, @@ -10392,32 +10995,32 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID for this OAuth config.", + "description": "Id of the farmer for whom the OAuth flow is being configured.", "type": "string" }, "authProviderId": { - "description": "ID of the OAuth provider resource containing app information.", + "description": "Id of the OAuth provider resource containing the app information.", "type": "string" }, "isValid": { - "description": "An optional flag indicating whether the token is a valid or expired (Default value: true).", + "description": "An optional flag indicating whether the token is valid or expired.", "default": true, "type": "boolean" }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true } @@ -10439,7 +11042,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -10454,21 +11057,21 @@ "type": "object", "properties": { "farmerId": { - "description": "ID of the farmer.", + "description": "Id of the farmer for whom the OAuth flow is being configured.", "type": "string" }, "oAuthProviderId": { - "description": "ID of the OAuthProvider.", + "description": "Id of the OAuth provider.", "type": "string" }, "userRedirectLink": { - "description": "Link to redirect the user to, at the end of the oauth flow.", + "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.", + "description": "State to be returned when redirecting the user at the end of the oauth flow.", "maxLength": 200, "minLength": 0, "type": "string" @@ -10476,11 +11079,11 @@ } }, "PlantingProductDetail": { - "description": "Schema for Planting product detail.", + "description": "Schema of a planted product.", "type": "object", "properties": { "productName": { - "description": "Name of the product.", + "description": "Name of the planted product.", "type": "string" }, "area": { @@ -10508,7 +11111,7 @@ "$ref": "#/definitions/Measure" }, "plantingProductDetails": { - "description": "Planting product details.", + "description": "Details of products planted.", "type": "array", "items": { "$ref": "#/definitions/PlantingProductDetail" @@ -10518,86 +11121,86 @@ "$ref": "#/definitions/Measure" }, "source": { - "description": "Source of the operation data.", + "description": "Represents the source from which the planting data was obtained.", "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.", + "description": "UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", "type": "string" }, "operationStartDateTime": { "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC date-time at which the operation started (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.", + "description": "UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "attachmentsLink": { - "description": "Link for attachments.", + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", "type": "string", "readOnly": true }, "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", + "description": "Id of the boundary of the field/seasonal field on which the planting operation was done.", "type": "string" }, "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "description": "Id of the boundary that is created using the geographical area on which the planting operation was carried out.", "type": "string" }, "farmerId": { - "description": "Farmer ID which belongs to the operation data.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the operation (planting). This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the planting operation.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the planting operation.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -10625,7 +11228,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -10649,7 +11252,7 @@ "type": "object", "properties": { "fileLink": { - "description": "Link of the image file.", + "description": "Link to the image file.", "type": "string" }, "name": { @@ -10661,7 +11264,7 @@ }, "resolution": { "format": "double", - "description": "Resolution of image file in meters.", + "description": "Resolution of image in meters.", "type": "number" } } @@ -10672,17 +11275,17 @@ "properties": { "sceneDateTime": { "format": "date-time", - "description": "Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which the image was captured/made available at source (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "provider": { - "description": "Data provider of the scene.", + "description": "Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider.", "maxLength": 100, "minLength": 2, "type": "string" }, "source": { - "description": "Data source of the scene.", + "description": "Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation.", "maxLength": 100, "minLength": 2, "type": "string" @@ -10699,41 +11302,41 @@ }, "cloudCoverPercentage": { "format": "double", - "description": "Cloud cover percentage of the scene.", + "description": "Signifies the percentage of the scene covered by clouds.", "maximum": 100, "minimum": 0, "type": "number" }, "darkPixelPercentage": { "format": "double", - "description": "Dark pixel percentage of the scene.", + "description": "Signifies the percentage of the scene covered by dark pixels.", "maximum": 100, "minimum": 0, "type": "number" }, "ndviMedianValue": { "format": "double", - "description": "Median of NDVI of the scene.", + "description": "Median of NDVI values of the scene.", "maximum": 1, "minimum": 0, "type": "number" }, "boundaryId": { - "description": "Boundary ID which belongs to the scene.", + "description": "Id of the associated boundary.", "maxLength": 100, "minLength": 2, "type": "string" }, "farmerId": { - "description": "Farmer ID which belongs to the scene.", + "description": "Id of the associated farmer.", "type": "string" }, "id": { - "description": "Unique scene resource ID.", + "description": "Unique Id of the scene", "type": "string" }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true } @@ -10755,7 +11358,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -10787,7 +11390,7 @@ "type": "object", "properties": { "imageNames": { - "description": "List of ImageNames.", + "description": "List of names of images to be fetched.\r\nFor Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'.", "type": "array", "items": { "type": "string" @@ -10797,7 +11400,7 @@ ] }, "imageFormats": { - "description": "List of ImageFormats. Available value: TIF.", + "description": "List of formats in which images can be fetched. Available value: TIF.", "type": "array", "items": { "type": "string" @@ -10807,7 +11410,7 @@ ] }, "imageResolutions": { - "description": "List of ImageResolutions in meters. Available values: 10, 20, 60.", + "description": "List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60.", "type": "array", "items": { "format": "double", @@ -10830,21 +11433,21 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string" }, "boundaryId": { - "description": "The id of the boundary object for which satellite data is being fetched.", + "description": "The id of the boundary for which satellite data is being fetched.", "type": "string" }, "startDateTime": { "format": "date-time", - "description": "Start Date.", + "description": "UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "endDateTime": { "format": "date-time", - "description": "End Date.", + "description": "UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "provider": { @@ -10857,7 +11460,7 @@ "$ref": "#/definitions/SatelliteData" }, "id": { - "description": "Unique job id.", + "description": "Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant.", "type": "string", "readOnly": true }, @@ -10868,53 +11471,53 @@ }, "durationInSeconds": { "format": "double", - "description": "Duration of the job in seconds.", + "description": "DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", "type": "number", "readOnly": true }, "message": { - "description": "Status message to capture more details of the job.", + "description": "Brief description of the result of the job.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", - "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which the job was created (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.", + "description": "UTC Date-time at which the job was last acted upon (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.", + "description": "UTC Date-time at which the processing of the job started (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.", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the satellite data ingestion job.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the satellite data ingestion job.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -10931,17 +11534,17 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "primaryBoundaryId": { - "description": "Primary boundary id.", + "description": "Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary.", "type": "string", "readOnly": true }, "boundaryIds": { - "description": "Boundary Ids.", + "description": "List of Ids of boundaries associated with the seasonal field.", "uniqueItems": true, "type": "array", "items": { @@ -10950,19 +11553,19 @@ "readOnly": true }, "farmId": { - "description": "ID of the associated Farm.", + "description": "Id of the associated farm.", "type": "string" }, "fieldId": { - "description": "ID of the associated Field.", + "description": "Id of the associated field.", "type": "string" }, "seasonId": { - "description": "ID of the season it belongs to.", + "description": "Id of the season associated with the seasonal field.", "type": "string" }, "cropVarietyIds": { - "description": "CropVariety ids.", + "description": "List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop.", "uniqueItems": true, "type": "array", "items": { @@ -10970,78 +11573,78 @@ } }, "cropId": { - "description": "ID of the crop it belongs to.", + "description": "Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities.", "type": "string" }, "avgYieldValue": { "format": "double", - "description": "Average yield value of the seasonal field.", + "description": "Average yield generated from the seasonal field.", "type": "number" }, "avgYieldUnit": { - "description": "Unit of the average yield value attribute.", + "description": "Unit to measure average yield.", "maxLength": 32, "minLength": 2, "type": "string" }, "avgSeedPopulationValue": { "format": "double", - "description": "Average seed population value of the seasonal field.", + "description": "Average seed population planted in the seasonal field.", "type": "number" }, "avgSeedPopulationUnit": { - "description": "Unit of average seed population value attribute.", + "description": "Unit to measure average seed population.", "maxLength": 32, "minLength": 2, "type": "string" }, "plantingDateTime": { "format": "date-time", - "description": "Planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the seasonal field. This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the seasonal field.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the seasonal field.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -11069,7 +11672,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -11080,61 +11683,61 @@ "properties": { "startDateTime": { "format": "date-time", - "description": "Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "endDateTime": { "format": "date-time", - "description": "Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "year": { "format": "int32", - "description": "Season year.", + "description": "Year associated with the harvest i.e. year of season end date-time.", "type": "integer" }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the season.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the season.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the season.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -11162,7 +11765,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -11181,86 +11784,86 @@ "$ref": "#/definitions/Measure" }, "source": { - "description": "Source of the operation data.", + "description": "Represents the source from which the tillage data was obtained.", "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.", + "description": "UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", "type": "string" }, "operationStartDateTime": { "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC date-time at which the operation started (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.", + "description": "UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "attachmentsLink": { - "description": "Link for attachments.", + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", "type": "string", "readOnly": true }, "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", + "description": "Id of the boundary of the field/seasonal field on which the tillage operation was done.", "type": "string" }, "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", + "description": "Id of the boundary that is created using the geographical area on which the tillage operation was carried out.", "type": "string" }, "farmerId": { - "description": "Farmer ID which belongs to the operation data.", + "description": "Id of the associated farmer.", "type": "string", "readOnly": true }, "id": { - "description": "Unique resource ID.", + "description": "Unique Id of the operation (tillage). This Id is unique for a given farmer.", "type": "string", "readOnly": true }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used to implement optimistic concurrency.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the resource.", + "description": "User determined 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the tillage operation.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the tillage operation.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -11288,7 +11891,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -11332,15 +11935,15 @@ "type": "object", "properties": { "farmerId": { - "description": "Farmer ID.", + "description": "Id of the associated farmer.", "type": "string" }, "boundaryId": { - "description": "Boundary ID.", + "description": "Id of the associated boundary.", "type": "string" }, "extensionId": { - "description": "ID of the weather extension.", + "description": "Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg).", "type": "string" }, "location": { @@ -11348,11 +11951,11 @@ }, "dateTime": { "format": "date-time", - "description": "Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time of the weather data (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "unitSystemCode": { - "description": "Unit System like US/SI etc.", + "description": "Unit system like US/SI etc.", "type": "string" }, "extensionVersion": { @@ -11413,28 +12016,28 @@ "$ref": "#/definitions/Measure" }, "id": { - "description": "Weather data ID.", + "description": "Unique id of weather data.", "type": "string" }, "eTag": { - "description": "The ETag value to implement optimistic concurrency.", + "description": "ETag value can be used 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.", + "description": "UTC Date-time at which the resource was created (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.", + "description": "UTC Date-time at which the resource was last modified (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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -11462,7 +12065,7 @@ "type": "string" }, "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", + "description": "Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages.", "type": "string" } } @@ -11479,28 +12082,28 @@ "type": "object", "properties": { "boundaryId": { - "description": "The id of the boundary object for which weather data is being fetched.", + "description": "Id of the associated boundary.", "type": "string" }, "farmerId": { - "description": "The id of the farmer object for which weather data is being fetched.", + "description": "Id of the associated farmer.", "type": "string" }, "extensionId": { - "description": "ID of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "description": "Id of the weather extension. This signifies the source from where the weather data is fetched (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.", + "description": "Extension api name to which the 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.", + "description": "Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider.", "type": "object", "additionalProperties": { "type": "object" @@ -11519,7 +12122,7 @@ "type": "string" }, "id": { - "description": "Unique job id.", + "description": "Unique Id of the weather data ingestion job. This Id must be unique for a given tenant.", "type": "string", "readOnly": true }, @@ -11530,53 +12133,53 @@ }, "durationInSeconds": { "format": "double", - "description": "Duration of the job in seconds.", + "description": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", "type": "number", "readOnly": true }, "message": { - "description": "Status message to capture more details of the job.", + "description": "Brief description of the result of the job.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", - "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which the job was created (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.", + "description": "UTC Date-time at which the job was last acted upon (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.", + "description": "UTC Date-time at which the processing of the job started (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.", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name to weather data ingestion job.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the weather data ingestion job.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -11598,40 +12201,40 @@ "type": "object", "properties": { "extensionId": { - "description": "ID of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "description": "Id of the weather extension. This signifies the source from where the weather data was fetched (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.", + "description": "The Id of the associated farmer.", "type": "string" }, "boundaryId": { - "description": "The id of the boundary object for which weather data is being fetched.", + "description": "The id of the associated boundary.", "type": "string" }, "weatherDataType": { - "description": "Type of weather data. Possible values include: 'forecast' , 'historical'.", + "description": "Type of weather data (forecast/historical).", "type": "string" }, "granularity": { - "description": "Granularity of weather data. Possible values include: 'daily' , 'hourly'.", + "description": "Granularity of weather data (daily/hourly).", "type": "string" }, "startDateTime": { "format": "date-time", - "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time from when the weather data has to be deleted (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.", + "description": "UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string" }, "id": { - "description": "Unique job id.", + "description": "Unique Id of the weather data delete job. This Id must be unique for a given tenant.", "type": "string", "readOnly": true }, @@ -11642,53 +12245,53 @@ }, "durationInSeconds": { "format": "double", - "description": "Duration of the job in seconds.", + "description": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", "type": "number", "readOnly": true }, "message": { - "description": "Status message to capture more details of the job.", + "description": "Brief description of the result of the job.", "type": "string", "readOnly": true }, "createdDateTime": { "format": "date-time", - "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "description": "UTC Date-time at which the job was created (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.", + "description": "UTC Date-time at which the job was last acted upon (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.", + "description": "UTC Date-time at which the processing of the job started (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.", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", "type": "string", "readOnly": true }, "name": { - "description": "Name to identify resource.", + "description": "Name of the weather data deletion job.", "maxLength": 100, "minLength": 0, "type": "string" }, "description": { - "description": "Textual description of the resource.", + "description": "Brief description of the weather data deletion job.", "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.", + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", "type": "object", "additionalProperties": { "type": "object" @@ -11721,7 +12324,7 @@ "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.", + "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": { @@ -11761,7 +12364,7 @@ ], "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.", + "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 respectively.", "maximum": 3, "minimum": 2, "type": "array", diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..62087dad58ba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "applicationDataId": "Application123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Application123", + "resourceType": "farmoperationapplicationdata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationapplicationdata' resource with id 'Application123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T09:39:37Z", + "lastActionDateTime": "2021-06-19T09:39:37Z", + "startTime": "2021-06-19T09:39:37Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json index 57545922eeb1..a5ef976c5ffd 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json @@ -1,148 +1,146 @@ { "parameters": { "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "applicationDataId": "APPLICATION123", + "farmerId": "Farmer123", + "applicationDataId": "Application123", "api-version": "2021-03-31-preview", "applicationData": { - "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", + "productName": "Product123", "isCarrier": false, - "totalMaterial": { - "unit": "kilos", - "value": 4 - }, "avgMaterial": { "unit": "kilosperacre", - "value": 0.2 + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 } } ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "area": { + "unit": "acre", + "value": 60 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test application data", + "description": "Test application data description", "properties": { - "Region": "Europe", - "CountyCode": 123 + "Region": "Central US", + "RetailerId": 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", + "productName": "Product123", "isCarrier": false, - "totalMaterial": { - "unit": "kilos", - "value": 4 - }, "avgMaterial": { "unit": "kilosperacre", - "value": 0.2 + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 } } ], - "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 + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 }, "totalMaterial": { "unit": "kilos", - "value": 9 + "value": 9.0 }, - "avgMaterial": { - "unit": "kilosperacre", - "value": 0.15 + "area": { + "unit": "acre", + "value": 60.0 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "201": { + "body": { "applicationProductDetails": [ { - "productName": "POTASHVAR1", + "productName": "Product123", "isCarrier": false, - "totalMaterial": { - "unit": "kilos", - "value": 4 - }, "avgMaterial": { "unit": "kilosperacre", - "value": 0.2 + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json index 20dc9e559382..b2c455bc5945 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "applicationDataId": "APPLICATION123", + "farmerId": "Farmer123", + "applicationDataId": "Application123", "api-version": "2021-03-31-preview" }, "responses": { diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json index b9daa7a1fd1f..94fa4a8be6a5 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json @@ -1,58 +1,58 @@ { "parameters": { "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "applicationDataId": "APPLICATION123", + "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", + "productName": "Product123", "isCarrier": false, - "totalMaterial": { - "unit": "kilos", - "value": 4 - }, "avgMaterial": { "unit": "kilosperacre", - "value": 0.2 + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 }, - "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" + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "attachmentsLink": "https://test.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..a520e9287e6a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Application123", + "resourceType": "farmoperationapplicationdata", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 10.1100966, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T09:39:37Z", + "lastActionDateTime": "2021-06-19T09:39:47Z", + "startTime": "2021-06-19T09:39:37Z", + "endTime": "2021-06-19T09:39:47Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json index 5f76b4ef2d0d..a48ec37f6b84 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json @@ -8,55 +8,54 @@ "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", + "productName": "Product123", "isCarrier": false, - "totalMaterial": { - "unit": "kilos", - "value": 4 - }, "avgMaterial": { "unit": "kilosperacre", - "value": 0.2 + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 }, - "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" + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "attachmentsLink": "https://test.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 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" + "nextLink": "https://bb-prod-wcus-1.farmbeats.azure.net/application-data?api-version=2021-03-31-preview&$skipToken=ffa6d232-0892-4e7e-bc8d-6acb12645251" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json index 5b0d758e3ae4..c9034ea0b9ed 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", + "farmerId": "Farmer123", "api-version": "2021-03-31-preview" }, "responses": { @@ -9,55 +9,53 @@ "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", + "productName": "Product123", "isCarrier": false, - "totalMaterial": { - "unit": "kilos", - "value": 4 - }, "avgMaterial": { "unit": "kilosperacre", - "value": 0.2 + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 }, - "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" + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json index 09ce3d8c2053..0555328dc7e3 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json @@ -19,13 +19,7 @@ "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" - } + "resourceType": "boundary" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json index aa0fba378785..8a44e2a721e6 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json index 163cbf16f9e4..071b842541ba 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json @@ -1,19 +1,20 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview", "body": { - "farmerId": "TEST-FARMER", + "farmerId": "Farmer123", "authProviderId": "JOHNDEERE", "operations": [ "AllOperations" ], "startYear": 2012, - "name": "Farm Operations Job", - "description": "For TEST-FARMER", + "name": "Test farm operations job", + "description": "Test farm operations job details", "properties": { - "Operation": "All" + "Region": "Central US", + "RetailerId": 123 } } }, @@ -27,17 +28,18 @@ "durationInSeconds": 14.79, "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7", "status": "Waiting", - "message": "string", + "message": "Created job to ingest farm operations data for job name 'Job123', farmer id 'Farmer123'.", "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", + "name": "Test farm operations job", + "description": "Test farm operations job details", "properties": { - "Operation": "All" + "Region": "Central US", + "RetailerId": 123 }, - "farmerId": "TEST-FARMER", + "farmerId": "Farmer123", "authProviderId": "JOHNDEERE" } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json index 19947892604d..982aa60223bc 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json @@ -1,26 +1,27 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview" }, "responses": { "200": { "body": { "durationInSeconds": 11.2, - "id": "farm-operations-job", + "id": "Job123", "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", + "name": "Farm operations job", + "description": "Farm operations job details", "properties": { - "Region": "Asia" + "Region": "Central US", + "RetailerId": 123 }, - "farmerId": "FARMER123", + "farmerId": "Farmer123", "authProviderId": "JOHNDEERE", "operations": [ "AllOperations" diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json index a7d2c1e25a5b..4c41fbdd9aeb 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json @@ -18,13 +18,7 @@ "endTime": "2021-04-19T11:31:34Z", "farmerId": "FARMER123", "resourceId": "FARMER123", - "resourceType": "farmer", - "name": "John Smith", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - } + "resourceType": "farmer" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json index fa3c14969a1d..24cf8a5c8f36 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json index 4a26aca784c9..dd78c9aa4e89 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json @@ -19,13 +19,7 @@ "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" - } + "resourceType": "farm" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json index 3721e59fb36c..76a9400b995d 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json index 3db893452b2a..45fd781771bb 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json @@ -19,13 +19,7 @@ "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" - } + "resourceType": "field" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json index fe5878968de1..a4f99959cb1d 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..b9eb70d322f5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "harvestDataId": "Harvest123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Harvest123", + "resourceType": "harvestdata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'harvestdata' resource with id 'Harvest123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T11:55:34Z", + "lastActionDateTime": "2021-06-19T11:55:34Z", + "startTime": "2021-06-19T11:55:34Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json index 1b81b715ffee..31a7b46a7184 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json @@ -2,22 +2,9 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "harvestDataId": "HARVESTOP123", + "farmerId": "Farmer123", + "harvestDataId": "Harvest123", "harvestData": { - "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 @@ -44,7 +31,7 @@ }, "harvestProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", "value": 30 @@ -55,7 +42,11 @@ }, "avgYield": { "unit": "kilosperacre", - "value": 30 + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 }, "totalWetMass": { "unit": "kilos", @@ -64,52 +55,46 @@ "avgWetMass": { "unit": "kilosperacre", "value": 10 - }, - "avgMoisture": { - "unit": "percent", - "value": 16.4 } } ], + "area": { + "unit": "acre", + "value": 30 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test harvest data", + "description": "Test harvest data description", "properties": { - "Region": "Europe", - "CountyCode": 123 + "Region": "Central US", + "RetailerId": 123 } } }, "responses": { - "200": { + "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 + "value": 1400.0 }, "avgYield": { "unit": "kilosperacre", - "value": 28 + "value": 28.0 }, "totalWetMass": { "unit": "kilos", - "value": 500 + "value": 500.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 + "value": 10.0 }, "avgMoisture": { "unit": "percent", @@ -121,75 +106,74 @@ }, "harvestProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 30 + "value": 30.0 }, "totalYield": { "unit": "kilos", - "value": 900 + "value": 900.0 }, "avgYield": { "unit": "kilosperacre", - "value": 30 + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 }, "totalWetMass": { "unit": "kilos", - "value": 300 + "value": 300.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 - }, - "avgMoisture": { - "unit": "percent", - "value": 16.4 + "value": 10.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", "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 - }, + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "200": { + "body": { "totalYield": { "unit": "kilos", - "value": 1400 + "value": 1400.0 }, "avgYield": { "unit": "kilosperacre", - "value": 28 + "value": 28.0 }, "totalWetMass": { "unit": "kilos", - "value": 500 + "value": 500.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 + "value": 10.0 }, "avgMoisture": { "unit": "percent", @@ -201,41 +185,55 @@ }, "harvestProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 30 + "value": 30.0 }, "totalYield": { "unit": "kilos", - "value": 900 + "value": 900.0 }, "avgYield": { "unit": "kilosperacre", - "value": 30 + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 }, "totalWetMass": { "unit": "kilos", - "value": 300 + "value": 300.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 - }, - "avgMoisture": { - "unit": "percent", - "value": 16.4 + "value": 10.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json index 88c5785f4045..642cb085baa0 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "harvestDataId": "HARVESTOP123" + "farmerId": "Farmer123", + "harvestDataId": "Harvest123", + "api-version": "2021-03-31-preview" }, "responses": { "204": {} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json index caae9cb85c56..b745fe382f5f 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json @@ -2,42 +2,27 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "harvestDataId": "HARVESTOP123" + "farmerId": "Farmer123", + "harvestDataId": "Harvest123" }, "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 + "value": 1400.0 }, "avgYield": { "unit": "kilosperacre", - "value": 28 + "value": 28.0 }, "totalWetMass": { "unit": "kilos", - "value": 500 + "value": 500.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 + "value": 10.0 }, "avgMoisture": { "unit": "percent", @@ -49,41 +34,56 @@ }, "harvestProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 30 + "value": 30.0 }, "totalYield": { "unit": "kilos", - "value": 900 + "value": 900.0 }, "avgYield": { "unit": "kilosperacre", - "value": 30 + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 }, "totalWetMass": { "unit": "kilos", - "value": 300 + "value": 300.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 - }, - "avgMoisture": { - "unit": "percent", - "value": 16.4 + "value": 10.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Harvest123&resourceTypes=HarvestData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..8cf31a9ff735 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Harvest123", + "resourceType": "harvestdata", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 0.9115014, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T11:55:34Z", + "lastActionDateTime": "2021-06-19T11:55:35Z", + "startTime": "2021-06-19T11:55:34Z", + "endTime": "2021-06-19T11:55:35Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json index 7eecebcce739..5e2ad3cb52bd 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json @@ -1,43 +1,29 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" + "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:14:12Z", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "area": { - "unit": "acre", - "value": 50 - }, "totalYield": { "unit": "kilos", - "value": 1400 + "value": 1400.0 }, "avgYield": { "unit": "kilosperacre", - "value": 28 + "value": 28.0 }, "totalWetMass": { "unit": "kilos", - "value": 500 + "value": 500.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 + "value": 10.0 }, "avgMoisture": { "unit": "percent", @@ -49,45 +35,59 @@ }, "harvestProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 30 + "value": 30.0 }, "totalYield": { "unit": "kilos", - "value": 900 + "value": 900.0 }, "avgYield": { "unit": "kilosperacre", - "value": 30 + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 }, "totalWetMass": { "unit": "kilos", - "value": 300 + "value": 300.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 - }, - "avgMoisture": { - "unit": "percent", - "value": 16.4 + "value": 10.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Harvest123&resourceTypes=HarvestData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } ], - "$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" + "nextLink": "https://test.farmbeats.azure.net/planting-data?api-version=2021-03-31-preview&$skipToken=2d7dad55-cfa9-4760-b198-0df17ec2fb65" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json index fdab67c54d14..9c884906cde0 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json @@ -2,43 +2,28 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123" + "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 + "value": 1400.0 }, "avgYield": { "unit": "kilosperacre", - "value": 28 + "value": 28.0 }, "totalWetMass": { "unit": "kilos", - "value": 500 + "value": 500.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 + "value": 10.0 }, "avgMoisture": { "unit": "percent", @@ -50,45 +35,58 @@ }, "harvestProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 30 + "value": 30.0 }, "totalYield": { "unit": "kilos", - "value": 900 + "value": 900.0 }, "avgYield": { "unit": "kilosperacre", - "value": 30 + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 }, "totalWetMass": { "unit": "kilos", - "value": 300 + "value": 300.0 }, "avgWetMass": { "unit": "kilosperacre", - "value": 10 - }, - "avgMoisture": { - "unit": "percent", - "value": 16.4 + "value": 10.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Harvest123&resourceTypes=HarvestData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } - ], - "$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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json index b3dc595eb9bd..77685a7910b8 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json @@ -1,19 +1,20 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview", "body": { - "farmerId": "test_farmer", - "shapefileAttachmentId": "harvesting_data_shapefile123", + "farmerId": "Farmer123", + "shapefileAttachmentId": "HarvestingDataShapefile123", "shapefileColumnNames": [ "Wet_yield", "Dry_yield" ], - "name": "Harvest_Data_Rasterize_Job", - "description": "Rasterize harvest data shape file", + "name": "Harvest data rasterize job", + "description": "Harvest data rasterize job details", "properties": { - "region": "Asia" + "Region": "Central US", + "RetailerId": 123 } } }, @@ -21,23 +22,24 @@ "202": { "body": { "durationInSeconds": 12.4, - "id": "weather-job", + "id": "Job123", "status": "Waiting", - "message": "Created job to fetch weather data for job name 'TestWeatherJob', farmer id 'test_farmer' and field id 'test_field'.", + "message": "Created job to rasterize shapefile for job name 'Job123', farmer id 'Farmer123' and shapefileAttachment id 'HarvestingDataShapefile123'.", "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", + "farmerId": "Farmer123", + "shapefileAttachmentId": "HarvestingDataShapefile123", "shapefileColumnNames": [ "Wet_yield", "Dry_yield" ], - "name": "Harvest_Data_Rasterize_Job", - "description": "Rasterize harvest data shape file", + "name": "Harvest data rasterize job", + "description": "Harvest data rasterize job details", "properties": { - "region": "Asia" + "Region": "Central US", + "RetailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json index 62face2583c2..1fe7dac4a5f2 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json @@ -1,30 +1,31 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview" }, "responses": { "200": { "body": { "durationInSeconds": 12.4, - "id": "weather-job", + "id": "Job123", "status": "Succeeded", - "message": "Weather data is available for startTime to endTime", + "message": "Rasterization of shapefile is completed", "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", + "farmerId": "Farmer123", + "shapefileAttachmentId": "HarvestingDataShapefile123", "shapefileColumnNames": [ "Wet_yield", "Dry_yield" ], - "name": "Harvest_Data_Rasterize_Job", - "description": "Rasterize harvest data shape file", + "name": "Harvest data rasterize job", + "description": "Harvest data rasterize job details", "properties": { - "region": "Asia" + "Region": "Central US", + "RetailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..5efbae69a6ce --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "oauthProviderId": "JOHNDEERE", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for oauth provider 'JOHNDEERE'.", + "createdDateTime": "2021-06-19T13:21:49Z", + "lastActionDateTime": "2021-06-19T13:21:49Z", + "startTime": "2021-06-19T13:21:49Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json index 80139cdbf05e..70e0719a0cac 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json @@ -8,10 +8,11 @@ "appSecret": "appSecret", "apiKey": "apiKey", "isProductionApp": false, - "name": "JOHNDEERE", - "description": "some description", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", "properties": { - "orgId": "ORG123" + "Region": "Central US", + "RetailerId": 123 } } }, @@ -20,13 +21,12 @@ "body": { "id": "JOHNDEERE", "appId": "appId", - "appSecret": "appSecret", - "apiKey": "apiKey", "isProductionApp": false, - "name": "JOHNDEERE", - "description": "some description", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", "properties": { - "orgId": "ORG123" + "Region": "Central US", + "RetailerId": 123 }, "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", "createdDateTime": "2021-04-23T11:31:10Z", @@ -37,13 +37,12 @@ "body": { "id": "JOHNDEERE", "appId": "appId", - "appSecret": "appSecret", - "apiKey": "apiKey", "isProductionApp": false, - "name": "JOHNDEERE", - "description": "some description", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", "properties": { - "orgId": "ORG123" + "Region": "Central US", + "RetailerId": 123 }, "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", "createdDateTime": "2021-04-23T11:31:10Z", diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json index 994c7a7013be..5f70efb1d71c 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json @@ -8,17 +8,16 @@ "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", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", "properties": { - "Farmer": "123" + "Region": "Central US", + "RetailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..ed961b3625d8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "oauthProviderId": "CLIMATE", + "id": "J12", + "status": "Succeeded", + "durationInSeconds": 5.154055, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T13:21:49Z", + "lastActionDateTime": "2021-06-19T13:21:54Z", + "startTime": "2021-06-19T13:21:49Z", + "endTime": "2021-06-19T13:21:54Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json index 3777236bf4b3..03aeb49776ac 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json @@ -8,23 +8,20 @@ "body": { "value": [ { - "appId": "appId", - "appSecret": "appSecret", - "apiKey": "apiKey", + "appId": "0oagl9ap4plg0p6fn1t7ss", "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", + "eTag": "0200239b-0000-0600-0000-60c87b7b0000", + "createdDateTime": "2021-06-15T10:05:47Z", + "modifiedDateTime": "2021-06-15T10:05:47Z", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", "properties": { - "Farmer": "123" + "Region": "Central US", + "RetailerId": 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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json index 65800d1eba15..4924b6b5fd04 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json @@ -1,20 +1,20 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOBID123", - "farmerId": "FARMER123", + "jobId": "Job123", + "farmerId": "Farmer123", "oauthProviderId": "JOHNDEERE", "api-version": "2021-03-31-preview" }, "responses": { "202": { "body": { - "farmerId": "FARMER123", + "farmerId": "Farmer123", "resourceId": "JOHNDEERE", "resourceType": "oauthtokeninfo", - "id": "JOBID123", + "id": "Job123", "status": "Waiting", - "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'FARMER123'.", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'Farmer123'.", "createdDateTime": "2021-05-13T20:04:39Z", "lastActionDateTime": "2021-05-13T20:04:39Z", "startTime": "2021-05-13T20:04:37Z" diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json index 9a263d908ddf..dff4c27ebfd3 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json @@ -1,18 +1,18 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOBID123", + "jobId": "Job123", "api-version": "2021-03-31-preview" }, "responses": { "200": { "body": { - "farmerId": "FARMER123", + "farmerId": "Farmer123", "resourceId": "JOHNDEERE", "resourceType": "oauthtokeninfo", - "id": "JOBID123", + "id": "Job123", "status": "Waiting", - "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'FARMER123'.", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'Farmer123'.", "createdDateTime": "2021-05-13T20:04:39Z", "lastActionDateTime": "2021-05-13T20:04:39Z", "startTime": "2021-05-13T20:04:37Z" diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json index 31c435205661..cdded3a90641 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", "body": { - "farmerId": "FARMER123", + "farmerId": "Farmer123", "oAuthProviderId": "JOHNDEERE", "userRedirectLink": "https://docs.microsoft.com", "userRedirectState": "code" diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json index 7ccb4143441b..a1db524cb2e2 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json @@ -8,16 +8,14 @@ "body": { "value": [ { - "farmerId": "FARMER123", + "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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..d55ceb369a18 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "plantingDataId": "Planting123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Planting123", + "resourceType": "plantingdata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'plantingdata' resource with id 'Planting123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T11:09:35Z", + "lastActionDateTime": "2021-06-19T11:09:35Z", + "startTime": "2021-06-19T11:09:35Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json index 3c9dad916c1e..66ce59f30a5f 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json @@ -2,26 +2,13 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "plantingDataId": "PLANTINGOP123", + "farmerId": "Farmer123", + "plantingDataId": "Planting123", "plantingData": { - "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 @@ -32,7 +19,7 @@ }, "plantingProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", "value": 20 @@ -47,123 +34,134 @@ } } ], + "area": { + "unit": "acre", + "value": 30 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test planting data", + "description": "Test planting data details", "properties": { - "Region": "Europe", - "CountyCode": 123 + "Region": "Central US", + "RetailerId": 123 } } }, "responses": { - "200": { + "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 + "value": 30.0 }, "totalMaterial": { "unit": "seeds", - "value": 758814 + "value": 758814.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 25293 + "value": 25293.0 }, "plantingProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 20 + "value": 20.0 }, "totalMaterial": { "unit": "seeds", - "value": 389214 + "value": 389214.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 19460 + "value": 19460.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", "operationStartDateTime": "2021-02-25T16:57:04Z", "operationEndDateTime": "2021-02-27T10:13:06Z", - "operationModifiedDateTime": "2021-02-28T10:14:12Z", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "200": { + "body": { "avgPlantingRate": { "unit": "seedsperacre", - "value": 30 - }, - "area": { - "unit": "acre", - "value": 30 + "value": 30.0 }, "totalMaterial": { "unit": "seeds", - "value": 758814 + "value": 758814.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 25293 + "value": 25293.0 }, "plantingProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 20 + "value": 20.0 }, "totalMaterial": { "unit": "seeds", - "value": 389214 + "value": 389214.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 19460 + "value": 19460.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json index 8b17313f1110..02a7b6acb22a 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "plantingDataId": "PLANTINGOP123" + "farmerId": "Farmer123", + "plantingDataId": "Planting123", + "api-version": "2021-03-31-preview" }, "responses": { "204": {} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json index 155712c370fd..c3b63e06ed10 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json @@ -2,64 +2,64 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "plantingDataId": "PLANTINGOP123" + "farmerId": "Farmer123", + "plantingDataId": "Planting123" }, "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 + "value": 30.0 }, "totalMaterial": { "unit": "seeds", - "value": 758814 + "value": 758814.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 25293 + "value": 25293.0 }, "plantingProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 20 + "value": 20.0 }, "totalMaterial": { "unit": "seeds", - "value": 389214 + "value": 389214.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 19460 + "value": 19460.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Planting123&resourceTypes=PlantingData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d9271c70f746 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Planting123", + "resourceType": "plantingdata", + "id": "Job1234", + "status": "Succeeded", + "durationInSeconds": 2.73909, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T11:09:35Z", + "lastActionDateTime": "2021-06-19T11:09:38Z", + "startTime": "2021-06-19T11:09:35Z", + "endTime": "2021-06-19T11:09:38Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json index b6c59eaee01a..e04e6b9919c2 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json @@ -1,69 +1,69 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" + "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 + "value": 30.0 }, "totalMaterial": { "unit": "seeds", - "value": 758814 + "value": 758814.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 25293 + "value": 25293.0 }, "plantingProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 20 + "value": 20.0 }, "totalMaterial": { "unit": "seeds", - "value": 389214 + "value": 389214.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 19460 + "value": 19460.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Planting123&resourceTypes=PlantingData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } ], - "$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" + "nextLink": "https://test.farmbeats.azure.net/planting-data?api-version=2021-03-31-preview&$skipToken=2d7dad55-cfa9-4760-b198-0df17ec2fb65" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json index 7bb636bba095..428296e0c1a7 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json @@ -9,62 +9,60 @@ "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 + "value": 30.0 }, "totalMaterial": { "unit": "seeds", - "value": 758814 + "value": 758814.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 25293 + "value": 25293.0 }, "plantingProductDetails": [ { - "productName": "VAR1", + "productName": "Product123", "area": { "unit": "acre", - "value": 20 + "value": 20.0 }, "totalMaterial": { "unit": "seeds", - "value": 389214 + "value": 389214.0 }, "avgMaterial": { "unit": "seedsperacre", - "value": 19460 + "value": 19460.0 } } ], - "properties": { - "Region": "Europe", - "CountyCode": 123 + "area": { + "unit": "acre", + "value": 30.0 }, - "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" + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Planting123&resourceTypes=PlantingData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } } - ], - "$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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json index 3e97b7391d97..e2904fe8beb0 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json @@ -1,20 +1,18 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview", "body": { - "boundaryId": "BOUNDARY123", - "farmerId": "FARMER123", - "startDateTime": "2020-04-16T10:14:12Z", + "boundaryId": "Boundary123", "endDateTime": "2021-04-16T10:14:12Z", + "farmerId": "Farmer123", + "startDateTime": "2020-04-16T10:14:12Z", "provider": "Microsoft", "source": "Sentinel_2_L2A", - "name": "North Farm 2019 satellite imagery", - "description": "Test job", "data": { "imageFormats": [ - "Tif" + "TIF" ], "imageNames": [ "NDVI" @@ -23,28 +21,45 @@ 10.0 ] }, + "name": "Test satellite job", + "description": "Test satellite job details", "properties": { - "Region": "Asia" + "Region": "Central US", + "RetailerId": 123 } } }, "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", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageNames": [ + "NDVI" + ], + "imageFormats": [ + "TIF" + ], + "imageResolutions": [ + 10.0 + ] + }, + "id": "Job123", + "status": "Waiting", + "message": "Created job 'Job123' to fetch satellite data for boundary 'Boundary123' from startDate '04/16/2020' to endDate '04/16/2021' (both inclusive).", + "createdDateTime": "2021-06-19T15:30:50Z", + "lastActionDateTime": "2021-06-19T15:30:50Z", + "startTime": "2021-06-19T15:30:50Z", + "name": "Test satellite job", + "description": "Test satellite job details", "properties": { - "Region": "Asia" + "region": "Central US", + "retailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json index 0fe996302727..7323e0bd0174 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "filePath": "https://filePath", + "filePath": "Microsoft%2fSentinel_2_L2A%2fFarmer123%2fBoundary123%2f2021-04-16%2f00-00-00%2fndvi_10.tif", "api-version": "2021-03-31-preview" }, "responses": { diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json index 07ac177ebd7d..3438c104e95a 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json @@ -1,41 +1,42 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "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", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", "startDateTime": "2020-04-16T10:14:12Z", "endDateTime": "2021-04-16T10:14:12Z", "provider": "Microsoft", "source": "Sentinel_2_L2A", "data": { - "imageFormats": [ - "Tif" - ], "imageNames": [ "NDVI" ], + "imageFormats": [ + "TIF" + ], "imageResolutions": [ 10.0 ] + }, + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 14.2833851, + "message": "Satellite data is available for 73 days from provider in the requested date range. Successfully fetched data for 73 days.", + "createdDateTime": "2021-06-19T15:30:50Z", + "lastActionDateTime": "2021-06-19T15:31:04Z", + "startTime": "2021-06-19T15:30:50Z", + "endTime": "2021-06-19T15:31:04Z", + "name": "Test satellite job", + "description": "Test satellite job details", + "properties": { + "region": "Central US", + "retailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json index cd555fe0682f..6dbc301b029b 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "provider": "Microsoft", - "farmerId": "FARMER123", - "boundaryId": "BOUNDARY123", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", "api-version": "2021-03-31-preview" }, "responses": { @@ -11,131 +11,47 @@ "body": { "value": [ { - "id": "400e200f-ccc4-0cea-c120-3fdc6a41f99f", - "sceneDateTime": "2019-01-27T00:00:00Z", - "boundaryId": "BOUNDARY123", - "farmerId": "FARMER123", + "sceneDateTime": "2021-04-16T00:00:00Z", "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" - }, - { + "fileLink": "https://test.farmbeats.azure.net/scenes/downloadFiles?api-version=2021-03-31-preview&filePath=Microsoft%2fSentinel_2_L2A%2fFarmer123%2fBoundary123%2f2021-04-16%2f00-00-00%2fndvi_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" - }, + "resolution": 10.0 + } + ], + "imageFormat": "TIF", + "cloudCoverPercentage": 0.0, + "darkPixelPercentage": 0.0, + "ndviMedianValue": 0.43166860938072205, + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "id": "4e533975-5cfc-5b54-b216-6c6a0fdb387b", + "eTag": "03007b6d-0000-0600-0000-60ce0db80000" + }, + { + "sceneDateTime": "2021-04-11T00:00:00Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "imageFiles": [ { - "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" + "fileLink": "https://test.farmbeats.azure.net/scenes/downloadFiles?api-version=2021-03-31-preview&filePath=Microsoft%2fSentinel_2_L2A%2fFarmer123%2fBoundary123%2f2021-04-11%2f00-00-00%2fndvi_10.tif", + "name": "NDVI", + "resolution": 10.0 } - ] + ], + "imageFormat": "TIF", + "cloudCoverPercentage": 0.0, + "darkPixelPercentage": 0.0, + "ndviMedianValue": 0.41777390241622925, + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "id": "4ebdef7f-3ade-7750-0096-2c5024eb72c0", + "eTag": "0300796d-0000-0600-0000-60ce0db80000" } ], - "$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" + "nextLink": "https://test.farmbeats.azure.net/scenes?provider=Microsoft&farmerId=Farmer123&boundaryId=Boundary123&source=Sentinel_2_L2A&api-version=2021-03-31-preview&$skipToken=W3sidG9rZW4iOiIrUklEOn5Qa1pRQU1teHVDWVVQZ0VBQUFBQUFBPT0jUlQ6MSNUUkM6NTAjUlREOm4rVGxTTDV1UEkzZjhDSUxkNys1QlRNeE16RXVNVGt1TVRwVk1URTdNVEU3TVRGYkFBPT0jSVNWOjIjSUVPOjY1NTY3I1FDRjo3I0ZQQzpBZXc5QVFBQUFBQUFORDRCQUFBQUFBQT0iLCJyYW5nZSI6eyJtaW4iOiIiLCJtYXgiOiIxRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRiJ9fV0" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..16ba808c4004 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "tillageDataId": "Tillage123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Tillage123", + "resourceType": "tillagedata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'tillagedata' resource with id 'Tillage123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T12:27:56Z", + "lastActionDateTime": "2021-06-19T12:27:56Z", + "startTime": "2021-06-19T12:27:56Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json index 4dfc09b2a20b..7115dc5ceda2 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json @@ -2,105 +2,103 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "tillageDataId": "TILLAGEOP123", + "farmerId": "Farmer123", + "tillageDataId": "Tillage123", "tillageData": { - "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 + "tillageDepth": { + "unit": "cms", + "value": 9.5 }, "tillagePressure": { "unit": "kg per sq cms", "value": 950 }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 + "area": { + "unit": "acre", + "value": 30 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test tillage data", + "description": "Test tillage data description", "properties": { - "Region": "Europe", - "CountyCode": 123 + "Region": "Central US", + "RetailerId": 123 } } }, "responses": { - "200": { + "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 + "tillageDepth": { + "unit": "cms", + "value": 9.5 }, "tillagePressure": { "unit": "kg per sq cms", - "value": 950 + "value": 950.0 }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 + "area": { + "unit": "acre", + "value": 30.0 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", "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" + "Region": "Central US", + "RetailerId": 123 + } } }, - "201": { + "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 + "tillageDepth": { + "unit": "cms", + "value": 9.5 }, "tillagePressure": { "unit": "kg per sq cms", - "value": 950 + "value": 950.0 }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 + "area": { + "unit": "acre", + "value": 30.0 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", "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" + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json index 8ab38e14e5fb..052a95b5a0cd 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "tillageDataId": "TILLAGEOP123" + "farmerId": "Farmer123", + "tillageDataId": "Tillage123", + "api-version": "2021-03-31-preview" }, "responses": { "204": {} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json index a9499ed7990f..4e70cbc636c1 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json @@ -2,43 +2,43 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "tillageDataId": "TILLAGEOP123" + "farmerId": "Farmer123", + "tillageDataId": "Tillage123" }, "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 + "tillageDepth": { + "unit": "cms", + "value": 9.5 }, "tillagePressure": { "unit": "kg per sq cms", - "value": 950 + "value": 950.0 }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 + "area": { + "unit": "acre", + "value": 30.0 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Tillage123&resourceTypes=TillageData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", "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" + "Region": "Central US", + "RetailerId": 123 + } } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..f8bdc2c408b1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Tillage123", + "resourceType": "tillagedata", + "id": "Job1234", + "status": "Succeeded", + "durationInSeconds": 2.73909, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T11:09:35Z", + "lastActionDateTime": "2021-06-19T11:09:38Z", + "startTime": "2021-06-19T11:09:35Z", + "endTime": "2021-06-19T11:09:38Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json index 52e57fe5de5e..45b28cb2a4e9 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json @@ -1,48 +1,48 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" + "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 + "tillageDepth": { + "unit": "cms", + "value": 9.5 }, "tillagePressure": { "unit": "kg per sq cms", - "value": 950 + "value": 950.0 }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 + "area": { + "unit": "acre", + "value": 30.0 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Tillage123&resourceTypes=TillageData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", "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" + "Region": "Central US", + "RetailerId": 123 + } } ], - "$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" + "nextLink": "https://test.farmbeats.azure.net/planting-data?api-version=2021-03-31-preview&$skipToken=2d7dad55-cfa9-4760-b198-0df17ec2fb65" } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json index 240a3548c76b..62c94adf2f67 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json @@ -2,48 +2,46 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", - "farmerId": "FARMER123" + "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 + "tillageDepth": { + "unit": "cms", + "value": 9.5 }, "tillagePressure": { "unit": "kg per sq cms", - "value": 950 + "value": 950.0 }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 + "area": { + "unit": "acre", + "value": 30.0 }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Tillage123&resourceTypes=TillageData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", "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" + "Region": "Central US", + "RetailerId": 123 + } } - ], - "$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/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json index 98a2a1267033..e17fd42cf841 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json @@ -1,41 +1,41 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview", "body": { - "extensionId": "dtn.clearAg", - "farmerId": "test_farmer", - "boundaryId": "test_farmer", - "weatherDataType": "forecast", + "boundaryId": "Boundary123", + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "weatherDataType": "historical", "granularity": "daily", - "startDateTime": "2021-04-18T01:32:42Z", - "endDateTime": "2021-04-18T01:32:42Z", - "name": "Delete Job", - "description": "For extension dtn.clearAg", + "name": "Test delete weather job", + "description": "Test delete weather job details", "properties": { - "region": "US" + "Region": "Central US", + "RetailerId": 123 } } }, "responses": { "202": { "body": { - "durationInSeconds": 12.4, - "id": "delete-weather-job", + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "weatherDataType": "historical", + "granularity": "daily", + "id": "Job123", "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", + "message": "Created weather data delete job for farmer id 'Farmer123', boundary id 'Boundary123' and extension id 'DTN.ClearAg'", + "createdDateTime": "2021-06-19T15:13:15Z", + "lastActionDateTime": "2021-06-19T15:13:15Z", + "startTime": "2021-06-19T15:13:15Z", + "name": "Test delete weather job", + "description": "Test delete weather job details", "properties": { - "region": "US" + "region": "Central US", + "retailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json index 27b4b7a446cc..3a004def2cd2 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json @@ -1,47 +1,51 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "jobId": "Job123", "api-version": "2021-03-31-preview", "body": { - "farmerId": "test_farmer", - "boundaryId": "test_boundary", - "extensionId": "dtn.clearAg", - "extensionApiName": "dailyforecast", + "boundaryId": "Boundary123", "extensionApiInput": { - "start": 0, - "end": 5 + "location": "47.922759,-97.089954", + "start": "1606262400", + "end": "1606780800" }, - "name": "TestWeatherJob", - "description": "Daily Forecast data for 5 days", + "extensionApiName": "dailyhistorical", + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "extensionDataProviderAppId": "12...ca0", + "extensionDataProviderApiKey": "c743a0f....1eed0709", + "name": "Test weather job", + "description": "Test weather job details", "properties": { - "region": "Asia" + "Region": "Central US", + "RetailerId": 123 } } }, "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", + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "extensionId": "DTN.ClearAg", + "extensionApiName": "dailyhistorical", "extensionApiInput": { - "start": 0, - "end": 5 + "location": "47.922759,-97.089954", + "start": "1606262400", + "end": "1606780800" }, - "name": "TestWeatherJob", - "description": "Daily Forecast data for 5 days", + "id": "Job123", + "status": "Waiting", + "message": "Created job 'Job123' to fetch weather data for farmer id 'Farmer123' and boundary id 'Boundary123'.", + "createdDateTime": "2021-06-19T14:52:22Z", + "lastActionDateTime": "2021-06-19T14:52:22Z", + "startTime": "2021-06-19T14:52:22Z", + "name": "Test weather job", + "description": "Test weather job details", "properties": { - "region": "Asia" + "region": "Central US", + "retailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json index 91bd4cb389ae..ca4050c0b333 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json @@ -1,29 +1,30 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "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", + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "weatherDataType": "historical", "granularity": "daily", - "startDateTime": "2021-04-18T01:32:42Z", - "endDateTime": "2021-04-18T01:32:42Z", - "name": "Delete Job", - "description": "For extension dtn.clearAg", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 2.7015882, + "message": "Created weather data delete job for farmer id 'Farmer123', boundary id 'Boundary123' and extension id 'DTN.ClearAg'", + "createdDateTime": "2021-06-19T15:13:15Z", + "lastActionDateTime": "2021-06-19T15:13:18Z", + "startTime": "2021-06-19T15:13:15Z", + "endTime": "2021-06-19T15:13:18Z", + "name": "Test delete weather job", + "description": "Test delete weather job details", "properties": { - "region": "US" + "region": "Central US", + "retailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json index 9b4a6f6ac0e9..14a80af2347c 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json @@ -1,32 +1,34 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOB123", + "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", + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "extensionId": "DTN.ClearAg", + "extensionApiName": "dailyhistorical", "extensionApiInput": { - "start": 0, - "end": 5 + "location": "47.922759,-97.089954", + "start": "1606262400", + "end": "1606780800" }, - "name": "TestWeatherJob", - "description": "Daily Forecast data for 5 days", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 2.9322843, + "message": "Weather data available from '11/25/2020 00:00:00' to '11/30/2020 00:00:00'.", + "createdDateTime": "2021-06-19T14:52:22Z", + "lastActionDateTime": "2021-06-19T14:52:25Z", + "startTime": "2021-06-19T14:52:22Z", + "endTime": "2021-06-19T14:52:25Z", + "name": "Test weather job", + "description": "Test weather job details", "properties": { - "region": "Asia" + "region": "Central US", + "retailerId": 123 } } } diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json index 837c992aaa74..1ee1d1fc9f3a 100644 --- a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json @@ -1,11 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "boundaryId": "BOUNDARY123", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", "extensionId": "DTN.ClearAg", - "weatherDataType": "Historical", - "granularity": "Daily", + "weatherDataType": "historical", + "granularity": "daily", "api-version": "2021-03-31-preview" }, "responses": { @@ -13,66 +13,81 @@ "body": { "value": [ { - "id": "ecd327e7-07f1-31b1-65ee-2162e193c055", - "farmerId": "test_farmer", - "boundaryId": "test_boundary", - "extensionId": "dtn.clearAg", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "extensionId": "DTN.ClearAg", "location": { - "latitude": 77.75695801443568, - "longitude": 12.30932563432023 + "latitude": 47.922759, + "longitude": -97.089954 }, - "dateTime": "2020-12-23T00:00:00Z", + "dateTime": "2020-11-30T00:00:00Z", "unitSystemCode": "us-std", "extensionVersion": "1.0", - "weatherDataType": "forecast", + "weatherDataType": "historical", "granularity": "daily", "cloudCover": { "unit": "%", - "value": 81.1 + "value": 10.2 }, "dewPoint": { "unit": "F", - "value": 26.0 + "value": 12.0 }, "precipitation": { "unit": "in", - "value": 0.1 + "value": 0.0 }, "relativeHumidity": { "unit": "%", - "value": 74.0 + "value": 70.0 }, "temperature": { "unit": "F", - "value": 33.0 + "value": 21.0 + }, + "visibility": { + "unit": "mi", + "value": 10.0 }, "windGust": { "unit": "mph", - "value": 50.0 + "value": 26.0 }, "windSpeed": { "unit": "mph", - "value": 31.0 + "value": 12.0 }, - "eTag": "\"2b00a419-0000-0700-0000-5fe1ae4c0000\"", + "id": "b947d00f-5078-9bfa-f97a-1ef1ce54756a", + "eTag": "03002f6d-0000-0600-0000-60ce04a90000", + "createdDateTime": "2021-06-19T14:52:25Z", + "modifiedDateTime": "2021-06-19T14:52:25Z", "properties": { - "air_temp_max": { + "airTempMax": { "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", + "value": 35.0 + }, + "airTempMin": { + "unit": "F", + "value": 10.0 + }, + "cloudCoverMax": { + "unit": "%", + "value": 59.7 + }, + "cloudCoverMin": { + "unit": "%", + "value": 0.0 + }, + "cloudCoverAvgDescriptor": "Sunny", + "cloudCoverMaxDescriptor": "Partly Cloudy", + "cloudCoverMinDescriptor": "Sunny", "dewPointMax": { "unit": "F", - "value": 28.0 + "value": 18.0 }, "dewPointMin": { "unit": "F", - "value": 22.0 + "value": 6.0 }, "iceAccPeriod": { "unit": "in", @@ -84,55 +99,83 @@ }, "longWaveRadiationAvg": { "unit": "W/m^2", - "value": 291.0 + "value": 210.0 + }, + "longWaveRadiationMax": { + "unit": "W/m^2", + "value": 264.0 + }, + "longWaveRadiationMin": { + "unit": "W/m^2", + "value": 173.0 }, "petPeriod": { "unit": "in", - "value": 0.04 + "value": 0.02 }, - "precipProb": { + "precipAccPeriodAdjusted": { "unit": "%", - "value": 75.0 + "value": 0.0 + }, + "precipAccPeriodRaw": { + "unit": "%", + "value": 0.0 }, "relativeHumidityMax": { "unit": "%", - "value": 81.0 + "value": 82.0 }, "relativeHumidityMin": { "unit": "%", - "value": 69.0 + "value": 46.0 }, "shortWaveRadiationAvg": { + "unit": "W/m^2", + "value": 44.0 + }, + "shortWaveRadiationMax": { + "unit": "W/m^2", + "value": 220.0 + }, + "shortWaveRadiationMin": { "unit": "W/m^2", "value": 0.0 }, "snowAccPeriod": { "unit": "in", - "value": 0.7 + "value": 0.0 }, "sunshineDuration": { "unit": "hours", - "value": 0.0 + "value": 2.0 + }, + "visibilityMax": { + "unit": "mi", + "value": 10.0 + }, + "visibilityMin": { + "unit": "mi", + "value": 10.0 }, "windSpeed2mAvg": { "unit": "mph", - "value": 24.0 + "value": 9.0 }, "windSpeed2mMax": { "unit": "mph", - "value": 32.0 + "value": 14.0 }, "windSpeed2mMin": { "unit": "mph", - "value": 17.0 + "value": 4.0 }, "windSpeedMax": { "unit": "mph", - "value": 42.0 + "value": 18.0 }, "windSpeedMin": { "unit": "mph", - "value": 23.0 + "value": 5.0 } } }