diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json new file mode 100644 index 000000000000..95c90982df4f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json @@ -0,0 +1,25061 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Azure Data Manager for Agriculture Data Plane Service", + "description": "APIs documentation for Microsoft Azure Data Manager for Agriculture DataPlane Service.", + "version": "2023-06-01-preview" + }, + "paths": { + "/application-data": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Returns a paginated list of application data resources across all parties.", + "operationId": "ApplicationData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationData_List": { + "$ref": "./examples/ApplicationData_List.json" + } + } + } + }, + "/application-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "ApplicationData" + ], + "description": "Create cascade delete job for application data resource.", + "operationId": "ApplicationData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "applicationDataId", + "description": "Id of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ApplicationData_CreateCascadeDeleteJob": { + "$ref": "./examples/ApplicationData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get cascade delete job for application data resource.", + "operationId": "ApplicationData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ApplicationData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/application-data": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Returns a paginated list of application data resources under a particular party.", + "operationId": "ApplicationData_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum average amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum total amount of material applied during the application (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationData_ListByPartyId": { + "$ref": "./examples/ApplicationData_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/application-data/{applicationDataId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a specified application data resource under a particular party.", + "operationId": "ApplicationData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Get": { + "$ref": "./examples/ApplicationData_Get.json" + } + } + }, + "patch": { + "tags": [ + "ApplicationData" + ], + "description": "Creates or updates an application data resource under a particular party.", + "operationId": "ApplicationData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "applicationData", + "description": "Application data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + }, + "x-ms-examples": { + "ApplicationData_CreateOrUpdate": { + "$ref": "./examples/ApplicationData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ApplicationData" + ], + "description": "Deletes a specified application data resource under a particular party.", + "operationId": "ApplicationData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Delete": { + "$ref": "./examples/ApplicationData_Delete.json" + } + } + } + }, + "/parties/{partyId}/attachments": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Returns a paginated list of attachment resources under a particular party.", + "operationId": "Attachments_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceIds", + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "resourceTypes", + "description": "Resource Types of the resource.\r\ni.e. Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AttachmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Attachments_ListByPartyId": { + "$ref": "./examples/Attachments_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/attachments/{attachmentId}": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Gets a specified attachment resource under a particular party.", + "operationId": "Attachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Get": { + "$ref": "./examples/Attachments_Get.json" + } + } + }, + "patch": { + "tags": [ + "Attachments" + ], + "description": "Creates or updates an attachment resource under a particular party.", + "operationId": "Attachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "type": "file", + "format": "binary", + "description": "File to be uploaded." + }, + { + "in": "formData", + "name": "resourceId", + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "resourceType", + "description": "Associated Resource type for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "originalFileName", + "description": "Original File Name for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "id", + "description": "Unique id.", + "type": "string" + }, + { + "in": "formData", + "name": "status", + "description": "Status of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdDateTime", + "description": "Date when resource was created.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "modifiedDateTime", + "description": "Date when resource was last modified.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "source", + "description": "Source of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 2 + }, + { + "in": "formData", + "name": "name", + "description": "Name to identify resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "description", + "description": "Textual description of resource.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdBy", + "description": "Created by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "modifiedBy", + "description": "Modified by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "eTag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_CreateOrUpdate": { + "$ref": "./examples/Attachments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Attachments" + ], + "description": "Deletes a specified attachment resource under a particular party.", + "operationId": "Attachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Delete": { + "$ref": "./examples/Attachments_Delete.json" + } + } + } + }, + "/parties/{partyId}/attachments/{attachmentId}/file": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Downloads and returns attachment as response for the given input filePath.", + "operationId": "Attachments_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of attachment to be downloaded.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Download": { + "$ref": "./examples/Attachments_Download.json" + } + } + } + }, + "/boundaries": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Returns a paginated list of boundary resources across all parties.", + "operationId": "Boundaries_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.", + "type": "string" + }, + { + "in": "query", + "name": "type", + "description": "Type it belongs to.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryMetadataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_List": { + "$ref": "./examples/Boundaries_List.json" + } + } + }, + "post": { + "tags": [ + "Boundaries" + ], + "description": "Search for boundaries across all parties by fields and intersecting geometry.", + "operationId": "Boundaries_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchBoundaryQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchBoundaryQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryMetadataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_Search": { + "$ref": "./examples/Boundaries_Search.json" + } + } + } + }, + "/boundaries/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Boundaries" + ], + "description": "Create a cascade delete job for specified boundary.", + "operationId": "Boundaries_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "ID of the boundary to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Boundaries_CreateCascadeDeleteJob": { + "$ref": "./examples/Boundaries_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get cascade delete job for specified boundary.", + "operationId": "Boundaries_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Boundaries_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Boundaries_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/boundaries": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Returns a paginated list of boundary resources under a particular party.", + "operationId": "Boundaries_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.", + "type": "string" + }, + { + "in": "query", + "name": "type", + "description": "Type it belongs to.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryMetadataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_ListByPartyId": { + "$ref": "./examples/Boundaries_ListByPartyId.json" + } + } + }, + "post": { + "tags": [ + "Boundaries" + ], + "description": "Search for boundaries by fields and intersecting geometry.", + "operationId": "Boundaries_SearchByPartyId", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchBoundaryQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchBoundaryQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryMetadataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_SearchByPartyId": { + "$ref": "./examples/Boundaries_SearchByPartyId.json" + } + } + } + }, + "/parties/{partyId}/boundaries/{boundaryId}": { + "patch": { + "tags": [ + "Boundaries" + ], + "description": "Creates or updates a boundary resource.", + "operationId": "Boundaries_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "boundary", + "description": "Boundary resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Boundary" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Boundaries_CreateOrUpdate": { + "$ref": "./examples/Boundaries_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Boundaries" + ], + "description": "Gets a specified boundary resource under a particular party.", + "operationId": "Boundaries_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Boundaries_Get": { + "$ref": "./examples/Boundaries_Get.json" + } + } + }, + "delete": { + "tags": [ + "Boundaries" + ], + "description": "Deletes a specified boundary resource under a particular party.", + "operationId": "Boundaries_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Boundaries_Delete": { + "$ref": "./examples/Boundaries_Delete.json" + } + } + } + }, + "/parties/{partyId}/boundaries/{boundaryId}/overlap": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Returns overlapping area between two boundary Ids.", + "operationId": "Boundaries_GetOverlap", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "otherPartyId", + "description": "PartyId of the other field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "otherBoundaryId", + "description": "Id of the other boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryOverlapResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Boundaries_GetOverlap": { + "$ref": "./examples/Boundaries_GetOverlap.json" + } + } + } + }, + "/crop-products": { + "get": { + "tags": [ + "CropProducts" + ], + "description": "Returns a paginated list of crop product resources.", + "operationId": "CropProducts_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Products of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "traits", + "description": "Traits of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProductListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropProducts_List": { + "$ref": "./examples/CropProducts_List.json" + } + } + } + }, + "/crop-products/{cropProductId}": { + "get": { + "tags": [ + "CropProducts" + ], + "description": "Gets a specified crop Product resource.", + "operationId": "CropProducts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_Get": { + "$ref": "./examples/CropProducts_Get.json" + } + } + }, + "patch": { + "tags": [ + "CropProducts" + ], + "description": "Creates or updates a crop Product resource.", + "operationId": "CropProducts_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "cropProduct", + "description": "Crop Product resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CropProduct" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_CreateOrUpdate": { + "$ref": "./examples/CropProducts_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "CropProducts" + ], + "description": "Deletes a specified crop Product resource.", + "operationId": "CropProducts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_Delete": { + "$ref": "./examples/CropProducts_Delete.json" + } + } + } + }, + "/crops": { + "get": { + "tags": [ + "Crops" + ], + "description": "Returns a paginated list of crop resources.", + "operationId": "Crops_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "phenotypes", + "description": "Crop phenotypes of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "breedingMethods", + "description": "Breeding method of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Crops_List": { + "$ref": "./examples/Crops_List.json" + } + } + } + }, + "/crops/{cropId}": { + "get": { + "tags": [ + "Crops" + ], + "description": "Gets a specified crop resource.", + "operationId": "Crops_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_Get": { + "$ref": "./examples/Crops_Get.json" + } + } + }, + "patch": { + "tags": [ + "Crops" + ], + "description": "Creates or updates a crop resource.", + "operationId": "Crops_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "crop", + "description": "Crop resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Crop" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_CreateOrUpdate": { + "$ref": "./examples/Crops_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Crops" + ], + "description": "Deletes Crop for given crop id.", + "operationId": "Crops_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of crop to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_Delete": { + "$ref": "./examples/Crops_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/device-data-models": { + "get": { + "tags": [ + "DeviceDataModels" + ], + "description": "Returns a paginated list of device data model resources.", + "operationId": "DeviceDataModels_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DeviceDataModels_List": { + "$ref": "./examples/DeviceDataModels_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}": { + "patch": { + "tags": [ + "DeviceDataModels" + ], + "description": "Create a device data model entity.", + "operationId": "DeviceDataModels_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "deviceDataModelObject", + "description": "Device data model object details.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_CreateOrUpdate": { + "$ref": "./examples/DeviceDataModels_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "DeviceDataModels" + ], + "description": "Gets a device data model entity.", + "operationId": "DeviceDataModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_Get": { + "$ref": "./examples/DeviceDataModels_Get.json" + } + } + }, + "delete": { + "tags": [ + "DeviceDataModels" + ], + "description": "Deletes a device data model entity.", + "operationId": "DeviceDataModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_Delete": { + "$ref": "./examples/DeviceDataModels_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/devices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Returns a paginated list of device resources.", + "operationId": "Devices_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentDeviceIds", + "description": "Id's of the parent devices.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "deviceDataModelIds", + "description": "Id's of the device data models.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Devices_List": { + "$ref": "./examples/Devices_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/devices/{deviceId}": { + "patch": { + "tags": [ + "Devices" + ], + "description": "Create a device entity.", + "operationId": "Devices_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "deviceDetails", + "description": "Device object details.", + "required": true, + "schema": { + "$ref": "#/definitions/Device" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_CreateOrUpdate": { + "$ref": "./examples/Devices_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Devices" + ], + "description": "Gets a device entity.", + "operationId": "Devices_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_Get": { + "$ref": "./examples/Devices_Get.json" + } + } + }, + "delete": { + "tags": [ + "Devices" + ], + "description": "Deletes a device entity.", + "operationId": "Devices_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_Delete": { + "$ref": "./examples/Devices_Delete.json" + } + } + } + }, + "/farm-operations/ingest-data/{jobId}": { + "put": { + "tags": [ + "FarmOperations" + ], + "description": "Create a farm operation data ingestion job.", + "operationId": "FarmOperations_CreateDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "FarmOperations_CreateDataIngestionJob": { + "$ref": "./examples/FarmOperations_CreateDataIngestionJob.json" + } + } + }, + "get": { + "tags": [ + "FarmOperations" + ], + "description": "Get a farm operation data ingestion job.", + "operationId": "FarmOperations_GetDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "FarmOperations_GetDataIngestionJobDetails": { + "$ref": "./examples/FarmOperations_GetDataIngestionJobDetails.json" + } + } + } + }, + "/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources across all parties.", + "operationId": "Farms_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_List": { + "$ref": "./examples/Farms_List.json" + } + } + } + }, + "/farms/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Farms" + ], + "description": "Create a cascade delete job for specified farm.", + "operationId": "Farms_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmId", + "description": "ID of the farm to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Farms_CreateCascadeDeleteJob": { + "$ref": "./examples/Farms_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Farms" + ], + "description": "Get a cascade delete job for specified farm.", + "operationId": "Farms_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farms_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources under a particular party.", + "operationId": "Farms_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_ListByPartyId": { + "$ref": "./examples/Farms_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/farms/{farmId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Gets a specified farm resource under a particular party.", + "operationId": "Farms_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "ID of the farm resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_Get": { + "$ref": "./examples/Farms_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farms" + ], + "description": "Creates or updates a farm resource under a particular party.", + "operationId": "Farms_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Id of the farm resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "farm", + "description": "Farm resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Farm" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_CreateOrUpdate": { + "$ref": "./examples/Farms_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farms" + ], + "description": "Deletes a specified farm resource under a particular party.", + "operationId": "Farms_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Id of the farm.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_Delete": { + "$ref": "./examples/Farms_Delete.json" + } + } + } + }, + "/fields": { + "get": { + "tags": [ + "Fields" + ], + "description": "Returns a paginated list of field resources across all parties.", + "operationId": "Fields_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmIds", + "description": "Farm Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fields_List": { + "$ref": "./examples/Fields_List.json" + } + } + } + }, + "/fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a cascade delete job for specified field.", + "operationId": "Fields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Fields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Fields" + ], + "description": "Create a cascade delete job for specified field.", + "operationId": "Fields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "fieldId", + "description": "ID of the field to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Fields_CreateCascadeDeleteJob": { + "$ref": "./examples/Fields_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/fields": { + "get": { + "tags": [ + "Fields" + ], + "description": "Returns a paginated list of field resources under a particular party.", + "operationId": "Fields_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmIds", + "description": "Farm Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fields_ListByPartyId": { + "$ref": "./examples/Fields_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/fields/{fieldId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Gets a specified field resource under a particular party.", + "operationId": "Fields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Get": { + "$ref": "./examples/Fields_Get.json" + } + } + }, + "patch": { + "tags": [ + "Fields" + ], + "description": "Creates or Updates a field resource under a particular party.", + "operationId": "Fields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "field", + "description": "Field resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Field" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_CreateOrUpdate": { + "$ref": "./examples/Fields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Fields" + ], + "description": "Deletes a specified field resource under a particular party.", + "operationId": "Fields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Delete": { + "$ref": "./examples/Fields_Delete.json" + } + } + } + }, + "/harvest-data": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Returns a paginated list of harvest data resources across all parties.", + "operationId": "HarvestData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minTotalYield", + "description": "Minimum Yield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalYield", + "description": "Maximum Yield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgYield", + "description": "Minimum AvgYield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYield", + "description": "Maximum AvgYield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalWetMass", + "description": "Minimum Total WetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalWetMass", + "description": "Maximum Total WetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgWetMass", + "description": "Minimum AvgWetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgWetMass", + "description": "Maximum AvgWetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMoisture", + "description": "Minimum AvgMoisture value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMoisture", + "description": "Maximum AvgMoisture value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgSpeed", + "description": "Minimum AvgSpeed value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSpeed", + "description": "Maximum AvgSpeed value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HarvestData_List": { + "$ref": "./examples/HarvestData_List.json" + } + } + } + }, + "/harvest-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "HarvestData" + ], + "description": "Create cascade delete job for harvest data resource.", + "operationId": "HarvestData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "harvestDataId", + "description": "Id of the harvest data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "HarvestData_CreateCascadeDeleteJob": { + "$ref": "./examples/HarvestData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get cascade delete job for harvest data resource.", + "operationId": "HarvestData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/HarvestData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/harvest-data": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Returns a paginated list of harvest data resources under a particular farm.", + "operationId": "HarvestData_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minTotalYield", + "description": "Minimum Yield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalYield", + "description": "Maximum Yield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgYield", + "description": "Minimum AvgYield value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYield", + "description": "Maximum AvgYield value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalWetMass", + "description": "Minimum Total WetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalWetMass", + "description": "Maximum Total WetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgWetMass", + "description": "Minimum AvgWetMass value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgWetMass", + "description": "Maximum AvgWetMass value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMoisture", + "description": "Minimum AvgMoisture value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMoisture", + "description": "Maximum AvgMoisture value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgSpeed", + "description": "Minimum AvgSpeed value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSpeed", + "description": "Maximum AvgSpeed value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HarvestData_ListByPartyId": { + "$ref": "./examples/HarvestData_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/harvest-data/{harvestDataId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a specified harvest data resource under a particular party.", + "operationId": "HarvestData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Get": { + "$ref": "./examples/HarvestData_Get.json" + } + } + }, + "patch": { + "tags": [ + "HarvestData" + ], + "description": "Creates or updates harvest data resource under a particular party.", + "operationId": "HarvestData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "harvestData", + "description": "Harvest data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + }, + "x-ms-examples": { + "HarvestData_CreateOrUpdate": { + "$ref": "./examples/HarvestData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "HarvestData" + ], + "description": "Deletes a specified harvest data resource under a particular party.", + "operationId": "HarvestData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Delete": { + "$ref": "./examples/HarvestData_Delete.json" + } + } + } + }, + "/image-processing/rasterize/{jobId}": { + "put": { + "tags": [ + "ImageProcessing" + ], + "description": "Create a ImageProcessing Rasterize job.", + "operationId": "ImageProcessing_CreateRasterizeJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ImageProcessing_CreateRasterizeJob": { + "$ref": "./examples/ImageProcessing_CreateRasterizeJob.json" + } + } + }, + "get": { + "tags": [ + "ImageProcessing" + ], + "description": "Get ImageProcessing Rasterize job's details.", + "operationId": "ImageProcessing_GetRasterizeJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ImageProcessing_GetRasterizeJob": { + "$ref": "./examples/ImageProcessing_GetRasterizeJob.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments": { + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Returns a paginated list of insight resources.", + "operationId": "InsightAttachments_ListByPartyIdModelIdAndResource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "insightIds", + "description": "List of insight IDs.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "InsightAttachments_ListByPartyIdModelIdAndResource": { + "$ref": "./examples/InsightAttachments_ListByPartyIdModelIdAndResource.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}": { + "patch": { + "tags": [ + "InsightAttachments" + ], + "description": "Creates or updates insight entity.", + "operationId": "InsightAttachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "type": "file", + "format": "binary", + "description": "File to be uploaded." + }, + { + "in": "formData", + "name": "insightId", + "description": "InsightID for this InsightAttachment.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "originalFileName", + "description": "Original File Name for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "id", + "description": "Unique id.", + "type": "string" + }, + { + "in": "formData", + "name": "status", + "description": "Status of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdDateTime", + "description": "Date when resource was created.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "modifiedDateTime", + "description": "Date when resource was last modified.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "source", + "description": "Source of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 2 + }, + { + "in": "formData", + "name": "name", + "description": "Name to identify resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "description", + "description": "Textual description of resource.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdBy", + "description": "Created by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "modifiedBy", + "description": "Modified by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "eTag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_CreateOrUpdate": { + "$ref": "./examples/InsightAttachments_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Gets a specified insight resource under a particular party.", + "operationId": "InsightAttachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Get": { + "$ref": "./examples/InsightAttachments_Get.json" + } + } + }, + "delete": { + "tags": [ + "InsightAttachments" + ], + "description": "Deletes a specified insight resource.", + "operationId": "InsightAttachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Delete": { + "$ref": "./examples/InsightAttachments_Delete.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}/file": { + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Downloads and returns insight-attachment as response for the given input filePath.", + "operationId": "InsightAttachments_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Download": { + "$ref": "./examples/InsightAttachments_Download.json" + } + } + } + }, + "/insights/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Insights" + ], + "description": "Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.", + "operationId": "Insights_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceType", + "description": "Resource Type.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "insightId", + "description": "Insight id.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Insights_CreateCascadeDeleteJob": { + "$ref": "./examples/Insights_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Insights" + ], + "description": "Get a cascade delete job for specified insight.", + "operationId": "Insights_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Insights_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights": { + "get": { + "tags": [ + "Insights" + ], + "description": "Returns a paginated list of insight resources.", + "operationId": "Insights_ListByPartyIdModelIdAndResource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minInsightStartDateTime", + "description": "Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxInsightStartDateTime", + "description": "Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minInsightEndDateTime", + "description": "Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxInsightEndDateTime", + "description": "Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "measurementFilters", + "description": "Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object.\r\neg. \"measureKey.unit eq {testValue}\" where testValue is string.\r\neg. \"measureKey.value eq {testValue}\" where testValue = double.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Insights_ListByPartyIdModelIdAndResource": { + "$ref": "./examples/Insights_ListByPartyIdModelIdAndResource.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}": { + "patch": { + "tags": [ + "Insights" + ], + "description": "Creates or updates insight entity.", + "operationId": "Insights_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "insightData", + "description": "Insight data.", + "required": true, + "schema": { + "$ref": "#/definitions/Insight" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_CreateOrUpdate": { + "$ref": "./examples/Insights_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Insights" + ], + "description": "Gets a specified insight resource under a particular party.", + "operationId": "Insights_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_Get": { + "$ref": "./examples/Insights_Get.json" + } + } + }, + "delete": { + "tags": [ + "Insights" + ], + "description": "Deletes a specified insight resource.", + "operationId": "Insights_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_Delete": { + "$ref": "./examples/Insights_Delete.json" + } + } + } + }, + "/management-zones": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Returns a paginated list of management zone resources across all parties.", + "operationId": "ManagementZones_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "SeasonIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "FieldIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagementZones_List": { + "$ref": "./examples/ManagementZones_List.json" + } + } + } + }, + "/management-zones/cascade-delete/{jobId}": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Get a cascade delete job for specified job id.", + "operationId": "ManagementZones_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ManagementZones_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "ManagementZones" + ], + "description": "Create a cascade delete job for specified management zone.", + "operationId": "ManagementZones_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "managementZoneId", + "description": "ID of the management zone to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ManagementZones_CreateCascadeDeleteJob": { + "$ref": "./examples/ManagementZones_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/management-zones": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Returns a paginated list of management zone resources under a particular party.", + "operationId": "ManagementZones_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "SeasonIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "FieldIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagementZones_ListByPartyId": { + "$ref": "./examples/ManagementZones_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/management-zones/{managementZoneId}": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Gets a specified management zone resource under a particular party.", + "operationId": "ManagementZones_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_Get": { + "$ref": "./examples/ManagementZones_Get.json" + } + } + }, + "patch": { + "tags": [ + "ManagementZones" + ], + "description": "Creates or updates a management zone resource.", + "operationId": "ManagementZones_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "managementZone", + "description": "ManagementZone resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementZone" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_CreateOrUpdate": { + "$ref": "./examples/ManagementZones_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ManagementZones" + ], + "description": "Deletes a specified management zone resource under a particular party.", + "operationId": "ManagementZones_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_Delete": { + "$ref": "./examples/ManagementZones_Delete.json" + } + } + } + }, + "/model-inference/models/microsoft-biomass/infer-data/{jobId}": { + "put": { + "tags": [ + "ModelInference" + ], + "description": "Create a Biomass Model job.", + "operationId": "ModelInference_CreateBiomassModelJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/BiomassModelJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/BiomassModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ModelInference_CreateBiomassModelJob": { + "$ref": "./examples/ModelInference_CreateBiomassModelJob.json" + } + } + }, + "get": { + "tags": [ + "ModelInference" + ], + "description": "Get Biomass Model job's details.", + "operationId": "ModelInference_GetBiomassModelJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BiomassModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ModelInference_GetBiomassModelJob": { + "$ref": "./examples/ModelInference_GetBiomassModelJob.json" + } + } + } + }, + "/model-inference/models/microsoft-sensor-placement/infer-data/{jobId}": { + "put": { + "tags": [ + "ModelInference" + ], + "description": "Create a Sensor Placement Model job.", + "operationId": "ModelInference_CreateSensorPlacementModelJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorPlacementModelJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SensorPlacementModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ModelInference_CreateSensorPlacementModelJob": { + "$ref": "./examples/ModelInference_CreateSensorPlacementModelJob.json" + } + } + }, + "get": { + "tags": [ + "ModelInference" + ], + "description": "Get Sensor Placement Model job's details.", + "operationId": "ModelInference_GetSensorPlacementModelJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPlacementModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ModelInference_GetSensorPlacementModelJob": { + "$ref": "./examples/ModelInference_GetSensorPlacementModelJob.json" + } + } + } + }, + "/model-inference/models/microsoft-soil-moisture/infer-data/{jobId}": { + "put": { + "tags": [ + "ModelInference" + ], + "description": "Create a SoilMoisture Model job.", + "operationId": "ModelInference_CreateSoilMoistureModelJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SoilMoistureModelJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SoilMoistureModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ModelInference_CreateSoilMoistureModelJob": { + "$ref": "./examples/ModelInference_CreateSoilMoistureModelJob.json" + } + } + }, + "get": { + "tags": [ + "ModelInference" + ], + "description": "Get SoilMoisture Model job's details.", + "operationId": "ModelInference_GetSoilMoistureModelJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SoilMoistureModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ModelInference_GetSoilMoistureModelJob": { + "$ref": "./examples/ModelInference_GetSoilMoistureModelJob.json" + } + } + } + }, + "/nutrient-analyses": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Returns a paginated list of nutrient analysis resources across all parties.", + "operationId": "NutrientAnalyses_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "classifications", + "description": "Classifications for nutrient analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NutrientAnalyses_List": { + "$ref": "./examples/NutrientAnalyses_List.json" + } + } + } + }, + "/parties/{partyId}/nutrient-analyses": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Returns a paginated list of nutrient analysis resources under a particular party.", + "operationId": "NutrientAnalyses_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "classifications", + "description": "Classifications for nutrient analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NutrientAnalyses_ListByPartyId": { + "$ref": "./examples/NutrientAnalyses_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Gets a specified nutrient analysis resource under a particular party.", + "operationId": "NutrientAnalyses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_Get": { + "$ref": "./examples/NutrientAnalyses_Get.json" + } + } + }, + "patch": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Creates or updates a nutrient analysis resource.", + "operationId": "NutrientAnalyses_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "nutrientAnalysis", + "description": "NutrientAnalysis resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_CreateOrUpdate": { + "$ref": "./examples/NutrientAnalyses_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Deletes a specified nutrient analysis resource under a particular party.", + "operationId": "NutrientAnalyses_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_Delete": { + "$ref": "./examples/NutrientAnalyses_Delete.json" + } + } + } + }, + "/oauth/providers": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Returns a paginated list of oauthProvider resources.", + "operationId": "OAuthProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthProviders_List": { + "$ref": "./examples/OAuthProviders_List.json" + } + } + } + }, + "/oauth/providers/{oauthProviderId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get a specified oauthProvider resource.", + "operationId": "OAuthProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of the oauthProvider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_Get": { + "$ref": "./examples/OAuthProviders_Get.json" + } + } + }, + "patch": { + "tags": [ + "OAuthProviders" + ], + "description": "Creates or updates an oauthProvider resource.", + "operationId": "OAuthProviders_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of oauthProvider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "oauthProvider", + "description": "OauthProvider resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_CreateOrUpdate": { + "$ref": "./examples/OAuthProviders_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OAuthProviders" + ], + "description": "Deletes an specified oauthProvider resource.", + "operationId": "OAuthProviders_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of oauthProvider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_Delete": { + "$ref": "./examples/OAuthProviders_Delete.json" + } + } + } + }, + "/oauth/providers/cascade-delete/{jobId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get cascade delete job for oauthProvider resource.", + "operationId": "OAuthProviders_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthProviders_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthProviders" + ], + "description": "Create cascade delete job for oauthProvider resource.", + "operationId": "OAuthProviders_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthProviders_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthProviders_CreateCascadeDeleteJob.json" + } + } + } + }, + "/oauth/tokens": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns a list of OAuthToken documents.", + "operationId": "OAuthTokens_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "authProviderIds", + "description": "Name of AuthProvider.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "partyIds", + "description": "List of parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "isValid", + "description": "If the token object is valid.", + "type": "boolean" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthTokenListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthTokens_List": { + "$ref": "./examples/OAuthTokens_List.json" + } + } + } + }, + "/oauth/tokens/:connect": { + "post": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns Connection link needed in the OAuth flow.", + "operationId": "OAuthTokens_GetOAuthConnectionLink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "oauthConnectRequest", + "description": "OAuth Connect Request.", + "required": true, + "schema": { + "$ref": "#/definitions/OAuthConnectRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthTokens_GetOAuthConnectionLink": { + "$ref": "./examples/OAuthTokens_GetOAuthConnectionLink.json" + } + } + } + }, + "/oauth/tokens/remove/{jobId}": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Get remove job for OAuth token.", + "operationId": "OAuthTokens_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthTokens_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthTokens_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthTokens" + ], + "description": "Create remove job for OAuth token.", + "operationId": "OAuthTokens_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the OAuthProvider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthTokens_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthTokens_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties": { + "get": { + "tags": [ + "Parties" + ], + "description": "Returns a paginated list of party resources.", + "operationId": "Parties_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Parties_List": { + "$ref": "./examples/Parties_List.json" + } + } + } + }, + "/parties/{partyId}": { + "get": { + "tags": [ + "Parties" + ], + "description": "Gets a specified party resource.", + "operationId": "Parties_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_Get": { + "$ref": "./examples/Parties_Get.json" + } + } + }, + "patch": { + "tags": [ + "Parties" + ], + "description": "Creates or updates a party resource.", + "operationId": "Parties_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "party", + "description": "Party resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Party" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_CreateOrUpdate": { + "$ref": "./examples/Parties_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Parties" + ], + "description": "Deletes a specified party resource.", + "operationId": "Parties_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of party to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_Delete": { + "$ref": "./examples/Parties_Delete.json" + } + } + } + }, + "/parties/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Parties" + ], + "description": "Get a cascade delete job for specified party.", + "operationId": "Parties_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Parties_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Parties" + ], + "description": "Create a cascade delete job for specified party.", + "operationId": "Parties_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the party to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Parties_CreateCascadeDeleteJob": { + "$ref": "./examples/Parties_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/planting-data": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Returns a paginated list of planting data resources under a particular party.", + "operationId": "PlantingData_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minAvgPlantingRate", + "description": "Minimum AvgPlantingRate value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgPlantingRate", + "description": "Maximum AvgPlantingRate value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum TotalMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum TotalMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum AvgMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum AvgMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantingData_ListByPartyId": { + "$ref": "./examples/PlantingData_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/planting-data/{plantingDataId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a specified planting data resource under a particular party.", + "operationId": "PlantingData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Get": { + "$ref": "./examples/PlantingData_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantingData" + ], + "description": "Creates or updates an planting data resource under a particular party.", + "operationId": "PlantingData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "plantingData", + "description": "Planting data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + }, + "x-ms-examples": { + "PlantingData_CreateOrUpdate": { + "$ref": "./examples/PlantingData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantingData" + ], + "description": "Deletes a specified planting data resource under a particular party.", + "operationId": "PlantingData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Delete": { + "$ref": "./examples/PlantingData_Delete.json" + } + } + } + }, + "/planting-data": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Returns a paginated list of planting data resources across all parties.", + "operationId": "PlantingData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minAvgPlantingRate", + "description": "Minimum AvgPlantingRate value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgPlantingRate", + "description": "Maximum AvgPlantingRate value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Minimum TotalMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Maximum TotalMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Minimum AvgMaterial value(inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Maximum AvgMaterial value (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantingData_List": { + "$ref": "./examples/PlantingData_List.json" + } + } + } + }, + "/planting-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "PlantingData" + ], + "description": "Create cascade delete job for planting data resource.", + "operationId": "PlantingData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "plantingDataId", + "description": "Id of the planting data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantingData_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantingData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get cascade delete job for planting data resource.", + "operationId": "PlantingData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantingData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/plant-tissue-analyses": { + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Returns a paginated list of plant tissue analysis resources under a particular party.", + "operationId": "PlantTissueAnalyses_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropProductsIds", + "description": "Crop products ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantTissueAnalyses_ListByPartyId": { + "$ref": "./examples/PlantTissueAnalyses_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}": { + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Gets a specified plant tissue analysis resource under a particular party.", + "operationId": "PlantTissueAnalyses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Get": { + "$ref": "./examples/PlantTissueAnalyses_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Creates or updates a plant tissue analysis resource.", + "operationId": "PlantTissueAnalyses_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "plantTissueAnalysis", + "description": "PlantTissueAnalysis resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_CreateOrUpdate": { + "$ref": "./examples/PlantTissueAnalyses_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Deletes a specified plant tissue analysis resource under a particular party.", + "operationId": "PlantTissueAnalyses_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Delete": { + "$ref": "./examples/PlantTissueAnalyses_Delete.json" + } + } + } + }, + "/plant-tissue-analyses": { + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Returns a paginated list of plant tissue analysis resources across all parties.", + "operationId": "PlantTissueAnalyses_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "seasonIds", + "description": "Season ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropProductsIds", + "description": "Crop products ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field ids of the plant tissue analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantTissueAnalyses_List": { + "$ref": "./examples/PlantTissueAnalyses_List.json" + } + } + } + }, + "/plant-tissue-analyses/cascade-delete/{jobId}": { + "put": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Create a cascade delete job for specified plant tissue analysis.", + "operationId": "PlantTissueAnalyses_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "plantTissueAnalysisId", + "description": "ID of the plant tissue analysis to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantTissueAnalyses_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Get a cascade delete job for specified plant tissue analysis.", + "operationId": "PlantTissueAnalyses_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/prescription-maps": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Returns a paginated list of prescription map resources under a particular party.", + "operationId": "PrescriptionMaps_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMapListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrescriptionMaps_ListByPartyId": { + "$ref": "./examples/PrescriptionMaps_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/prescription-maps/{prescriptionMapId}": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Gets a specified prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescription map.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_Get": { + "$ref": "./examples/PrescriptionMaps_Get.json" + } + } + }, + "patch": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Creates or Updates a prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescription map resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "prescriptionMap", + "description": "PrescriptionMap resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_CreateOrUpdate": { + "$ref": "./examples/PrescriptionMaps_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Deletes a specified prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescriptionMap.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_Delete": { + "$ref": "./examples/PrescriptionMaps_Delete.json" + } + } + } + }, + "/prescription-maps": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Returns a paginated list of prescription map resources across all parties.", + "operationId": "PrescriptionMaps_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMapListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrescriptionMaps_List": { + "$ref": "./examples/PrescriptionMaps_List.json" + } + } + } + }, + "/prescription-maps/cascade-delete/{jobId}": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Get a cascade delete job for specified prescription map.", + "operationId": "PrescriptionMaps_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Create a cascade delete job for specified prescription map.", + "operationId": "PrescriptionMaps_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionMapId", + "description": "ID of the prescription map to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrescriptionMaps_CreateCascadeDeleteJob": { + "$ref": "./examples/PrescriptionMaps_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/prescriptions": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Returns a paginated list of prescription resources under a particular party.", + "operationId": "Prescriptions_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionMapIds", + "description": "Prescription Map Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "productCodes", + "description": "Product Codes of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "productNames", + "description": "Product Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Prescriptions_ListByPartyId": { + "$ref": "./examples/Prescriptions_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/prescriptions/{prescriptionId}": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Gets a specified prescription resource under a particular party.", + "operationId": "Prescriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Get": { + "$ref": "./examples/Prescriptions_Get.json" + } + } + }, + "patch": { + "tags": [ + "Prescriptions" + ], + "description": "Creates or Updates a prescription resource under a particular party.", + "operationId": "Prescriptions_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "prescription", + "description": "Prescription resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Prescription" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_CreateOrUpdate": { + "$ref": "./examples/Prescriptions_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Prescriptions" + ], + "description": "Deletes a specified prescription resource under a particular party.", + "operationId": "Prescriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Delete": { + "$ref": "./examples/Prescriptions_Delete.json" + } + } + } + }, + "/prescriptions": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Returns a paginated list of prescription resources across all parties.", + "operationId": "Prescriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "prescriptionMapIds", + "description": "Prescription Map Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "productCodes", + "description": "Product Codes of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "productNames", + "description": "Product Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Prescriptions_List": { + "$ref": "./examples/Prescriptions_List.json" + } + } + } + }, + "/prescriptions/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Get a cascade delete job for specified prescription.", + "operationId": "Prescriptions_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Prescriptions_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Prescriptions" + ], + "description": "Create a cascade delete job for specified prescription.", + "operationId": "Prescriptions_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionId", + "description": "ID of the prescription to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prescriptions_CreateCascadeDeleteJob": { + "$ref": "./examples/Prescriptions_CreateCascadeDeleteJob.json" + } + } + } + }, + "/scenes": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Returns a paginated list of scene resources.", + "operationId": "Scenes_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "provider", + "description": "Provider name of scene data. Supported value: SentinelHub.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "PartyId.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "BoundaryId.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "source", + "description": "Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCloudCoveragePercentage", + "description": "Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "maxDarkPixelCoveragePercentage", + "description": "Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "imageNames", + "description": "List of image names to be filtered.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageResolutions", + "description": "List of image resolutions in meters to be filtered.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageFormats", + "description": "List of image formats to be filtered.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SceneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Scenes_List": { + "$ref": "./examples/Scenes_List.json" + } + } + } + }, + "/scenes/downloadFiles": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Downloads and returns file Stream as response for the given input filePath.", + "operationId": "Scenes_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "query", + "name": "filePath", + "description": "cloud storage path of scene file.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_Download": { + "$ref": "./examples/Scenes_Download.json" + } + } + } + }, + "/scenes/satellite/ingest-data/{jobId}": { + "put": { + "tags": [ + "Scenes" + ], + "description": "Create a satellite data ingestion job.", + "operationId": "Scenes_CreateSatelliteDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Scenes_CreateSatelliteDataIngestionJob": { + "$ref": "./examples/Scenes_CreateSatelliteDataIngestionJob.json" + } + } + }, + "get": { + "tags": [ + "Scenes" + ], + "description": "Get a satellite data ingestion job.", + "operationId": "Scenes_GetSatelliteDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_GetSatelliteDataIngestionJobDetails": { + "$ref": "./examples/Scenes_GetSatelliteDataIngestionJobDetails.json" + } + } + } + }, + "/scenes/stac-collections/{collectionId}:search": { + "post": { + "tags": [ + "Scenes" + ], + "description": "Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.", + "operationId": "Scenes_SearchFeatures", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "collectionId", + "description": "Collection Id to be searched.", + "required": true, + "type": "string", + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "x-ms-enum": { + "name": "collectionId", + "modelAsString": true + } + }, + { + "in": "query", + "name": "maxpagesize", + "description": "Maximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10.", + "type": "integer", + "format": "int32", + "default": 10, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "skip", + "description": "Skip token for getting next set of results.", + "type": "integer", + "format": "int32", + "maximum": 2147483647, + "minimum": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFeaturesQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchFeaturesQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SearchFeaturesResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_SearchFeatures": { + "$ref": "./examples/Scenes_SearchFeatures.json" + } + } + } + }, + "/parties/{partyId}/seasonal-fields": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Returns a paginated list of seasonal field resources under a particular party.", + "operationId": "SeasonalFields_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmIds", + "description": "Farm Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropProductIds", + "description": "CropProductIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Ids of the crop it belongs to.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalFieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SeasonalFields_ListByPartyId": { + "$ref": "./examples/SeasonalFields_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/seasonal-fields/{seasonalFieldId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Gets a specified seasonal field resource under a particular party.", + "operationId": "SeasonalFields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Get": { + "$ref": "./examples/SeasonalFields_Get.json" + } + } + }, + "patch": { + "tags": [ + "SeasonalFields" + ], + "description": "Creates or Updates a seasonal field resource under a particular party.", + "operationId": "SeasonalFields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "seasonalField", + "description": "Seasonal field resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/SeasonalField" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_CreateOrUpdate": { + "$ref": "./examples/SeasonalFields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SeasonalFields" + ], + "description": "Deletes a specified seasonal-field resource under a particular party.", + "operationId": "SeasonalFields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Delete": { + "$ref": "./examples/SeasonalFields_Delete.json" + } + } + } + }, + "/seasonal-fields": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Returns a paginated list of seasonal field resources across all parties.", + "operationId": "SeasonalFields_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmIds", + "description": "Farm Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropProductIds", + "description": "CropProductIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Ids of the crop it belongs to.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalFieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SeasonalFields_List": { + "$ref": "./examples/SeasonalFields_List.json" + } + } + } + }, + "/seasonal-fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/SeasonalFields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "SeasonalFields" + ], + "description": "Create a cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "seasonalFieldId", + "description": "ID of the seasonalField to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SeasonalFields_CreateCascadeDeleteJob": { + "$ref": "./examples/SeasonalFields_CreateCascadeDeleteJob.json" + } + } + } + }, + "/seasons": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Returns a paginated list of season resources.", + "operationId": "Seasons_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minStartDateTime", + "description": "Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxStartDateTime", + "description": "Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minEndDateTime", + "description": "Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxEndDateTime", + "description": "Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "years", + "description": "Years of the resource.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Seasons_List": { + "$ref": "./examples/Seasons_List.json" + } + } + } + }, + "/seasons/{seasonId}": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Gets a specified season resource.", + "operationId": "Seasons_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_Get": { + "$ref": "./examples/Seasons_Get.json" + } + } + }, + "patch": { + "tags": [ + "Seasons" + ], + "description": "Creates or updates a season resource.", + "operationId": "Seasons_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "season", + "description": "Season resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Season" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_CreateOrUpdate": { + "$ref": "./examples/Seasons_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Seasons" + ], + "description": "Deletes a specified season resource.", + "operationId": "Seasons_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_Delete": { + "$ref": "./examples/Seasons_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensor-data-models": { + "get": { + "tags": [ + "SensorDataModels" + ], + "description": "Returns a paginated list of sensor data model resources.", + "operationId": "SensorDataModels_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorDataModels_List": { + "$ref": "./examples/SensorDataModels_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}": { + "patch": { + "tags": [ + "SensorDataModels" + ], + "description": "Create a sensor data model entity.", + "operationId": "SensorDataModels_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorDataModelObject", + "description": "Sensor data model object details.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_CreateOrUpdate": { + "$ref": "./examples/SensorDataModels_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorDataModels" + ], + "description": "Gets a sensor data model entity.", + "operationId": "SensorDataModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_Get": { + "$ref": "./examples/SensorDataModels_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorDataModels" + ], + "description": "Deletes a sensor data model entity.", + "operationId": "SensorDataModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_Delete": { + "$ref": "./examples/SensorDataModels_Delete.json" + } + } + } + }, + "/sensor-events": { + "get": { + "tags": [ + "SensorEvents" + ], + "description": "Returns a list of sensor events data. Time span for query is limited to 90 days at a time.\r\nReturns last 90 days events when startDateTime and endDateTime are not provided.", + "operationId": "SensorEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorId", + "description": "Id of the associated sensor.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "excludeDuplicateEvents", + "description": "Flag to exclude duplicate events and take the latest ones only (Default: false).", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorEventListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorEvents_List": { + "$ref": "./examples/SensorEvents_List.json" + } + } + } + }, + "/sensor-mappings": { + "get": { + "tags": [ + "SensorMappings" + ], + "description": "Returns a paginated list of sensor mapping resources.", + "operationId": "SensorMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorIds", + "description": "Id of the sensors.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sensorPartnerIds", + "description": "Id of the sensor partners.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "partyIds", + "description": "Id of the parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "boundaryIds", + "description": "Id of the boundaries.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMappingListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorMappings_List": { + "$ref": "./examples/SensorMappings_List.json" + } + } + } + }, + "/sensor-mappings/{sensorMappingId}": { + "patch": { + "tags": [ + "SensorMappings" + ], + "description": "Create a sensor mapping entity.", + "operationId": "SensorMappings_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorMappingObject", + "description": "Sensor mapping object details.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorMapping" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_CreateOrUpdate": { + "$ref": "./examples/SensorMappings_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorMappings" + ], + "description": "Gets a sensor mapping entity.", + "operationId": "SensorMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_Get": { + "$ref": "./examples/SensorMappings_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorMappings" + ], + "description": "Deletes a sensor mapping entity.", + "operationId": "SensorMappings_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_Delete": { + "$ref": "./examples/SensorMappings_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations": { + "get": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Gets partner integration models.", + "operationId": "SensorPartnerIntegrations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyIds", + "description": "Ids of the parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorPartnerIntegrations_List": { + "$ref": "./examples/SensorPartnerIntegrations_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}": { + "patch": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Create or update an integration with a sensor partner.", + "operationId": "SensorPartnerIntegrations_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration to be created.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorPartnerIntegrationModel", + "description": "Partner integration model.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_CreateOrUpdate": { + "$ref": "./examples/SensorPartnerIntegrations_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Gets a partner integration model entity.", + "operationId": "SensorPartnerIntegrations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_Get": { + "$ref": "./examples/SensorPartnerIntegrations_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Deletes a partner integration model entity.", + "operationId": "SensorPartnerIntegrations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_Delete": { + "$ref": "./examples/SensorPartnerIntegrations_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent": { + "post": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Checks consent for partner integration.", + "operationId": "SensorPartnerIntegrations_CheckConsent", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "description": "Partner integration key.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationCheckConsentResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_CheckConsent": { + "$ref": "./examples/SensorPartnerIntegrations_CheckConsent.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:generate-consent-link": { + "post": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Generates partner integration consent link.", + "operationId": "SensorPartnerIntegrations_GenerateConsentLink", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationGenerateConsentLinkResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_GenerateConsentLink": { + "$ref": "./examples/SensorPartnerIntegrations_GenerateConsentLink.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors": { + "get": { + "tags": [ + "Sensors" + ], + "description": "Returns a paginated list of sensor resources.", + "operationId": "Sensors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorDataModelIds", + "description": "Id's of the sensor data models.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sensorMappingIds", + "description": "Ids of the sensor mappings.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "deviceIds", + "description": "Id's of the devices.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Sensors_List": { + "$ref": "./examples/Sensors_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}": { + "patch": { + "tags": [ + "Sensors" + ], + "description": "Create a sensor entity.", + "operationId": "Sensors_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorDetails", + "description": "Sensor object details.", + "required": true, + "schema": { + "$ref": "#/definitions/Sensor" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_CreateOrUpdate": { + "$ref": "./examples/Sensors_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Sensors" + ], + "description": "Gets a sensor entity.", + "operationId": "Sensors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_Get": { + "$ref": "./examples/Sensors_Get.json" + } + } + }, + "delete": { + "tags": [ + "Sensors" + ], + "description": "Deletes a sensor entity.", + "operationId": "Sensors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_Delete": { + "$ref": "./examples/Sensors_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings": { + "get": { + "tags": [ + "Sensors" + ], + "description": "Gets a sensor connection string.", + "operationId": "Sensors_GetConnectionString", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IoTHubDeviceAuthentication" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_GetConnectionString": { + "$ref": "./examples/Sensors_GetConnectionString.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings/:renew": { + "post": { + "tags": [ + "Sensors" + ], + "description": "Renews a sensor connection string.", + "operationId": "Sensors_RenewConnectionString", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "renewConnectionStringModel", + "description": "Sensor's connection string model.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorRenewConnectionStringModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IoTHubDeviceAuthentication" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_RenewConnectionString": { + "$ref": "./examples/Sensors_RenewConnectionString.json" + } + } + } + }, + "/solutions/{solutionId}:cancel": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Cancels a job for given solution id.", + "operationId": "SolutionInference_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of solution for which job is to be cancelled.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SolutionInference_Cancel": { + "$ref": "./examples/SolutionInference_Cancel.json" + } + } + } + }, + "/solutions/{solutionId}:create": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Creates a job trigger for a solution.", + "operationId": "SolutionInference_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of the solution resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SolutionInference_CreateOrUpdate": { + "$ref": "./examples/SolutionInference_CreateOrUpdate.json" + } + } + } + }, + "/solutions/{solutionId}:fetch": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Fetches details of triggered job for a solution.", + "operationId": "SolutionInference_Fetch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of the solution.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SolutionInference_Fetch": { + "$ref": "./examples/SolutionInference_Fetch.json" + } + } + } + }, + "/parties/{partyId}/tillage-data": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Returns a paginated list of tillage data resources under a particular farm.", + "operationId": "TillageData_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minTillageDepth", + "description": "Minimum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillageDepth", + "description": "Maximum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTillagePressure", + "description": "Minimum pressure applied to a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillagePressure", + "description": "Maximum pressure applied to a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TillageData_ListByPartyId": { + "$ref": "./examples/TillageData_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/tillage-data/{tillageDataId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a specified tillage data resource under a particular party.", + "operationId": "TillageData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Get": { + "$ref": "./examples/TillageData_Get.json" + } + } + }, + "patch": { + "tags": [ + "TillageData" + ], + "description": "Creates or updates an tillage data resource under a particular party.", + "operationId": "TillageData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "tillageData", + "description": "Tillage data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/TillageData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + }, + "x-ms-examples": { + "TillageData_CreateOrUpdate": { + "$ref": "./examples/TillageData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "TillageData" + ], + "description": "Deletes a specified tillage data resource under a particular party.", + "operationId": "TillageData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Delete": { + "$ref": "./examples/TillageData_Delete.json" + } + } + } + }, + "/tillage-data": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Returns a paginated list of tillage data resources across all parties.", + "operationId": "TillageData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minTillageDepth", + "description": "Minimum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillageDepth", + "description": "Maximum measured tillage depth (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTillagePressure", + "description": "Minimum pressure applied to a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillagePressure", + "description": "Maximum pressure applied to a tillage implement (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "Boundary IDs associated with operation data.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Minimum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Maximum area for which operation was applied (inclusive).", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TillageData_List": { + "$ref": "./examples/TillageData_List.json" + } + } + } + }, + "/tillage-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "TillageData" + ], + "description": "Create cascade delete job for tillage data resource.", + "operationId": "TillageData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "tillageDataId", + "description": "Id of the tillage data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "TillageData_CreateCascadeDeleteJob": { + "$ref": "./examples/TillageData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "TillageData" + ], + "description": "Get cascade delete job for tillage data resource.", + "operationId": "TillageData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/TillageData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/weather": { + "get": { + "tags": [ + "Weather" + ], + "description": "Returns a paginated list of weather data.", + "operationId": "Weather_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "partyId", + "description": "Party ID.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "Boundary ID.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "extensionId", + "description": "ID of the weather extension.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "weatherDataType", + "description": "Type of weather data (forecast/historical).", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "granularity", + "description": "Granularity of weather data (daily/hourly).", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "startDateTime", + "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Weather_List": { + "$ref": "./examples/Weather_List.json" + } + } + } + }, + "/weather/delete-data/{jobId}": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get weather data delete job.", + "operationId": "Weather_GetDataDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Weather_GetDataDeleteJobDetails": { + "$ref": "./examples/Weather_GetDataDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Weather" + ], + "description": "Create a weather data delete job.", + "operationId": "Weather_CreateDataDeleteJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Weather_CreateDataDeleteJob": { + "$ref": "./examples/Weather_CreateDataDeleteJob.json" + } + } + } + }, + "/weather/ingest-data/{jobId}": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get weather ingestion job.", + "operationId": "Weather_GetDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Weather_GetDataIngestionJobDetails": { + "$ref": "./examples/Weather_GetDataIngestionJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Weather" + ], + "description": "Create a weather data ingestion job.", + "operationId": "Weather_CreateDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job id supplied by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Weather_CreateDataIngestionJob": { + "$ref": "./examples/Weather_CreateDataIngestionJob.json" + } + } + } + }, + "/weather-data/:fetch": { + "post": { + "tags": [ + "WeatherData" + ], + "description": "Returns a list of WeatherData.", + "operationId": "WeatherData_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "weatherDataProviderRequest", + "description": "Weather data provider request.", + "required": true, + "schema": { + "$ref": "#/definitions/WeatherDataProviderRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataProviderResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "WeatherData_Get": { + "$ref": "./examples/WeatherData_Get.json" + } + } + } + }, + "/parties/{partyId}/zones": { + "get": { + "tags": [ + "Zones" + ], + "description": "Returns a paginated list of zone resources under a particular party.", + "operationId": "Zones_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the Zones.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "managementZoneIds", + "description": "ManagementZoneIds of the Zones.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the Zones.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Zones_ListByPartyId": { + "$ref": "./examples/Zones_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/zones/{zoneId}": { + "get": { + "tags": [ + "Zones" + ], + "description": "Gets a specified zone resource under a particular party.", + "operationId": "Zones_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Get": { + "$ref": "./examples/Zones_Get.json" + } + } + }, + "patch": { + "tags": [ + "Zones" + ], + "description": "Creates or updates a Zone resource.", + "operationId": "Zones_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "zone", + "description": "Zone resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Zone" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_CreateOrUpdate": { + "$ref": "./examples/Zones_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Zones" + ], + "description": "Deletes a specified zone resource under a particular party.", + "operationId": "Zones_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Delete": { + "$ref": "./examples/Zones_Delete.json" + } + } + } + }, + "/zones": { + "get": { + "tags": [ + "Zones" + ], + "description": "Returns a paginated list of zone resources across all parties.", + "operationId": "Zones_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the Zones.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "managementZoneIds", + "description": "ManagementZoneIds of the Zones.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the Zones.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Zones_List": { + "$ref": "./examples/Zones_List.json" + } + } + } + }, + "/zones/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Zones" + ], + "description": "Get a cascade delete job for specified job id.", + "operationId": "Zones_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Zones_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Zones" + ], + "description": "Create a cascade delete job for specified zone.", + "operationId": "Zones_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "zoneId", + "description": "ID of the zone to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Zones_CreateCascadeDeleteJob": { + "$ref": "./examples/Zones_CreateCascadeDeleteJob.json" + } + } + } + } + }, + "definitions": { + "AdditionalProviderParameters": { + "description": "Schema of additional parameters for weather data provider request.", + "type": "object", + "properties": { + "iconResolution": { + "description": "Icon Resolution (Only applicable for AzureWeatherMaps).", + "type": "string" + }, + "details": { + "description": "Details (Only applicable for AzureWeatherMaps).", + "default": true, + "type": "boolean" + } + } + }, + "ApiKeyAuthCredentials": { + "description": "Api Key Auth Credentials class for API Key based Auth.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + }, + { + "required": [ + "apiKey" + ], + "type": "object", + "properties": { + "apiKey": { + "$ref": "#/definitions/KeyVaultProperties" + } + } + } + ], + "x-ms-discriminator-value": "ApiKeyAuthCredentials" + }, + "ApplicationData": { + "description": "Schema of application data resource.", + "type": "object", + "properties": { + "applicationProductDetails": { + "description": "Application product details.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationProductDetail" + } + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "ApplicationProductDetail": { + "description": "Schema of product used during application.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product applied.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "isCarrier": { + "description": "A flag indicating whether product is a carrier for a tank mix.", + "default": false, + "type": "boolean" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "Attachment": { + "description": "Schema of attachment resource.", + "type": "object", + "properties": { + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + "resourceType": { + "description": "Associated Resource type for this attachment.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField", + "Boundary", + "ApplicationData", + "HarvestData", + "TillageData", + "PlantingData", + "PlantTissueAnalysis" + ], + "type": "string", + "x-ms-enum": { + "name": "AttachmentResourceType", + "modelAsString": true + } + }, + "originalFileName": { + "description": "Original File Name for this attachment.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "PartyId id for this attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date when resource was created.", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date when resource was last modified.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "AttachmentListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Attachment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "AuthCredentials": { + "description": "AuthCredentials abstract base class for Auth Purpose. .", + "required": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/AuthCredentialsKind" + } + }, + "discriminator": "kind" + }, + "AuthCredentialsKind": { + "description": "CredentialTypeEnum.", + "enum": [ + "OAuthClientCredentials", + "ApiKeyAuthCredentials" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthCredentialsKind", + "modelAsString": true + } + }, + "BiomassModelJob": { + "description": "Schema of biomass model job.", + "required": [ + "boundaryId", + "cropName", + "imageFormat", + "imageResolution", + "inferenceEndDateTime", + "modelVersion", + "partyId", + "plantingStartDateTime", + "satelliteProvider", + "satelliteSource", + "weatherExtensionId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which biomass is being calculated.", + "minLength": 1, + "type": "string" + }, + "modelVersion": { + "description": "The version of the biomass model to be run. Available Value: 1.0 .", + "minLength": 1, + "type": "string" + }, + "cropName": { + "description": "Crop name for biomass model. Available Value: Corn.", + "minLength": 1, + "enum": [ + "Corn" + ], + "type": "string", + "x-ms-enum": { + "name": "CropName", + "modelAsString": true + } + }, + "plantingStartDateTime": { + "format": "date-time", + "description": "Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "inferenceEndDateTime": { + "format": "date-time", + "description": "End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "weatherExtensionId": { + "description": "ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string" + }, + "satelliteProvider": { + "description": "Provider of satellite data. Available Values: Microsoft, SentinelHub (Sentinel Hub by Sinergise).", + "minLength": 1, + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "satelliteSource": { + "description": "Source of satellite data. Available Value: Sentinel_2_L2A.", + "minLength": 1, + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "imageResolution": { + "format": "double", + "description": "ImageResolution in meters. Available values: 10, 20, 60.", + "type": "number" + }, + "imageFormat": { + "description": "ImageFormat. Available value: TIF.", + "minLength": 1, + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "Boundary": { + "description": "Schema of boundary resource.", + "type": "object", + "properties": { + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "type": { + "description": "Indicates the type of boundary belonging to a parent.", + "type": "string" + }, + "crs": { + "description": "Coordinate Reference System.", + "type": "string", + "readOnly": true + }, + "centroid": { + "$ref": "#/definitions/GeoJsonObject" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "Id of the parent it belongs to.", + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "parentType": { + "description": "Type of the parent it belongs to.\r\ni.e. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.", + "enum": [ + "Field", + "SeasonalField", + "Zone", + "Prescription", + "PlantTissueAnalysis", + "ApplicationData", + "PlantingData", + "TillageData", + "HarvestData" + ], + "type": "string", + "x-ms-enum": { + "name": "BoundaryParentType", + "modelAsString": true + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {} + } + }, + "example": { + "name": "string", + "description": "string", + "source": "string", + "parentId": "string", + "parentType": "Field", + "type": "string", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "BoundaryMetadata": { + "description": "Schema of boundary resource metadata.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "Id of the parent it belongs to.", + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "parentType": { + "description": "Type of the parent it belongs to.", + "enum": [ + "Field", + "SeasonalField", + "Zone", + "Prescription", + "PlantTissueAnalysis", + "ApplicationData", + "PlantingData", + "TillageData", + "HarvestData" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BoundaryParentType", + "modelAsString": true + } + }, + "type": { + "description": "Type it belongs to.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {} + } + }, + "example": { + "name": "string", + "description": "string", + "source": "string", + "parentId": "string", + "isPrimary": false, + "type": "string", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "BoundaryMetadataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundaryMetadata" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "BoundaryOverlapResponse": { + "description": "Schema of boundary overlap response.", + "type": "object", + "properties": { + "boundaryArea": { + "format": "double", + "description": "Acreage of Main boundary.", + "type": "number" + }, + "otherBoundaryArea": { + "format": "double", + "description": "Acreage of other boundary.", + "type": "number" + }, + "intersectingArea": { + "format": "double", + "description": "Acreage of intersecting boundary.", + "type": "number" + } + } + }, + "CascadeDeleteJob": { + "description": "Schema of cascade delete job.", + "required": [ + "partyId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "resourceId": { + "description": "The id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceType": { + "description": "The type of the resource.", + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "enum": [ + "Waiting", + "Running", + "Succeeded", + "Failed", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + } + } + }, + "Crop": { + "description": "Schema of crop resource.", + "type": "object", + "properties": { + "phenotype": { + "description": "Crop phenotype.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "breedingMethod": { + "description": "Breeding Method.", + "enum": [ + "VARIETY", + "HYBRID", + "UNKNOWN" + ], + "type": "string", + "x-ms-enum": { + "name": "BreedingMethod", + "modelAsString": true + } + }, + "measurements": { + "description": "Measurements.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Crop" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "CropProduct": { + "description": "Schema of crop product resource.", + "type": "object", + "properties": { + "cropIds": { + "description": "Ids of the crops it belongs to.\r\nNote: A maximum of 25 crops can be associated with a cropProduct.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "brand": { + "description": "CropProduct Brand.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "CropProduct product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "trait": { + "description": "CropProduct trait.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "relativeMaturity": { + "$ref": "#/definitions/Measure" + }, + "treatments": { + "description": "CropProduct treatments.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropProductListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CropProduct" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DataProvider": { + "description": "Provider of satellite data.", + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "Device": { + "description": "Device API model.", + "type": "object", + "properties": { + "deviceDataModelId": { + "description": "Id of the associated device data model.", + "type": "string" + }, + "integrationId": { + "description": "Integration id for the device.", + "type": "string" + }, + "type": { + "description": "Type of device.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "hardwareId": { + "description": "Device hardwareId.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "reportingIntervalInSeconds": { + "format": "int32", + "description": "Interval at which the device sends data in seconds.", + "type": "integer" + }, + "parentDeviceId": { + "description": "Parent device Id for this device.", + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DeviceDataModel": { + "description": "DeviceDataModel API model.", + "type": "object", + "properties": { + "type": { + "description": "Type of device.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "manufacturer": { + "description": "Device manufacturer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productCode": { + "description": "Device productCode.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "ports": { + "description": "List of device ports supported.", + "type": "array", + "items": { + "$ref": "#/definitions/Port" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DeviceDataModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DeviceListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Device" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Error": { + "description": "An error from the Azure AgPlatform service.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "minLength": 1, + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "Target of the error.", + "type": "string" + }, + "details": { + "description": "Array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorForLocation": { + "description": "Model for error information for a failed location.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/WeatherLocation" + }, + "code": { + "format": "int32", + "description": "Status code returned by data provider.", + "type": "integer" + }, + "description": { + "description": "Description of the error.", + "type": "string" + }, + "retryable": { + "description": "Flag suggesting if retry attempt with same request body should be made to fetch required data.", + "type": "boolean" + } + } + }, + "ErrorResponse": { + "description": "An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + }, + "traceId": { + "description": "Unique trace Id.", + "type": "string" + } + } + }, + "Farm": { + "description": "Schema of farm resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Farm" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "FarmOperationDataIngestionJob": { + "description": "Schema of farm operation data ingestion job.", + "required": [ + "authProviderId", + "partyId", + "providerInput", + "startYear" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "authProviderId": { + "description": "Authentication provider Id.", + "minLength": 1, + "type": "string" + }, + "operations": { + "description": "List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.", + "type": "array", + "items": { + "type": "string" + } + }, + "startYear": { + "format": "int32", + "description": "Start Year (Minimum = 2000, Maximum = CurrentYear).", + "type": "integer" + }, + "isIncremental": { + "description": "Use this to pull only the incremental changes from the last run.", + "default": false, + "type": "boolean" + }, + "providerInput": { + "$ref": "#/definitions/FarmOperationJobProviderInput" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmOperationJobProviderInput": { + "description": "Schema for provider input for Farm operations job.", + "required": [ + "shapeResolution", + "shapeType" + ], + "type": "object", + "properties": { + "shapeType": { + "description": "Type of shape file to be ingested from JohnDeere.\r\nPossible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.", + "minLength": 1, + "enum": [ + "Point", + "Polygon" + ], + "type": "string", + "x-ms-enum": { + "name": "ShapeType", + "modelAsString": true + } + }, + "shapeResolution": { + "description": "Resolution of shape file to be ingested from JohnDeere.\r\nPossible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.", + "minLength": 1, + "enum": [ + "EachSection", + "EachSensor", + "OneHertz" + ], + "type": "string", + "x-ms-enum": { + "name": "ShapeResolution", + "modelAsString": true + } + } + } + }, + "Field": { + "description": "Schema of field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Field" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "GeoJsonObject": { + "description": "GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonObjectType" + } + }, + "discriminator": "type" + }, + "GeoJsonObjectType": { + "description": "GeoJSON object type.", + "enum": [ + "Point", + "Polygon", + "MultiPolygon" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": true + } + }, + "HarvestData": { + "description": "Schema of harvest data resource.", + "type": "object", + "properties": { + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "avgSpeed": { + "$ref": "#/definitions/Measure" + }, + "harvestProductDetails": { + "description": "Harvest product details.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "HarvestProductDetail": { + "description": "Schema of product used during harvesting.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + } + } + }, + "ImageFile": { + "description": "Schema of image file resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "fileLink": { + "description": "Link of the image file.", + "type": "string" + }, + "name": { + "description": "Name of the image file.", + "minLength": 1, + "type": "string" + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "resolution": { + "format": "double", + "description": "Resolution of image file in meters.", + "type": "number" + } + } + }, + "ImageFormat": { + "description": "Supported image formats for scene resource.", + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "ImageProcessingRasterizeJob": { + "description": "Image Processing Rasterize Job to convert shapefile into tiff file.", + "required": [ + "partyId", + "shapefileAttachmentId", + "shapefileColumnNames" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "shapefileAttachmentId": { + "description": "Shapefile attachment Id.", + "minLength": 1, + "type": "string" + }, + "shapefileColumnNames": { + "description": "List of shapefile column names to create raster attachments.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "InnerError": { + "description": "Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.", + "type": "object", + "properties": { + "code": { + "description": "Specific error code than was provided by the containing error.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "Insight": { + "description": "Schema of insight resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated party.", + "type": "string", + "readOnly": true + }, + "modelId": { + "description": "Id of the associated model.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Resource type associated with the record.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField", + "Boundary" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FarmHierarchyResourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Id of the associated resource.", + "type": "string", + "readOnly": true + }, + "modelVersion": { + "description": "Version of the associated model.", + "type": "string" + }, + "attachmentsLink": { + "description": "Gets link for attachments.", + "type": "string", + "readOnly": true + }, + "insightStartDateTime": { + "format": "date-time", + "description": "Start date to which the insight is related.", + "type": "string" + }, + "insightEndDateTime": { + "format": "date-time", + "description": "End date to which the insight is related.", + "type": "string" + }, + "measurements": { + "description": "Measures to capture insights results.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "InsightAttachment": { + "description": "Schema of insight attachment resource.", + "required": [ + "insightId" + ], + "type": "object", + "properties": { + "insightId": { + "description": "InsightID for this InsightAttachment.", + "minLength": 1, + "type": "string" + }, + "modelId": { + "description": "ModelID for this InsightAttachment.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Associated Resource type for this attachment.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField", + "Boundary" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FarmHierarchyResourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string", + "readOnly": true + }, + "originalFileName": { + "description": "Original File Name for this attachment.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "PartyId id for this attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date when resource was created.", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date when resource was last modified.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "InsightAttachmentListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "InsightListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Insight" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "IoTHubDeviceAuthentication": { + "description": "Authentication via connection string to IoTHub devices.", + "type": "object", + "properties": { + "primaryDeviceConnectionString": { + "description": "Primary connection string of the ioTHub device.", + "type": "string", + "readOnly": true + }, + "secondaryDeviceConnectionString": { + "description": "Secondary connection string of the ioTHub device.", + "type": "string", + "readOnly": true + } + } + }, + "KeyVaultProperties": { + "description": "Properties of the key vault.", + "required": [ + "keyName", + "keyVaultUri", + "keyVersion" + ], + "type": "object", + "properties": { + "keyVaultUri": { + "description": "Uri of the key vault.", + "minLength": 1, + "type": "string" + }, + "keyName": { + "description": "Name of Key Vault key.", + "minLength": 1, + "type": "string" + }, + "keyVersion": { + "description": "Version of Key Vault key.", + "minLength": 1, + "type": "string" + } + } + }, + "LabDetails": { + "description": "Model for representing LabDetails object.", + "type": "object", + "properties": { + "code": { + "description": "Code of the resource.", + "maxLength": 150, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "address": { + "description": "Address of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + } + } + }, + "Location": { + "description": "Location model class.", + "required": [ + "latitude", + "longitude" + ], + "type": "object", + "properties": { + "latitude": { + "format": "double", + "description": "Latitude of the location.", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "format": "double", + "description": "Longitude of the location.", + "maximum": 180, + "minimum": -180, + "type": "number" + } + } + }, + "ManagementZone": { + "description": "Api Model for ManagementZone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the ManagementZone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the ManagementZone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "seasonId": { + "description": "Season Id associated with the ManagementZone.", + "type": "string" + }, + "cropId": { + "description": "Crop Id associated with the ManagementZone.", + "type": "string" + }, + "fieldId": { + "description": "Field Id associated with the ManagementZone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ManagementZoneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementZone" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Measure": { + "description": "Schema for storing measurement reading and unit.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "value": { + "format": "double", + "description": "Data value.", + "type": "number" + } + } + }, + "Measures": { + "description": "Schema for storing measurement readings and unit.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "values": { + "description": "Data values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "MultiPolygon": { + "description": "MultiPolygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets Coordinates of GeoJSON Object.\r\nIt must be an array of polygons, each polygon contains list of linear rings.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings.", + "minItems": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + } + ], + "x-ms-discriminator-value": "MultiPolygon" + }, + "NutrientAnalysis": { + "description": "Api Model for nutrient analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party id for this nutrient analysis.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "Parent id for this nutrient analysis.", + "type": "string" + }, + "parentType": { + "description": "Parent type for this nutrient analysis.\r\ni.e. PlantTissueAnalysis.", + "enum": [ + "PlantTissueAnalysis" + ], + "type": "string", + "x-ms-enum": { + "name": "NutrientAnalysisParentType", + "modelAsString": true + } + }, + "unit": { + "description": "Unit for this nutrient analysis.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "value": { + "format": "double", + "description": "Value for this nutrient analysis.", + "type": "number" + }, + "referenceValueLow": { + "format": "double", + "description": "Reference value low for this nutrient analysis.", + "type": "number" + }, + "referenceValueHigh": { + "format": "double", + "description": "Reference value high for this nutrient analysis.", + "type": "number" + }, + "classification": { + "description": "Classification for this nutrient analysis.", + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "recommendation": { + "description": "Recommendation for this nutrient analysis.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "products": { + "description": "Products for this nutrient analysis.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductDetails" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "NutrientAnalysisListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OAuthClientCredentials": { + "description": "OAuthClientCredentials for clientId clientSecret auth.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + }, + { + "required": [ + "clientId", + "clientSecret" + ], + "type": "object", + "properties": { + "clientId": { + "description": "ClientId associated with the provider.", + "minLength": 1, + "type": "string" + }, + "clientSecret": { + "$ref": "#/definitions/KeyVaultProperties" + } + } + } + ], + "x-ms-discriminator-value": "OAuthClientCredentials" + }, + "OAuthConnectRequest": { + "description": "Get OAuth config query parameters.", + "required": [ + "oAuthProviderId", + "partyId", + "userRedirectLink" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Id of the party.", + "minLength": 1, + "type": "string" + }, + "oAuthProviderId": { + "description": "Id of the OAuthProvider.", + "minLength": 1, + "type": "string" + }, + "userRedirectLink": { + "description": "Link to redirect the user to, at the end of the oauth flow.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "userRedirectState": { + "description": "State to provide back when redirecting the user, at the end of the oauth flow.", + "maxLength": 200, + "minLength": 0, + "type": "string" + } + } + }, + "OAuthProvider": { + "description": "Schema of OAuth provider resource.", + "type": "object", + "properties": { + "appId": { + "description": "OAuth App Id for given OAuth Provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "appSecret": { + "description": "OAuth App secret for given Provider.\r\nNote: Won't be sent in response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "apiKey": { + "description": "OAuth Api key for given Provider.\r\nNote: currently Applicable to Climate provider. Won't be sent in response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "isProductionApp": { + "description": "An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)\r\nNote: Currently applicable for JohnDeere.", + "default": false, + "type": "boolean" + }, + "id": { + "description": "Unique OAuth provider ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProviderCascadeDeleteJob": { + "description": "Schema of oauth provider cascade delete job.", + "required": [ + "oauthProviderId" + ], + "type": "object", + "properties": { + "oauthProviderId": { + "description": "The id of the oauth provider.", + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProviderListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OAuthToken": { + "description": "Schema of OAuth token resource.", + "required": [ + "authProviderId", + "partyId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party ID for this OAuth config.", + "type": "string" + }, + "authProviderId": { + "description": "ID of the OAuth provider resource containing app information.", + "minLength": 1, + "type": "string" + }, + "isValid": { + "description": "An optional flag indicating whether the token is a valid or expired (Default value: true).", + "default": true, + "type": "boolean" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + } + } + }, + "OAuthTokenListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/OAuthToken" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Party": { + "description": "Schema of party resource.", + "type": "object", + "properties": { + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PartyListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Party" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PlantTissueAnalysis": { + "description": "Api Model for plant tissue analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated Party.", + "type": "string", + "readOnly": true + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "cropId": { + "description": "Id of the associated Crop.", + "type": "string" + }, + "cropProductId": { + "description": "Id of the associated Crop product.", + "type": "string" + }, + "seasonId": { + "description": "Id of the associated Season.", + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "Planting datetime for this plant tissue analysis.", + "type": "string" + }, + "growthStage": { + "description": "Growth stage for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPart": { + "description": "Plant part for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPosition": { + "description": "Plant position for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantAppearance": { + "description": "Plant appearance for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionCondition": { + "description": "Sample collection condition for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionDateTime": { + "format": "date-time", + "description": "Sample collection dateTime for this plant tissue analysis.", + "type": "string" + }, + "sampleReceivedDateTime": { + "format": "date-time", + "description": "Sample received dateTime.", + "type": "string" + }, + "sampleTestResultDateTime": { + "format": "date-time", + "description": "Sample test result dateTime for this plant tissue analysis.", + "type": "string" + }, + "labDetails": { + "$ref": "#/definitions/LabDetails" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantTissueAnalysisListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PlantingData": { + "description": "Schema of planting data resource.", + "type": "object", + "properties": { + "avgPlantingRate": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "plantingProductDetails": { + "description": "Planting product details.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PlantingProductDetail": { + "description": "Schema for Planting product detail.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product.", + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "Point": { + "description": "Point geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets the coordinate of this point.\r\nIt must be an array of 2 or 3 elements for a 2D or 3D system.", + "maximum": 3, + "minimum": 2, + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + ], + "x-ms-discriminator-value": "Point" + }, + "Polygon": { + "description": "Polygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets type of the GeoJSON Object.\r\nIt must be an array of linear ring coordinate arrays.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings.", + "minItems": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + ], + "x-ms-discriminator-value": "Polygon" + }, + "Port": { + "description": "Schema for storing port values.", + "type": "object", + "properties": { + "name": { + "description": "Name of the port.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Type of port digital/analog.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "Prescription": { + "description": "Api Model for Prescription object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "prescriptionMapId": { + "description": "Prescription map Id.", + "type": "string" + }, + "productCode": { + "description": "Product Code.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productName": { + "description": "Product name.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Prescription type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measurements": { + "description": "Measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Prescription" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PrescriptionMap": { + "description": "Api Model for Prescription Map object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Prescription map type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "seasonId": { + "description": "Season Id.", + "type": "string" + }, + "cropId": { + "description": "Crop Id.", + "type": "string" + }, + "fieldId": { + "description": "Field Id.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMapListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "ProductDetails": { + "description": "Model for representing ProductDetails object.", + "type": "object", + "properties": { + "rate": { + "description": "Rate of the product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "instruction": { + "description": "Instruction of the resource.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "Product of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "SatelliteData": { + "description": "Data Model for SatelliteIngestionJobRequest.", + "type": "object", + "properties": { + "imageNames": { + "description": "List of ImageNames.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NDVI" + ] + }, + "imageFormats": { + "description": "List of ImageFormats. Available value: TIF.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "TIF" + ] + }, + "imageResolutions": { + "description": "List of ImageResolutions in meters. Available values: 10, 20, 60.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "example": [ + 10 + ] + } + } + }, + "SatelliteDataIngestionJob": { + "description": "Schema of satellite data ingestion job.", + "required": [ + "boundaryId", + "endDateTime", + "partyId", + "provider", + "source", + "startDateTime" + ], + "type": "object", + "properties": { + "credential": { + "$ref": "#/definitions/OAuthClientCredentials" + }, + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which satellite data is being fetched.", + "minLength": 1, + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "Start Date.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End Date.", + "type": "string" + }, + "provider": { + "$ref": "#/definitions/DataProvider" + }, + "source": { + "$ref": "#/definitions/Source" + }, + "data": { + "$ref": "#/definitions/SatelliteData" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object" + } + } + }, + "Scene": { + "description": "Schema of scene resource.", + "type": "object", + "properties": { + "sceneDateTime": { + "format": "date-time", + "description": "Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "provider": { + "description": "Data provider of the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "source": { + "description": "Data source of the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "imageFiles": { + "description": "Collection of image files.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageFile" + } + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "cloudCoverPercentage": { + "format": "double", + "description": "Cloud cover percentage of the scene.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "darkPixelPercentage": { + "format": "double", + "description": "Dark pixel percentage of the scene.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "ndviMedianValue": { + "format": "double", + "description": "Median of NDVI of the scene.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "boundaryId": { + "description": "Boundary ID which belongs to the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "partyId": { + "description": "Party ID which belongs to the scene.", + "type": "string" + }, + "id": { + "description": "Unique scene resource ID.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "SceneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Scene" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SearchBoundaryQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "maxPageSize": { + "format": "int32", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + "skipToken": { + "description": "Skip token for getting next set of results.", + "type": "string" + }, + "parentType": { + "description": "Type of the parent it belongs to.", + "enum": [ + "Field", + "SeasonalField", + "Zone", + "Prescription", + "PlantTissueAnalysis", + "ApplicationData", + "PlantingData", + "TillageData", + "HarvestData" + ], + "type": "string", + "x-ms-enum": { + "name": "BoundaryParentType", + "modelAsString": true + } + }, + "type": { + "description": "Type it belongs to.", + "type": "string" + }, + "parentIds": { + "description": "Parent Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + } + } + }, + "SearchFeaturesQuery": { + "description": "Search stac Features parameters.", + "required": [ + "endDateTime", + "startDateTime" + ], + "type": "object", + "properties": { + "credential": { + "$ref": "#/definitions/OAuthClientCredentials" + }, + "startDateTime": { + "format": "date-time", + "description": "Start datetime of the time interval in which to search for Features.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End datetime of the time interval in which to search for Features.", + "type": "string" + }, + "intersects": { + "$ref": "#/definitions/GeoJsonObject" + }, + "bbox": { + "description": "Only features that have a geometry that intersects the bounding box are selected.\r\nThe bounding box is provided as four numbers. The coordinate reference system of the values is WGS84 longitude/latitude.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "featureIds": { + "description": "Array of feature ids to return.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SearchFeaturesResponse": { + "description": "Paged response contains list of features and next property to get the next set of results.", + "required": [ + "features" + ], + "type": "object", + "properties": { + "features": { + "description": "List of features.", + "type": "array", + "items": { + "$ref": "#/definitions/StacFeature" + } + }, + "nextLink": { + "description": "URL to do the POST request with same filters,\r\nto get next set of features.", + "type": "string", + "readOnly": true + } + } + }, + "Season": { + "description": "Schema of season resource.", + "type": "object", + "properties": { + "startDateTime": { + "format": "date-time", + "description": "Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "year": { + "format": "int32", + "description": "Season year.", + "type": "integer" + }, + "geographicIdentifier": { + "description": "Geographic Identifier.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Season" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SeasonalField": { + "description": "Schema of seasonal field resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "seasonId": { + "description": "Id of the season it belongs to.", + "type": "string" + }, + "cropProductIds": { + "description": "CropProduct ids.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SeasonalField" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Sensor": { + "description": "Sensor API model.", + "type": "object", + "properties": { + "sensorDataModelId": { + "description": "Id of the associated sensor data model.", + "type": "string" + }, + "integrationId": { + "description": "Integration id for the device.", + "type": "string" + }, + "hardwareId": { + "description": "Id of the associated hardware.", + "type": "string" + }, + "deviceId": { + "description": "Id of the associated device.", + "type": "string" + }, + "type": { + "description": "Type of sensor.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "port": { + "$ref": "#/definitions/Port" + }, + "depthInMeters": { + "description": "Depth of each sensor measure in meters.\r\nLike sensor moisture at 2m, 4m, 6m.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorDataModel": { + "description": "SensorModel API model.", + "required": [ + "measures" + ], + "type": "object", + "properties": { + "type": { + "description": "Type of sensor.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "manufacturer": { + "description": "Sensor manufacturer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productCode": { + "description": "Sensor productCode.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measures": { + "description": "Map of sensor type to sensor measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SensorDataModelMeasure" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorDataModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorDataModelMeasure": { + "description": "Sensor model measure details.", + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description of sensor measure.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "dataType": { + "description": "Sensor measure data type.", + "maxLength": 100, + "minLength": 2, + "enum": [ + "Bool", + "Double", + "DateTime", + "Long", + "String" + ], + "type": "string", + "x-ms-enum": { + "name": "SensorDataType", + "modelAsString": true + } + }, + "type": { + "description": "Measurement type of sensor data.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "unit": { + "description": "Unit of sensor measure.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs for sensor data model.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a model and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "SensorEvent": { + "description": "Sensor event response model.", + "type": "object", + "properties": { + "sensorId": { + "description": "Id of the sensor.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the sensor partner.", + "type": "string" + }, + "partyId": { + "description": "Id of the associated party.", + "type": "string" + }, + "boundaryId": { + "description": "Id of the associated boundary.", + "type": "string" + }, + "eventDateTime": { + "format": "date-time", + "description": "DateTime of sensor event observation.", + "type": "string" + }, + "ingestionDateTime": { + "format": "date-time", + "description": "DateTime of sensor event ingestion to data store.", + "type": "string" + }, + "measures": { + "description": "Sensor measures.", + "type": "object", + "additionalProperties": {} + } + } + }, + "SensorEventListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorEvent" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Sensor" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorMapping": { + "description": "SensorMapping API model.", + "type": "object", + "properties": { + "sensorId": { + "description": "Id of the associated sensor.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string" + }, + "partyId": { + "description": "Id of the associated party.", + "type": "string" + }, + "boundaryId": { + "description": "Id of the associated boundary.", + "type": "string" + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorMappingListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorMapping" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorPartnerIntegrationCheckConsentResponse": { + "description": "Sensor partner integration check consent response.", + "type": "object", + "properties": { + "consented": { + "description": "Flag to determine the status of partner integration consent.", + "type": "boolean" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "integrationId": { + "description": "Id of the integration.", + "type": "string", + "readOnly": true + } + } + }, + "SensorPartnerIntegrationGenerateConsentLinkResponse": { + "description": "Sensor partner integration generate consent link response.", + "type": "object", + "properties": { + "consentLink": { + "description": "Consent link.", + "type": "string", + "readOnly": true + }, + "consentExpiryDateTime": { + "format": "date-time", + "description": "Consent expiry date time, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + } + } + }, + "SensorPartnerIntegrationModel": { + "description": "Sensor partner integration model.", + "type": "object", + "properties": { + "integrationId": { + "description": "Id of the integration.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "Id of the party.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorPartnerIntegrationModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorPlacementModelJob": { + "description": "Schema of sensor placement model job.", + "required": [ + "boundaryId", + "inferenceEndDateTime", + "inferenceStartDateTime", + "isRanked", + "modelVersion", + "partyId", + "satelliteProvider", + "satelliteSource", + "sensorType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which sensor placement is being calculated.", + "minLength": 1, + "type": "string" + }, + "modelVersion": { + "description": "The version of the sensor placement model to be run.", + "minLength": 1, + "type": "string" + }, + "inferenceStartDateTime": { + "format": "date-time", + "description": "Start datetime for satellite data to be pulled.", + "type": "string" + }, + "inferenceEndDateTime": { + "format": "date-time", + "description": "End datetime for satellite data to be pulled.", + "type": "string" + }, + "satelliteProvider": { + "description": "Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise).", + "minLength": 1, + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "satelliteSource": { + "description": "Source of satellite data. Available Value: Sentinel_2_L2A.", + "minLength": 1, + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "sensorType": { + "description": "SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture.", + "minLength": 1, + "type": "string" + }, + "isRanked": { + "description": "IsRanked, if True the sensor placements will be ranked.", + "type": "boolean" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorRenewConnectionStringModel": { + "description": "Model for renewing sensor's connection string.", + "required": [ + "connectionStringType" + ], + "type": "object", + "properties": { + "connectionStringType": { + "description": "Specifies the type of connection string key to be renewed valid values - Primary/Secondary/Both.", + "maxLength": 100, + "minLength": 0, + "enum": [ + "Primary", + "Secondary", + "Both" + ], + "type": "string", + "x-ms-enum": { + "name": "RenewConnectionStringType", + "modelAsString": true + } + } + } + }, + "SoilMoistureModelJob": { + "description": "Schema of soil moisture model job.", + "required": [ + "boundaryId", + "imageFormat", + "imageResolution", + "inferenceEndDateTime", + "inferenceStartDateTime", + "modelVersion", + "partyId", + "satelliteProvider", + "satelliteSource", + "sensorDataModelId", + "sensorDefinition", + "sensorPartnerId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which soil moisture is being calculated.", + "minLength": 1, + "type": "string" + }, + "sensorDataModelId": { + "description": "Sensor data model Id.", + "minLength": 1, + "type": "string" + }, + "sensorPartnerId": { + "description": "Sensor partner Id.", + "minLength": 1, + "type": "string" + }, + "inferenceStartDateTime": { + "format": "date-time", + "description": "Inference start date time for soil moisture calculations.", + "type": "string" + }, + "inferenceEndDateTime": { + "format": "date-time", + "description": "Inference end date time for soil moisture calculations.", + "type": "string" + }, + "satelliteProvider": { + "description": "Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise).", + "minLength": 1, + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "satelliteSource": { + "description": "Source of satellite data. Available Value: Sentinel_2_L2A.", + "minLength": 1, + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "imageResolution": { + "format": "double", + "description": "ImageResolution in meters. Available values: 10, 20, 60.", + "type": "number" + }, + "imageFormat": { + "description": "ImageFormat. Available value: TIF.", + "minLength": 1, + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "modelVersion": { + "description": "The version of the soil moisture model to be run.", + "minLength": 1, + "type": "string" + }, + "sensorDefinition": { + "$ref": "#/definitions/SoilMoistureModelSensorDefinition" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SoilMoistureModelSensorDefinition": { + "description": "Schema for storing sensor definition keywords.", + "required": [ + "maxProperty", + "minProperty", + "sensorMeasurement" + ], + "type": "object", + "properties": { + "sensorMeasurement": { + "description": "The measurement name for sensor measure in sensorDataModel.", + "minLength": 1, + "type": "string" + }, + "minProperty": { + "description": "The measurement name for minimum measurement value.", + "minLength": 1, + "type": "string" + }, + "maxProperty": { + "description": "The measurement name for maximum measurement value.", + "minLength": 1, + "type": "string" + } + } + }, + "SolutionInference": { + "description": "SolutionInference request model.", + "required": [ + "requestPath" + ], + "type": "object", + "properties": { + "requestPath": { + "description": "RequestPath containing the api-version, query parameters and path route to be called for partner request.\r\nExpected format is \"/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1\".\r\nNot following this format may result into validation errors.", + "minLength": 1, + "type": "string" + }, + "partnerRequestBody": { + "description": "Api input parameters required by partner to trigger/cancel job request.", + "type": "object", + "additionalProperties": {} + } + } + }, + "Source": { + "description": "Source of satellite data.", + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "StacFeature": { + "description": "Schema of STAC Feature(Item).\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#item-fields.", + "required": [ + "assets", + "id", + "links", + "properties", + "stacVersion", + "type" + ], + "type": "object", + "properties": { + "stacVersion": { + "description": "The STAC version the Feature implements.", + "minLength": 1, + "type": "string" + }, + "stacExtensions": { + "description": "A list of extensions the Feature implements.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Provider identifier. Globally unique ID by Data provider.", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Type of the GeoJSON Object. It's value is always Feature.", + "minLength": 1, + "type": "string" + }, + "geometry": { + "description": "Defines the full footprint of the asset represented by this item.\r\nIts a GeoJSON geometry.", + "type": "object" + }, + "bbox": { + "description": "Bounding box of the feature.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "properties": { + "description": "A dictionary of additional metadata for the item.", + "type": "object" + }, + "links": { + "description": "List of link objects to resources and related URLs.", + "type": "array", + "items": { + "$ref": "#/definitions/StacFeatureLink" + } + }, + "assets": { + "description": "Dictionary of asset objects, each with a unique key.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StacFeatureAsset" + } + }, + "collection": { + "description": "The id of the STAC Collection this Feature references.", + "type": "string" + } + } + }, + "StacFeatureAsset": { + "description": "Schema of STAC Feature's Asset.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#asset-object.", + "required": [ + "href" + ], + "type": "object", + "properties": { + "href": { + "description": "Link to the asset object.", + "minLength": 1, + "type": "string" + }, + "title": { + "description": "The displayed title for clients and users.", + "type": "string" + }, + "description": { + "description": "A description of the Asset providing additional details, such as how it was processed or created.", + "type": "string" + }, + "type": { + "description": "Media type of the asset.", + "type": "string" + }, + "roles": { + "description": "The semantic roles of the asset, similar to the use of rel in links.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StacFeatureLink": { + "description": "The Link object describes a relationship of this Feature with another entity.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#link-object.", + "required": [ + "href", + "rel" + ], + "type": "object", + "properties": { + "href": { + "description": "The actual link in the format of an URL.", + "minLength": 1, + "type": "string" + }, + "rel": { + "description": "Relationship between the current document and the linked document.", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Media type of the referenced entity.", + "type": "string" + }, + "title": { + "description": "A human readable title to be used in rendered displays of the link.", + "type": "string" + } + } + }, + "TillageData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "attachmentsLink": { + "description": "Link for attachments.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Optional boundary ID of the field for which operation was applied.", + "type": "string" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/TillageData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "WeatherData": { + "description": "Schema of weather data.", + "required": [ + "boundaryId", + "dateTime", + "extensionId", + "extensionVersion", + "granularity", + "location", + "partyId", + "weatherDataType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party ID.", + "minLength": 1, + "type": "string" + }, + "boundaryId": { + "description": "Boundary ID.", + "minLength": 1, + "type": "string" + }, + "extensionId": { + "description": "ID of the weather extension.", + "minLength": 1, + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "dateTime": { + "format": "date-time", + "description": "Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "unitSystemCode": { + "description": "Unit System like US/SI etc.", + "type": "string" + }, + "extensionVersion": { + "description": "Version of the weather data extension.", + "minLength": 1, + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "minLength": 1, + "type": "string" + }, + "granularity": { + "description": "Granularity of weather data (daily/hourly).", + "minLength": 1, + "type": "string" + }, + "cloudCover": { + "$ref": "#/definitions/Measure" + }, + "dewPoint": { + "$ref": "#/definitions/Measure" + }, + "growingDegreeDay": { + "$ref": "#/definitions/Measure" + }, + "precipitation": { + "$ref": "#/definitions/Measure" + }, + "pressure": { + "$ref": "#/definitions/Measure" + }, + "relativeHumidity": { + "$ref": "#/definitions/Measure" + }, + "soilMoisture": { + "$ref": "#/definitions/Measure" + }, + "soilTemperature": { + "$ref": "#/definitions/Measure" + }, + "temperature": { + "$ref": "#/definitions/Measure" + }, + "visibility": { + "$ref": "#/definitions/Measure" + }, + "wetBulbTemperature": { + "$ref": "#/definitions/Measure" + }, + "windChill": { + "$ref": "#/definitions/Measure" + }, + "windDirection": { + "$ref": "#/definitions/Measure" + }, + "windGust": { + "$ref": "#/definitions/Measure" + }, + "windSpeed": { + "$ref": "#/definitions/Measure" + }, + "id": { + "description": "Weather data ID.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "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 250 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": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataDeleteJob": { + "description": "Schema of weather data delete job.", + "required": [ + "boundaryId", + "extensionId", + "partyId" + ], + "type": "object", + "properties": { + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string" + }, + "partyId": { + "description": "The id of the party for which weather data is being fetched.", + "minLength": 1, + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary object for which weather data is being fetched.", + "minLength": 1, + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data. Possible values include: 'forecast' , 'historical'.", + "type": "string" + }, + "granularity": { + "description": "Granularity of weather data. Possible values include: 'daily' , 'hourly'.", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataErrors": { + "description": "Model for errors encountered for all failed locations.", + "type": "object", + "properties": { + "locations": { + "description": "List of errors encountered for all failed locations.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorForLocation" + } + } + } + }, + "WeatherDataForPassthrough": { + "description": "Schema of weather data.", + "type": "object", + "properties": { + "wetBulbTemperature": { + "$ref": "#/definitions/Measures" + }, + "cloudCover": { + "$ref": "#/definitions/Measures" + }, + "dayOfWeek": { + "description": "Day of week.", + "type": "array", + "items": { + "type": "string" + } + }, + "dayOrNight": { + "description": "This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTime": { + "description": "Expiration time in Utc format.", + "type": "array", + "items": { + "type": "string" + } + }, + "iconCode": { + "description": "This number is the key to the weather icon lookup. The data field shows the icon number that is matched to represent the observed weather conditions.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "iconCodeExtend": { + "description": "Code representing full set sensible weather.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "hasPrecipitation": { + "description": "Indicates whether there is precipitation or not.", + "type": "array", + "items": { + "type": "boolean" + } + }, + "pressureMeanSeaLevel": { + "$ref": "#/definitions/Measures" + }, + "relativeHumidity": { + "$ref": "#/definitions/Measures" + }, + "temperature": { + "$ref": "#/definitions/Measures" + }, + "temperatureDewPoint": { + "$ref": "#/definitions/Measures" + }, + "temperatureFeelsLike": { + "$ref": "#/definitions/Measures" + }, + "temperatureHeatIndex": { + "$ref": "#/definitions/Measures" + }, + "temperatureWindChill": { + "$ref": "#/definitions/Measures" + }, + "uvDescription": { + "description": "The UV Index Description which complements the UV Index value by providing an associated level of risk of skin damage due to exposure (-2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate, 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme).", + "type": "array", + "items": { + "type": "string" + } + }, + "uvIndex": { + "description": "Hourly maximum UV index.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "validTimeLocal": { + "description": "Time forecast is valid in local apparent time.", + "type": "array", + "items": { + "type": "string" + } + }, + "validTime": { + "description": "Time forecast is valid in Utc format.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "$ref": "#/definitions/Measures" + }, + "windDirection": { + "$ref": "#/definitions/Measures" + }, + "windGust": { + "$ref": "#/definitions/Measures" + }, + "windSpeed": { + "$ref": "#/definitions/Measures" + }, + "wxPhraseLong": { + "description": "Hourly sensible weather phrase containing longer description.", + "type": "array", + "items": { + "type": "string" + } + }, + "wxPhraseShort": { + "description": "Hourly sensible weather phrase containing short description.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalAttributes": { + "description": "A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 250 characters. Note: A maximum of 100 key value pairs can be provided for a resource and only string and numeral values are supported.", + "type": "object", + "additionalProperties": {} + } + } + }, + "WeatherDataIngestionJob": { + "description": "Schema of weather ingestion job.", + "required": [ + "boundaryId", + "extensionApiInput", + "extensionApiName", + "extensionId", + "partyId" + ], + "type": "object", + "properties": { + "boundaryId": { + "description": "The id of the boundary object for which weather data is being fetched.", + "minLength": 1, + "type": "string" + }, + "partyId": { + "description": "The id of the party for which weather data is being fetched.", + "minLength": 1, + "type": "string" + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "extensionApiInput": { + "description": "Extension api input dictionary which would be used to feed request query/body/parameter information.", + "type": "object", + "additionalProperties": {} + }, + "extensionDataProviderAppId": { + "description": "App id of the weather data provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "extensionDataProviderApiKey": { + "description": "Api key of the weather data provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "WeatherDataProviderRequest": { + "description": "Schema of weather data provider request.", + "required": [ + "extensionApiName", + "extensionId", + "units" + ], + "type": "object", + "properties": { + "credential": { + "$ref": "#/definitions/ApiKeyAuthCredentials" + }, + "locations": { + "description": "List of locations for which weather data need to be fetched from the provider.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherLocation" + } + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "minLength": 1, + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "minLength": 1, + "type": "string" + }, + "language": { + "description": "Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'.", + "type": "string" + }, + "startTimeHours": { + "format": "int32", + "description": "Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "endTimeHours": { + "format": "int32", + "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.)", + "type": "integer" + }, + "units": { + "description": "Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units.", + "minLength": 1, + "type": "string" + }, + "additionalParams": { + "$ref": "#/definitions/AdditionalProviderParameters" + } + } + }, + "WeatherDataProviderResponse": { + "description": "Schema of Weather Data Provider Response.", + "required": [ + "weatherMetadata" + ], + "type": "object", + "properties": { + "weatherMetadata": { + "$ref": "#/definitions/WeatherMetadata" + }, + "status": { + "description": "Indicates a Succeeded, Failed, or PartiallySucceeded response.", + "enum": [ + "Succeeded", + "Failed", + "PartiallySucceeded" + ], + "type": "string", + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "locations": { + "description": "List of weather data for all the weather locations.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherLocationData" + } + }, + "errors": { + "$ref": "#/definitions/WeatherDataErrors" + } + } + }, + "WeatherLocation": { + "description": "Schema of Location data.", + "required": [ + "type", + "value" + ], + "type": "object", + "properties": { + "type": { + "description": "Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey.", + "maxLength": 25, + "minLength": 2, + "enum": [ + "LatLong", + "IataCode", + "IcaoCode", + "PlaceId", + "PostalKey" + ], + "type": "string", + "x-ms-enum": { + "name": "LocationType", + "modelAsString": true + } + }, + "value": { + "description": "Location Value eg. \"10,-25\" for LocationType Type \"LatLong\".", + "minLength": 1, + "type": "string" + } + } + }, + "WeatherLocationData": { + "description": "Schema of WeatherLocationData data.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/WeatherLocation" + }, + "requestCompletionTime": { + "description": "Request Completion Time in Utc of the location.", + "type": "string" + }, + "lastRefreshedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "data": { + "$ref": "#/definitions/WeatherDataForPassthrough" + } + } + }, + "WeatherMetadata": { + "description": "Schema of Weather Metadata.", + "required": [ + "extensionApiName", + "extensionId", + "extensionVersion", + "units", + "weatherDataType" + ], + "type": "object", + "properties": { + "extensionVersion": { + "description": "Version of the weather data extension.", + "minLength": 1, + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "minLength": 1, + "type": "string" + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "minLength": 1, + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "minLength": 1, + "type": "string" + }, + "language": { + "description": "Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'.", + "type": "string" + }, + "startTimeHours": { + "format": "int32", + "description": "Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "endTimeHours": { + "format": "int32", + "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.)", + "type": "integer" + }, + "units": { + "description": "Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units.", + "minLength": 1, + "type": "string" + }, + "additionalParams": { + "$ref": "#/definitions/AdditionalProviderParameters" + } + } + }, + "Zone": { + "description": "Api Model for Zone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the Zone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the Zone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "managementZoneId": { + "description": "Management Zone Id associated with the Zone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ZoneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Zone" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "Bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before." + } + }, + "security": [ + { + "Bearer": [] + } + ] +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..d816d19597d3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "ApplicationData123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationapplicationdata' resource with id 'ApplicationData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "ApplicationData123", + "resourceType": "farmoperationapplicationdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_CreateOrUpdate.json new file mode 100644 index 000000000000..218f93868ed5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_CreateOrUpdate.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-06-01-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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_Delete.json new file mode 100644 index 000000000000..613d0fcc371d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_Get.json new file mode 100644 index 000000000000..df1c01d91dc1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2020-12-31T11:10:21Z", + "modifiedDateTime": "2020-12-31T11:10:21Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..3e7736d5b121 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "ApplicationData123", + "resourceType": "farmoperationapplicationdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_List.json new file mode 100644 index 000000000000..175215fd9348 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/ApplicationData_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_ListByPartyId.json new file mode 100644 index 000000000000..f22c8c8e6ae6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ApplicationData_ListByPartyId.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partytId}}/applicationData/{{applicationDataId}}?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/2023-06-01-preview/examples/Attachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_CreateOrUpdate.json new file mode 100644 index 000000000000..88275ae66e67 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-06-01-preview", + "file": "101010101" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Delete.json new file mode 100644 index 000000000000..15583d074859 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Download.json new file mode 100644 index 000000000000..4d738d1abdb4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Get.json new file mode 100644 index 000000000000..29d735b6b256 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_ListByPartyId.json new file mode 100644 index 000000000000..d877839d8a07 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Attachments_ListByPartyId.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's attachment", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/attachments/{{attachmentId}}?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/2023-06-01-preview/examples/Boundaries_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..ab902deaf706 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "BOUNDARY123", + "resourceType": "boundary" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_CreateOrUpdate.json new file mode 100644 index 000000000000..fe8eec9a1f2d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_CreateOrUpdate.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "api-version": "2023-06-01-preview", + "boundary": { + "parentId": "FIELD123", + "parentType": "Field", + "type": "string", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + }, + "responses": { + "200": { + "body": { + "parentId": "FIELD123", + "parentType": "Field", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "type": "string", + "crs": "WGS84", + "centroid": { + "type": "Point", + "coordinates": [ + 73.70711478791443, + 20.54418916247634 + ] + }, + "bbox": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70448589324951, + 20.541688176010233 + ], + [ + 73.70448589324951, + 20.546992723579137 + ], + [ + 73.71023654937744, + 20.546992723579137 + ], + [ + 73.71023654937744, + 20.541688176010233 + ] + ] + ] + }, + "area": { + "unit": "Acre", + "value": 60.405 + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + }, + "201": { + "body": { + "parentId": "FIELD123", + "parentType": "Field", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "type": "string", + "crs": "WGS84", + "centroid": { + "type": "Point", + "coordinates": [ + 73.70711478791443, + 20.54418916247634 + ] + }, + "bbox": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70448589324951, + 20.541688176010233 + ], + [ + 73.70448589324951, + 20.546992723579137 + ], + [ + 73.71023654937744, + 20.546992723579137 + ], + [ + 73.71023654937744, + 20.541688176010233 + ] + ] + ] + }, + "area": { + "unit": "Acre", + "value": 60.405 + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Delete.json new file mode 100644 index 000000000000..3454b83e23d2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Get.json new file mode 100644 index 000000000000..063bb7466f6e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "parentId": "FIELD123", + "parentType": "Field", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "type": "string", + "crs": "WGS84", + "centroid": { + "type": "Point", + "coordinates": [ + 73.70711478791443, + 20.54418916247634 + ] + }, + "bbox": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70448589324951, + 20.541688176010233 + ], + [ + 73.70448589324951, + 20.546992723579137 + ], + [ + 73.71023654937744, + 20.546992723579137 + ], + [ + 73.71023654937744, + 20.541688176010233 + ] + ] + ] + }, + "area": { + "unit": "Acre", + "value": 60.405 + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d50d91133e2d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "BOUNDARY123", + "resourceType": "boundary" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_GetOverlap.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_GetOverlap.json new file mode 100644 index 000000000000..5a9e336894fc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_GetOverlap.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "otherPartyId": "PARTY456", + "otherBoundaryId": "BOUNDARY56", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "boundaryArea": 35, + "otherBoundaryArea": 25, + "intersectingArea": 10 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_List.json new file mode 100644 index 000000000000..aa1b19c08567 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "parentId": "FIELD123", + "parentType": "Field", + "area": { + "unit": "Acre", + "value": 60.405 + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/Boundaries_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_ListByPartyId.json new file mode 100644 index 000000000000..592cf9b60bb5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_ListByPartyId.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "parentId": "FIELD123", + "parentType": "Field", + "area": { + "unit": "Acre", + "value": 60.405 + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/boundaries/?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/2023-06-01-preview/examples/Boundaries_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Search.json new file mode 100644 index 000000000000..438b6033ef9e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_Search.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "searchBoundaryQuery": { + "ids": [ + "BOUNDARY123" + ], + "names": [ + "John Smith's Boundary" + ], + "propertyFilters": [ + "RetailerId" + ], + "statuses": [ + "Active" + ], + "minCreatedDateTime": "2021-04-22T12:53:39Z", + "maxCreatedDateTime": "2021-04-22T12:53:39Z", + "minLastModifiedDateTime": "2021-04-22T12:53:39Z", + "maxLastModifiedDateTime": "2021-04-22T12:53:39Z", + "maxPageSize": 50, + "skipToken": "string", + "parentType": "Field", + "parentIds": [ + "FIELD123" + ], + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 10.98958969116211, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.284911882713146 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "parentId": "FIELD123", + "parentType": "Field", + "area": { + "unit": "Acre", + "value": 60.405 + }, + "name": "John Smith's Boundary", + "description": "Some description" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/Boundaries_SearchByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_SearchByPartyId.json new file mode 100644 index 000000000000..225806bfffce --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Boundaries_SearchByPartyId.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview", + "searchBoundaryQuery": { + "ids": [ + "BOUNDARY123" + ], + "names": [ + "John Smith's Boundary" + ], + "propertyFilters": [ + "RetailerId" + ], + "statuses": [ + "Active" + ], + "minCreatedDateTime": "2021-04-22T12:53:39Z", + "maxCreatedDateTime": "2021-04-22T12:53:39Z", + "minLastModifiedDateTime": "2021-04-22T12:53:39Z", + "maxLastModifiedDateTime": "2021-04-22T12:53:39Z", + "maxPageSize": 50, + "skipToken": "string", + "parentType": "Field", + "parentIds": [ + "FIELD123" + ], + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 10.98958969116211, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.284911882713146 + ], + [ + 11.004695892333984, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.29360722000945 + ], + [ + 10.98958969116211, + 45.284911882713146 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "John Smith's Boundary", + "description": "Some description", + "source": "source", + "parentId": "FIELD123", + "parentType": "Field", + "area": { + "unit": "Acre", + "value": 60.405 + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/boundaries?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/2023-06-01-preview/examples/CropProducts_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_CreateOrUpdate.json new file mode 100644 index 000000000000..4d1a1b30f69a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_CreateOrUpdate.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "cropIds": [ + "CORN123" + ], + "cropProductId": "SEED123", + "cropProduct": { + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "cropIds": [ + "CORN123" + ], + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEED123", + "cropIds": [ + "CORN123" + ], + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_Delete.json new file mode 100644 index 000000000000..6eb2f0b2f64b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "cropId": "CORN123", + "cropProductId": "SEED123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_Get.json new file mode 100644 index 000000000000..13b87c1d9b41 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "cropId": "CORN123", + "cropProductId": "SEED123" + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_List.json new file mode 100644 index 000000000000..c9a68dedea18 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/CropProducts_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEED123", + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/crop-products/{{cropProductId}}?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/2023-06-01-preview/examples/Crops_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_CreateOrUpdate.json new file mode 100644 index 000000000000..1af6e529ded1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_CreateOrUpdate.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "cropId": "CORN123", + "crop": { + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_Delete.json new file mode 100644 index 000000000000..c1ca4eec6562 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "cropId": "CORN123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_Get.json new file mode 100644 index 000000000000..07f71b1924e5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "cropId": "CORN123" + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_List.json new file mode 100644 index 000000000000..4d7deecaf034 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Crops_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/DeviceDataModels_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_CreateOrUpdate.json new file mode 100644 index 000000000000..539e35fb910d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124", + "api-version": "2023-06-01-preview", + "deviceDataModelObject": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "status": "new", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:52:16Z", + "eTag": "7f00bf76-0000-0700-0000-61ea82500000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_Delete.json new file mode 100644 index 000000000000..adc845271d72 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_Get.json new file mode 100644 index 000000000000..e539a4763bac --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124" + }, + "responses": { + "200": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_List.json new file mode 100644 index 000000000000..cb0a340200bf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/DeviceDataModels_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?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/2023-06-01-preview/examples/Devices_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_CreateOrUpdate.json new file mode 100644 index 000000000000..e740a5e6e99f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceId": "d124", + "api-version": "2023-06-01-preview", + "deviceDetails": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "status": "new device", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d123", + "status": "new device", + "createdDateTime": "2022-01-24T06:20:47Z", + "modifiedDateTime": "2022-01-24T06:21:07Z", + "eTag": "0401a5cc-0000-0700-0000-61ee45540000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d123", + "status": "new device", + "createdDateTime": "2022-01-24T06:20:47Z", + "modifiedDateTime": "2022-01-24T06:20:47Z", + "eTag": "0401baca-0000-0700-0000-61ee453f0000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_Delete.json new file mode 100644 index 000000000000..65ba3d278147 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceId": "d124", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_Get.json new file mode 100644 index 000000000000..96fa5286f174 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1", + "deviceId": "d124" + }, + "responses": { + "200": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d124", + "status": "new device", + "createdDateTime": "2022-01-24T06:22:41Z", + "modifiedDateTime": "2022-01-24T06:22:43Z", + "eTag": "04010fd5-0000-0700-0000-61ee45b30000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_List.json new file mode 100644 index 000000000000..78b30a7960a6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Devices_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d124", + "status": "new device", + "createdDateTime": "2022-01-24T06:22:41Z", + "modifiedDateTime": "2022-01-24T06:22:43Z", + "eTag": "04010fd5-0000-0700-0000-61ee45b30000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?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/2023-06-01-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/FarmOperations_CreateDataIngestionJob.json new file mode 100644 index 000000000000..1c0139caa2bc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/FarmOperations_CreateDataIngestionJob.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "partyId": "TEST-PARTY", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "startYear": 2012, + "name": "Farm Operations Job", + "description": "For TEST-PARTY", + "properties": { + "Operation": "All" + } + } + }, + "responses": { + "202": { + "body": { + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "durationInSeconds": 14.79, + "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7", + "status": "Waiting", + "message": "string", + "createdDateTime": "2021-03-15T07:14:14Z", + "lastActionDateTime": "2021-03-15T07:14:14Z", + "startTime": "2021-03-15T07:14:14Z", + "endTime": "2021-03-15T07:14:14Z", + "name": "Farm Operations Job", + "description": "For TEST-PARTY", + "properties": { + "Operation": "All" + }, + "partyId": "TEST-PARTY", + "authProviderId": "JOHNDEERE" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..a6194e98199c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "durationInSeconds": 11.2, + "id": "farm-operations-job", + "status": "Succeeded", + "message": "string", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "Farm operations Job", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "partyId": "PARTY123", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..723fb8c61faf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_CreateOrUpdate.json new file mode 100644 index 000000000000..11d7d94095c5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-06-01-preview", + "farm": { + "status": "Active", + "name": "John Smith's Farm", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_Delete.json new file mode 100644 index 000000000000..d730342a4980 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_Get.json new file mode 100644 index 000000000000..9aafec831650 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "farmId": "FARM123" + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..6a765910f2e2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_List.json new file mode 100644 index 000000000000..5008906217ee --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/Farms_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_ListByPartyId.json new file mode 100644 index 000000000000..cc15bae61e7c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Farms_ListByPartyId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/farms/{{farmId}}?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/2023-06-01-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..6a6ba61b055c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_CreateOrUpdate.json new file mode 100644 index 000000000000..0861de8df307 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-06-01-preview", + "field": { + "farmId": "FARM123", + "status": "Active", + "name": "John Smith's Field", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_Delete.json new file mode 100644 index 000000000000..97b52d254914 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_Get.json new file mode 100644 index 000000000000..f32cca19b4a9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "fieldId": "FIELD123" + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d71e3b525342 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_List.json new file mode 100644 index 000000000000..5ecc3f5bac61 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/Fields_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_ListByPartyId.json new file mode 100644 index 000000000000..737e3f71e0a2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Fields_ListByPartyId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/Fields/{{FieldId}}?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/2023-06-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..f43720c8fd74 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "harvestDataId": "HarvestData123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationharvestdata' resource with id 'HarvestData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "HarvestData123", + "resourceType": "farmoperationharvestdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_CreateOrUpdate.json new file mode 100644 index 000000000000..7a71a8f2b9e4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_CreateOrUpdate.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_Delete.json new file mode 100644 index 000000000000..473c3cba33fd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_Get.json new file mode 100644 index 000000000000..8878ab7f48c4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..2953f9e3cc1f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 15, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "HarvestData123", + "resourceType": "farmoperationharvestdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_List.json new file mode 100644 index 000000000000..4e750a696b59 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_List.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-04-21T06:49:30Z", + "operationEndDateTime": "2021-04-21T06:49:30Z", + "operationModifiedDateTime": "2021-04-21T06:49:30Z", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/HarvestData_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_ListByPartyId.json new file mode 100644 index 000000000000..43ce2ff4548d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/HarvestData_ListByPartyId.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ImageProcessing_CreateRasterizeJob.json new file mode 100644 index 000000000000..d3e7a00f1a24 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ImageProcessing_CreateRasterizeJob.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ] + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ], + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ImageProcessing_GetRasterizeJob.json new file mode 100644 index 000000000000..0b7eb8896fe7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ImageProcessing_GetRasterizeJob.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ], + "id": "string", + "status": "string", + "durationInSeconds": 15, + "message": "string", + "createdDateTime": "2021-05-03T08:51:04.744Z", + "lastActionDateTime": "2021-05-03T08:51:04.744Z", + "startTime": "2021-05-03T08:51:04.744Z", + "endTime": "2021-05-03T08:51:04.744Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_CreateOrUpdate.json new file mode 100644 index 000000000000..3f9af1beb278 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "partyId": "pjparty", + "modelId": "modelId", + "insightId": "insightId", + "insightAttachmentId": "insightAttachmentId", + "resourceId": "farmId", + "resourceType": "Farm", + "api-version": "2023-06-01-preview", + "body": { + "insightId": "insightId", + "resourceId": "farmId", + "resourceType": "Farm", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + }, + "responses": { + "200": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + }, + "201": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Delete.json new file mode 100644 index 000000000000..5e68cf5b0630 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "partyId": "PARTY123", + "modelId": "modelId", + "insightAttachmentId": "insightAttachmentId", + "resourceId": "resourceId", + "resourceType": "Farm", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Download.json new file mode 100644 index 000000000000..87983a4f5a15 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Download.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightAttachmentId": "ATTACHMENT123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Get.json new file mode 100644 index 000000000000..937411aabbff --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightAttachmentId": "insightAttachmentId" + }, + "responses": { + "200": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json new file mode 100644 index 000000000000..e10d18c7caa7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments?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/2023-06-01-preview/examples/Insights_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..c63ed5c3d1d3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_CreateCascadeDeleteJob.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightId": "insightId", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_CreateOrUpdate.json new file mode 100644 index 000000000000..15c9d010d718 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "partyId": "pjparty", + "modelId": "BiomassModelId", + "insightId": "insightId", + "resourceId": "farmId", + "resourceType": "Farm", + "api-version": "2023-06-01-preview", + "insightData": { + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54.043Z", + "insightEndDateTime": "2021-07-26T09:31:54.043Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_Delete.json new file mode 100644 index 000000000000..d700940d11dc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "partyId": "PARTY123", + "modelId": "modelId", + "insightId": "insightId", + "resourceId": "resourceId", + "resourceType": "Farm", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_Get.json new file mode 100644 index 000000000000..7aefe2699a99 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightId": "insightId" + }, + "responses": { + "200": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d5d4c1a11bbe --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json new file mode 100644 index 000000000000..2c81d4914473 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/insights?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/2023-06-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..1c33212f582e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "MANAGEMENTZONE123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "MANAGEMENTZONE123", + "resourceType": "managementzone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_CreateOrUpdate.json new file mode 100644 index 000000000000..86893f606b7b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123", + "api-version": "2023-06-01-preview", + "managementZone": { + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "status": "Active", + "name": "John Smith's ManagementZone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_Delete.json new file mode 100644 index 000000000000..daf9e98d2bb2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_Get.json new file mode 100644 index 000000000000..f8725fb1fca1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d05e866f46e2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "MANAGEMENTZONE123", + "resourceType": "managementzone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_List.json new file mode 100644 index 000000000000..444515a0ab82 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/management-zones?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/2023-06-01-preview/examples/ManagementZones_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_ListByPartyId.json new file mode 100644 index 000000000000..a7baf4bee955 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ManagementZones_ListByPartyId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/management-zones?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/2023-06-01-preview/examples/ModelInference_CreateBiomassModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateBiomassModelJob.json new file mode 100644 index 000000000000..efb8e8dac204 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateBiomassModelJob.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "cropName": "string", + "plantingStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "weatherExtensionId": "DTN.ClearAg", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF" + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "cropName": "string", + "plantingStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "weatherExtensionId": "DTN.ClearAg", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateSensorPlacementModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateSensorPlacementModelJob.json new file mode 100644 index 000000000000..8bb44903e5e7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateSensorPlacementModelJob.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorType": "SoilMoisture", + "isRanked": true + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorType": "SoilMoisture", + "isRanked": true, + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateSoilMoistureModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateSoilMoistureModelJob.json new file mode 100644 index 000000000000..47b7d16bdea7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_CreateSoilMoistureModelJob.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "sensorDataModelId": "string", + "sensorPartnerId": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorDefinition": { + "sensorMeasurement": "string", + "minProperty": "string", + "maxProperty": "string" + }, + "imageResolution": 10, + "imageFormat": "TIF" + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "sensorDataModelId": "string", + "sensorPartnerId": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF", + "sensorDefinition": { + "sensorMeasurement": "string", + "minProperty": "string", + "maxProperty": "string" + }, + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetBiomassModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetBiomassModelJob.json new file mode 100644 index 000000000000..d621b31bc3e0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetBiomassModelJob.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 52.4, + "id": "biomass-job", + "status": "Succeeded", + "message": "Successfully calculated biomass feature in the given date range and created relevant Insight(s) and InsightAttachment(s).", + "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": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "cropName": "string", + "plantingStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "weatherExtensionId": "DTN.ClearAg", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetSensorPlacementModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetSensorPlacementModelJob.json new file mode 100644 index 000000000000..70595a79484a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetSensorPlacementModelJob.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 52.4, + "id": "sensor-placement-job", + "status": "Succeeded", + "message": "Successfully created sensor placement map for the given date range and created relevant Insight(s) and InsightAttachment(s).", + "createdDateTime": "2021-12-16T08:24:50Z", + "lastActionDateTime": "2021-12-16T08:24:50Z", + "startTime": "2021-12-16T08:24:50Z", + "endTime": "2021-12-16T08:24:50Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorType": "SoilMoisture", + "isRanked": true + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetSoilMoistureModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetSoilMoistureModelJob.json new file mode 100644 index 000000000000..3c1bc5df2be2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/ModelInference_GetSoilMoistureModelJob.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 52.4, + "id": "biomass-job", + "status": "Succeeded", + "message": "Successfully calculated soil moisture feature in the given date range and created relevant Insight(s) and InsightAttachment(s).", + "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": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "partyId": "string", + "boundaryId": "string", + "modelVersion": "string", + "sensorDataModelId": "string", + "sensorPartnerId": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorDefinition": { + "sensorMeasurement": "string", + "minProperty": "string", + "maxProperty": "string" + }, + "imageResolution": 10, + "imageFormat": "TIF" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json new file mode 100644 index 000000000000..a8c96ef7694d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123", + "api-version": "2023-06-01-preview", + "nutrientAnalysis": { + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "status": "Active", + "name": "John Smith's Nutrient Analysis", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_Delete.json new file mode 100644 index 000000000000..bffbbdc0661c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_Get.json new file mode 100644 index 000000000000..b9802fa687db --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_List.json new file mode 100644 index 000000000000..a7bfcb7f16f8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/nutrient-analyses?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/2023-06-01-preview/examples/NutrientAnalyses_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_ListByPartyId.json new file mode 100644 index 000000000000..257aaa65fe7f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/NutrientAnalyses_ListByPartyId.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's Nutrient analysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/nutrient-analyses?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/2023-06-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0fd94ebf8611 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "oauthProviderId": "OAuthProvider123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "oauthProviderId": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthprovider' resource with id 'OAuthProvider123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_CreateOrUpdate.json new file mode 100644 index 000000000000..40b3ee21169c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-06-01-preview", + "oauthProvider": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + }, + "201": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_Delete.json new file mode 100644 index 000000000000..432d79ec2b51 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_Get.json new file mode 100644 index 000000000000..e82bc13b4fba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Party": "123" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..a412de874d83 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "oauthProviderId": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_List.json new file mode 100644 index 000000000000..42d40e86b829 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthProviders_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Party": "123" + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0b35b4b6d5ea --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "oauthProviderId": "OAUTHPROVIDER123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'OAUTHPROVIDER123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "OAUTHPROVIDER123", + "resourceType": "oauthtokeninfo" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..294723dfd40a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "OAUTHPROVIDER123", + "resourceType": "oauthtokeninfo" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json new file mode 100644 index 000000000000..1e003b121aa0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "oauthConnectRequest": { + "partyId": "PARTY123", + "oAuthProviderId": "JOHNDEERE", + "userRedirectLink": "https://docs.microsoft.com", + "userRedirectState": "code" + } + }, + "responses": { + "200": { + "body": "Connection string" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_List.json new file mode 100644 index 000000000000..702061f40f89 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/OAuthTokens_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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/parties/{{partyId}}/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/2023-06-01-preview/examples/Parties_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..44a54b75da4f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "party" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_CreateOrUpdate.json new file mode 100644 index 000000000000..0e8f2a9ccaa1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview", + "party": { + "status": "Active", + "name": "John Smith", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_Delete.json new file mode 100644 index 000000000000..ae69ad81cfa4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_Get.json new file mode 100644 index 000000000000..e237661d1f77 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123" + }, + "responses": { + "200": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..fc525d27f1bb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "party" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_List.json new file mode 100644 index 000000000000..ab24fb44c696 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Parties_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}?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/2023-06-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..b8ae97146f4b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PlantTissueAnalysis123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'planttissueanalysis' resource with id 'PlantTissueAnalysis123' and partyId 'PARTY123'.", + "createdDateTime": "2021-07-19T11:31:20Z", + "lastActionDateTime": "2021-07-19T11:31:34Z", + "startTime": "2021-07-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantTissueAnalysis123", + "resourceType": "planttissueanalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json new file mode 100644 index 000000000000..ab5ce4cf5bd9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSIS123", + "api-version": "2023-06-01-preview", + "plantTissueAnalysis": { + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2022-05-11T07:00:10Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "status": "Active", + "name": "John Smith's ManagementZone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantTissueAnalysisId}}&resourceTypes=PlantTissueAnalysis" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantTissueAnalysisId}}&resourceTypes=PlantTissueAnalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_Delete.json new file mode 100644 index 000000000000..e74905ee13bb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSES123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_Get.json new file mode 100644 index 000000000000..d1a5380e0869 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSES123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantTissueAnalysisId}}&resourceTypes=PlantTissueAnalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..e5ac53d3b5f9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-07-19T11:31:20Z", + "lastActionDateTime": "2021-07-19T11:31:34Z", + "startTime": "2021-07-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantTissueAnalysis123", + "resourceType": "planttissueanalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_List.json new file mode 100644 index 000000000000..07cf32aae4e2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantTissueAnalysisId}}&resourceTypes=PlantTissueAnalysis" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/plant-tissue-analyses?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/2023-06-01-preview/examples/PlantTissueAnalyses_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_ListByPartyId.json new file mode 100644 index 000000000000..d728e13be014 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantTissueAnalyses_ListByPartyId.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "attachmentsLink": "https://.farmbeats.azure.net/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantTissueAnalysisId}}&resourceTypes=PlantTissueAnalysis" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/plant-tissue-analyses?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/2023-06-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..5da17c60da87 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantingDataId": "PlantingData123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationplantingdata' resource with id 'PlantingData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantingData123", + "resourceType": "farmoperationplantingdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_CreateOrUpdate.json new file mode 100644 index 000000000000..fbbeceb061bd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_CreateOrUpdate.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_Delete.json new file mode 100644 index 000000000000..7b3ba466dadd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_Get.json new file mode 100644 index 000000000000..e19c635bffa9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..340f141c6248 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantingData123", + "resourceType": "farmoperationplantingdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_List.json new file mode 100644 index 000000000000..acfa15e870a2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/PlantingData_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_ListByPartyId.json new file mode 100644 index 000000000000..fd33c0752857 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PlantingData_ListByPartyId.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0bb178c7723c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTIONMAP123", + "resourceType": "prescriptionmap" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json new file mode 100644 index 000000000000..44ebaa574100 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-06-01-preview", + "prescriptionMap": { + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "status": "Active", + "name": "John Smith's Prescription map", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_Delete.json new file mode 100644 index 000000000000..c6e29c5fd9cb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_Get.json new file mode 100644 index 000000000000..5783c3bf06cb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123" + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..bbe2ae7a8417 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTIONMAP123", + "resourceType": "prescriptionmap" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_List.json new file mode 100644 index 000000000000..5fe523860a03 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/prescription-maps?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/2023-06-01-preview/examples/PrescriptionMaps_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_ListByPartyId.json new file mode 100644 index 000000000000..fe9f5d78345c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/PrescriptionMaps_ListByPartyId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/prescription-maps?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/2023-06-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..456da8ec597f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTION123", + "resourceType": "prescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..b326e06ebb6f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_CreateOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-06-01-preview", + "prescription": { + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "status": "Active", + "name": "John Smith's Prescription", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_Delete.json new file mode 100644 index 000000000000..996b2e12f598 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_Get.json new file mode 100644 index 000000000000..1649b12723dc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123" + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..3e47d3ae5bce --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTION123", + "resourceType": "prescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_List.json new file mode 100644 index 000000000000..2d4e0bbdb9fd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/prescriptions?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/2023-06-01-preview/examples/Prescriptions_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_ListByPartyId.json new file mode 100644 index 000000000000..ce32a84df6f2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Prescriptions_ListByPartyId.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/prescriptions?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/2023-06-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json new file mode 100644 index 000000000000..518c0c372337 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "boundaryId": "BOUNDARY123", + "partyId": "PARTY123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "SentinelHub", + "credential": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "source": "Sentinel_2_L2A", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + }, + "properties": { + "Region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": 12.4, + "id": "satellite-job", + "status": "Created", + "message": "Created job 'satellite-job' to fetch satellite data for boundary 'BOUNDARY123' for startDate '01/01/2019 00:00:00' and endDate '03/30/2019 00:00:00' (both inclusive)", + "createdDateTime": "2021-04-16T07:56:05Z", + "lastActionDateTime": "2021-04-16T07:56:05Z", + "startDateTime": "2021-04-16T07:56:05Z", + "endDateTime": "2021-04-16T07:56:05Z", + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "credential": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "string", + "keyName": "string", + "keyVersion": "string" + } + }, + "source": "Sentinel_2_L2A", + "provider": "SentinelHub", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_Download.json new file mode 100644 index 000000000000..4ea53fac58d4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_Download.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "filePath": "https://filePath", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json new file mode 100644 index 000000000000..da5c3bfbf3a3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-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", + "partyId": "PARTY123", + "credential": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_List.json new file mode 100644 index 000000000000..433b4666e7bf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_List.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "provider": "Microsoft", + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "source": "Sentinel_2_L2A", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "400e200f-ccc4-0cea-c120-3fdc6a41f99f", + "sceneDateTime": "2019-01-27T00:00:00Z", + "boundaryId": "BOUNDARY123", + "partyId": "PARTY123", + "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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/clp_10.tif" + }, + { + "name": "NDVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/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=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/evi_10.tif" + }, + { + "name": "B12", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b12_10.tif" + } + ] + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/scenes?provider=Microsoft&partyId=PARTY123&boundaryId=BOUNDARY123&api-version=2020-10-16-preview&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1PTnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAdOfBwAAAAAA7Z8HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_SearchFeatures.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_SearchFeatures.json new file mode 100644 index 000000000000..7056a4fb50c9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Scenes_SearchFeatures.json @@ -0,0 +1,449 @@ +{ + "parameters": { + "collectionId": "Sentinel_2_L2A", + "maxpagesize": 2, + "skip": 15, + "api-version": "2023-06-01-preview", + "searchFeaturesQuery": { + "credential": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "startDateTime": "2022-01-26T14:53:23.825Z", + "endDateTime": "2023-01-26T14:53:23.825Z", + "intersects": { + "type": "Polygon", + "coordinates": [ + [ + [ + 7.662878883920398, + 47.845905986476225 + ], + [ + 7.687601396600625, + 46.85818510350441 + ], + [ + 9.12804406196848, + 46.86563725992561 + ], + [ + 9.130456971517189, + 47.85361872819965 + ], + [ + 7.662878883920398, + 47.845905986476225 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "features": [ + { + "stacVersion": "0.9.0", + "stacExtensions": [ + "eo", + "projection" + ], + "id": "S2B_MSIL2A_20230121T102239_N0509_R065_T32UMU_20230121T113700", + "type": "Feature", + "geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:OGC::CRS84" + } + }, + "coordinates": [ + [ + [ + [ + 8.463630109874195, + 48.75175579972667 + ], + [ + 8.09718328627216, + 47.761624720018254 + ], + [ + 9.130235487170578, + 47.76510167563715 + ], + [ + 9.13276898152643, + 48.75292752793247 + ], + [ + 8.463630109874195, + 48.75175579972667 + ] + ] + ] + ] + }, + "bbox": [ + 8.09718328627216, + 47.761624720018254, + 9.13276898152643, + 48.75292752793247 + ], + "properties": { + "datetime": "2023-01-21T10:27:32Z", + "platform": "sentinel-2b", + "instruments": [ + "msi" + ], + "constellation": "sentinel-2", + "eo:gsd": 10, + "eo:cloud_cover": 80.46, + "eo:bands": [ + { + "name": "B01", + "common_name": "coastal", + "center_wavelength": 0.4427, + "full_width_half_max": 0.021 + }, + { + "name": "B02", + "common_name": "blue", + "center_wavelength": 0.4924, + "full_width_half_max": 0.066 + }, + { + "name": "B03", + "common_name": "green", + "center_wavelength": 0.5598, + "full_width_half_max": 0.036 + }, + { + "name": "B04", + "common_name": "red", + "center_wavelength": 0.6646, + "full_width_half_max": 0.031 + }, + { + "name": "B05", + "center_wavelength": 0.7041, + "full_width_half_max": 0.015 + }, + { + "name": "B06", + "center_wavelength": 0.7405, + "full_width_half_max": 0.015 + }, + { + "name": "B07", + "center_wavelength": 0.7828, + "full_width_half_max": 0.02 + }, + { + "name": "B08", + "common_name": "nir", + "center_wavelength": 0.8328, + "full_width_half_max": 0.106 + }, + { + "name": "B8A", + "common_name": "nir08", + "center_wavelength": 0.8647, + "full_width_half_max": 0.021 + }, + { + "name": "B09", + "common_name": "nir09", + "center_wavelength": 0.9451, + "full_width_half_max": 0.02 + }, + { + "name": "B11", + "common_name": "swir16", + "center_wavelength": 1.6137, + "full_width_half_max": 0.091 + }, + { + "name": "B12", + "common_name": "swir22", + "center_wavelength": 2.2024, + "full_width_half_max": 0.175 + } + ], + "proj:epsg": 32632, + "proj:bbox": [ + 399960, + 5290200, + 509760, + 5400000 + ], + "proj:geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:EPSG::32632" + } + }, + "coordinates": [ + [ + [ + [ + 460574.0276522319, + 5399999.00024835 + ], + [ + 432344.5418597979, + 5290201.00021934 + ], + [ + 509758.99999999994, + 5290201.000219454 + ], + [ + 509759, + 5399999.000248388 + ], + [ + 460574.0276522319, + 5399999.00024835 + ] + ] + ] + ] + } + }, + "links": [ + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a/items/S2B_MSIL2A_20230121T102239_N0509_R065_T32UMU_20230121T113700", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a", + "rel": "parent" + }, + { + "href": "https://scihub.copernicus.eu/dhus/odata/v1/Products('ece4b170-065b-4d3c-a005-9c20b8f383fe')/$value", + "rel": "derived_from", + "title": "scihub download" + } + ], + "assets": { + "thumbnail": { + "href": "https://roda.sentinel-hub.com/sentinel-s2-l1c/tiles/32/T/MT/2023/1/4/0/preview.jpg", + "title": "thumbnail", + "type": "image/png" + } + } + }, + { + "stacVersion": "0.9.0", + "stacExtensions": [ + "eo", + "projection" + ], + "id": "S2B_MSIL2A_20230121T102239_N0509_R065_T32UNU_20230121T113700", + "type": "Feature", + "geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:OGC::CRS84" + } + }, + "coordinates": [ + [ + [ + [ + 8.999741508947052, + 48.753004006975516 + ], + [ + 8.999746441483957, + 47.76517556280485 + ], + [ + 10.46477378099951, + 47.7558278091967 + ], + [ + 10.493255611543965, + 48.743328406398774 + ], + [ + 8.999741508947052, + 48.753004006975516 + ] + ] + ] + ] + }, + "bbox": [ + 8.999741508947052, + 47.7558278091967, + 10.493255611543965, + 48.753004006975516 + ], + "properties": { + "datetime": "2023-01-21T10:27:28Z", + "platform": "sentinel-2b", + "instruments": [ + "msi" + ], + "constellation": "sentinel-2", + "eo:gsd": 10, + "eo:cloud_cover": 95.46, + "eo:bands": [ + { + "name": "B01", + "common_name": "coastal", + "center_wavelength": 0.4427, + "full_width_half_max": 0.021 + }, + { + "name": "B02", + "common_name": "blue", + "center_wavelength": 0.4924, + "full_width_half_max": 0.066 + }, + { + "name": "B03", + "common_name": "green", + "center_wavelength": 0.5598, + "full_width_half_max": 0.036 + }, + { + "name": "B04", + "common_name": "red", + "center_wavelength": 0.6646, + "full_width_half_max": 0.031 + }, + { + "name": "B05", + "center_wavelength": 0.7041, + "full_width_half_max": 0.015 + }, + { + "name": "B06", + "center_wavelength": 0.7405, + "full_width_half_max": 0.015 + }, + { + "name": "B07", + "center_wavelength": 0.7828, + "full_width_half_max": 0.02 + }, + { + "name": "B08", + "common_name": "nir", + "center_wavelength": 0.8328, + "full_width_half_max": 0.106 + }, + { + "name": "B8A", + "common_name": "nir08", + "center_wavelength": 0.8647, + "full_width_half_max": 0.021 + }, + { + "name": "B09", + "common_name": "nir09", + "center_wavelength": 0.9451, + "full_width_half_max": 0.02 + }, + { + "name": "B11", + "common_name": "swir16", + "center_wavelength": 1.6137, + "full_width_half_max": 0.091 + }, + { + "name": "B12", + "common_name": "swir22", + "center_wavelength": 2.2024, + "full_width_half_max": 0.175 + } + ], + "proj:epsg": 32632, + "proj:bbox": [ + 499980, + 5290200, + 609780, + 5400000 + ], + "proj:geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:EPSG::32632" + } + }, + "coordinates": [ + [ + [ + [ + 499981, + 5399999.000248392 + ], + [ + 499981, + 5290201.000219455 + ], + [ + 609779.0000024929, + 5290201.000219092 + ], + [ + 609779.0000028561, + 5399999.000247997 + ], + [ + 499981, + 5399999.000248392 + ] + ] + ] + ] + } + }, + "links": [ + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a/items/S2B_MSIL2A_20230121T102239_N0509_R065_T32UNU_20230121T113700", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a", + "rel": "parent" + }, + { + "href": "https://scihub.copernicus.eu/dhus/odata/v1/Products('986643df-22f1-4c6b-be20-7db66ecbc699')/$value", + "rel": "derived_from", + "title": "scihub download" + } + ], + "assets": { + "thumbnail": { + "href": "https://roda.sentinel-hub.com/sentinel-s2-l1c/tiles/32/T/MT/2023/1/4/0/preview.jpg", + "title": "thumbnail", + "type": "image/png" + } + } + } + ], + "nextLink": "https://{{resourceName}}.farmbeats.azure.net//scenes/stac-collections/Sentinel_2_L2A:search?api-version={{apiVersion}}&maxpagesize=2&skip=17" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..e807feb5cb72 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_CreateOrUpdate.json new file mode 100644 index 000000000000..381e520378cd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-06-01-preview", + "seasonalField": { + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_Delete.json new file mode 100644 index 000000000000..9990dced82ba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_Get.json new file mode 100644 index 000000000000..2e55629a3996 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..b2f7ca66d65e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_List.json new file mode 100644 index 000000000000..b4faf6d1a534 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/SeasonalFields_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_ListByPartyId.json new file mode 100644 index 000000000000..f8e96d8e53a4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SeasonalFields_ListByPartyId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/Seasons_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_CreateOrUpdate.json new file mode 100644 index 000000000000..7cded305e7ec --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_CreateOrUpdate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "seasonId": "SEASON123", + "season": { + "startDateTime": "2021-04-22T17:56:28Z", + "endDateTime": "2021-04-22T17:56:28Z", + "year": 2012, + "status": "Active", + "name": "John Smith's Season", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_Delete.json new file mode 100644 index 000000000000..74c5476c4020 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "seasonId": "SEASON123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_Get.json new file mode 100644 index 000000000000..abe8b66f8ade --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "seasonId": "SEASON123" + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_List.json new file mode 100644 index 000000000000..253be553d456 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Seasons_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/SensorDataModels_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_CreateOrUpdate.json new file mode 100644 index 000000000000..9ec84b057129 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorDataModelId": "sdm124", + "api-version": "2023-06-01-preview", + "sensorDataModelObject": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "status": "new", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:15Z", + "eTag": "040158a0-0000-0700-0000-61ee433f0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_Delete.json new file mode 100644 index 000000000000..b7d0465281a9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorDataModelId": "ddm124", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_Get.json new file mode 100644 index 000000000000..53b8a07cdc8d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1", + "sensorDataModelId": "sdm124" + }, + "responses": { + "200": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_List.json new file mode 100644 index 000000000000..137f7b7e74fb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorDataModels_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?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/2023-06-01-preview/examples/SensorEvents_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorEvents_List.json new file mode 100644 index 000000000000..7052de4f1619 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorEvents_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorId": "S124", + "sensorPartnerId": "Davis", + "startDateTime": "2018-01-01T00:00:43Z", + "endDateTime": "2019-01-01T00:00:43Z", + "excludeDuplicateEvents": true + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "prbhad-party", + "boundaryId": "prbhad-boundary", + "eventDateTime": "2018-01-01T00:30:00Z", + "ingestionDateTime": "2021-09-20T05:56:09Z", + "measures": { + "soil_moisture": { + "unit": "m", + "value": 30.1 + } + } + }, + { + "partyId": "prbhad-party", + "boundaryId": "prbhad-boundary", + "eventDateTime": "2018-01-01T00:31:00Z", + "ingestionDateTime": "2021-09-20T05:56:09Z", + "measures": { + "soil_moisture": { + "unit": "m", + "value": 31.1 + } + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..1442c6b49d7b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "sensorMappingId": "sm124", + "api-version": "2023-06-01-preview", + "sensorMappingObject": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "boundaryId": "aksaxena-boundary", + "status": "sensor map created", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "boundaryId": "aksaxena-boundary", + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "boundaryId": "aksaxena-boundary", + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:40:48Z", + "eTag": "05018f35-0000-0700-0000-61ee49f00000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_Delete.json new file mode 100644 index 000000000000..a62809a037c7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "sensorMappingId": "sm124", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_Get.json new file mode 100644 index 000000000000..b7ef4f55f5ba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorMappingId": "sm124" + }, + "responses": { + "200": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "boundaryId": "aksaxena-boundary", + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_List.json new file mode 100644 index 000000000000..6e1ce36a356e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorMappings_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "boundaryId": "aksaxena-boundary", + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?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/2023-06-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json new file mode 100644 index 000000000000..801088817d1f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "key": "CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8", + "body": {} + }, + "responses": { + "200": { + "body": { + "consented": true, + "sensorPartnerId": "Davis", + "integrationId": "I123" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json new file mode 100644 index 000000000000..466e95424302 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "sensorPartnerIntegrationModel": { + "partyId": "prbhad-party", + "status": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-03-16T11:38:45Z", + "eTag": "73023740-0000-0700-0000-6231cc450000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2022-03-16T11:39:41Z", + "modifiedDateTime": "2022-03-16T11:39:41Z", + "eTag": "73023a53-0000-0700-0000-6231cc7d0000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_Delete.json new file mode 100644 index 000000000000..a43ba9a33892 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "Davis", + "integrationId": "I123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json new file mode 100644 index 000000000000..9e1fe3dbafc6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "body": {} + }, + "responses": { + "200": { + "body": { + "consentLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations/I123/:check-consent?key=CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8&apiVersion=2023-06-01-preview", + "consentExpiryDateTime": "2022-03-17T11:56:40Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_Get.json new file mode 100644 index 000000000000..a54f968dd953 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123" + }, + "responses": { + "200": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-03-16T11:38:45Z", + "eTag": "73023740-0000-0700-0000-6231cc450000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_List.json new file mode 100644 index 000000000000..9474e799f8fe --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SensorPartnerIntegrations_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "sensorPartnerId": "Davis", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-01-04T11:17:08Z", + "eTag": "8900a6d8-0000-0700-0000-61d42cb40000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + }, + { + "integrationId": "I456", + "partyId": "prbhad-party2", + "sensorPartnerId": "Davis", + "id": "I456", + "status": "string", + "createdDateTime": "2022-01-12T10:33:54Z", + "modifiedDateTime": "2022-01-12T10:33:54Z", + "eTag": "8d014fe2-0000-0700-0000-61deae920000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations?maxPageSize=10&api-version=2023-06-01-preview&skipToken=W3sidG9rZW4iOiIrUklEOn4xQ1VyQU9zRU8zMXZucGdCQUFBQUFBPT0jUlQ6MSNUUkM6MTAjSVNWOjIjSUVPOjY1NTUxI1FDRjo0I0ZQQzpBZ0ppQm1JR1lnWUVBRytlRDRBPSIsInJhbmdlIjp7Im1pbiI6IiIsIm1heCI6IkZGIn19XQ" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_CreateOrUpdate.json new file mode 100644 index 000000000000..5a379fcac1ae --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorId": "s124", + "api-version": "2023-06-01-preview", + "sensorDetails": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD 456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "status": "sm created", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:05Z", + "eTag": "040139eb-0000-0700-0000-61ee46b90000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:05Z", + "eTag": "040139eb-0000-0700-0000-61ee46b90000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_Delete.json new file mode 100644 index 000000000000..a7bee6ead85a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorId": "s124", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_Get.json new file mode 100644 index 000000000000..627c1f76cc23 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124" + }, + "responses": { + "200": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:31Z", + "eTag": "04019fed-0000-0700-0000-61ee46d30000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_GetConnectionString.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_GetConnectionString.json new file mode 100644 index 000000000000..a6ba2ca52659 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_GetConnectionString.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124", + "body": { + "connectionStringType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****", + "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_List.json new file mode 100644 index 000000000000..6e4838f1f509 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:31Z", + "eTag": "04019fed-0000-0700-0000-61ee46d30000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?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/2023-06-01-preview/examples/Sensors_RenewConnectionString.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_RenewConnectionString.json new file mode 100644 index 000000000000..2f24538119c5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Sensors_RenewConnectionString.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124", + "renewConnectionStringModel": { + "connectionStringType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****", + "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_Cancel.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_Cancel.json new file mode 100644 index 000000000000..cb491626b983 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_Cancel.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "api-version": "2023-06-01-preview", + "solutionInferenceRequest": { + "requestPath": "string" + } + }, + "responses": { + "200": { + "body": { + "requestPath": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_CreateOrUpdate.json new file mode 100644 index 000000000000..543255bf7ec3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_CreateOrUpdate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "api-version": "2023-06-01-preview", + "solutionInferenceRequest": { + "requestPath": "string" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "location" + }, + "body": { + "requestPath": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_Fetch.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_Fetch.json new file mode 100644 index 000000000000..0cc2c04bbe4f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/SolutionInference_Fetch.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "solutionInferenceRequest": { + "requestPath": "string" + }, + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..8434703cfcfd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "tillageDataId": "TillageData123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationtillagedata' resource with id 'TillageData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "TillageData123", + "resourceType": "farmoperationtillagedata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_CreateOrUpdate.json new file mode 100644 index 000000000000..8062c6e27b41 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_CreateOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_Delete.json new file mode 100644 index 000000000000..1b43b1480c80 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_Get.json new file mode 100644 index 000000000000..a1ac0d5fe686 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Asia", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..2c8c61125ba5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "TillageData123", + "resourceType": "farmoperationtillagedata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_List.json new file mode 100644 index 000000000000..a14b3f646cec --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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/2023-06-01-preview/examples/TillageData_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_ListByPartyId.json new file mode 100644 index 000000000000..47a695f74afe --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/TillageData_ListByPartyId.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "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", + "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "attachmentsLink": "https://.farmbeats.azure.net/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=TillageData", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/tillageData?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/2023-06-01-preview/examples/WeatherData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/WeatherData_Get.json new file mode 100644 index 000000000000..74ca326ebf36 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/WeatherData_Get.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "weatherDataProviderRequest": { + "extensionId": "IBM.TWC", + "extensionApiName": "currents-on-demand", + "locations": [ + { + "type": "LatLong", + "value": "33,-97" + } + ], + "language": "en-US", + "units": "e", + "credential": { + "kind": "ApiKeyAuthCredentials", + "apiKey": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + } + } + }, + "responses": { + "200": { + "body": { + "weatherMetadata": { + "extensionVersion": "1.0", + "weatherDataType": "current", + "extensionId": "IBM.TWC", + "extensionApiName": "currents-on-demand", + "units": "e" + }, + "status": "Succeeded", + "locations": [ + { + "location": { + "type": "LatLong", + "value": "33,-97" + }, + "lastRefreshedDateTime": "2023-02-09T13:02:20Z", + "data": { + "dayOfWeek": [ + "Wednesday" + ], + "dayOrNight": [ + "Night" + ], + "pressureMeanSeaLevel": { + "unit": "inches of mercury", + "values": [ + 1021.1 + ] + }, + "relativeHumidity": { + "unit": "percentage", + "values": [ + 84 + ] + }, + "temperature": { + "unit": "fahrenheit", + "values": [ + 49 + ] + }, + "temperatureDewPoint": { + "unit": "fahrenheit", + "values": [ + 44 + ] + }, + "temperatureFeelsLike": { + "unit": "fahrenheit", + "values": [ + 47 + ] + }, + "temperatureHeatIndex": { + "unit": "fahrenheit", + "values": [ + 49 + ] + }, + "temperatureWindChill": { + "unit": "fahrenheit", + "values": [ + 47 + ] + }, + "uvDescription": [ + "Low" + ], + "uvIndex": [ + 0 + ], + "visibility": { + "unit": "miles", + "values": [ + 10 + ] + }, + "windDirection": { + "unit": "degree", + "values": [ + 150 + ] + }, + "windGust": { + "unit": "miles/hour", + "values": [ + 0 + ] + }, + "windSpeed": { + "unit": "miles/hour", + "values": [ + 4 + ] + }, + "additionalAttributes": { + "cloudCoverPhrase": [ + "Partly Cloudy" + ] + } + } + } + ], + "errors": { + "locations": [] + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_CreateDataDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_CreateDataDeleteJob.json new file mode 100644 index 000000000000..6e4e14cd6e9e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_CreateDataDeleteJob.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "extensionId": "dtn.clearAg", + "partyId": "test_party", + "boundaryId": "test_party", + "weatherDataType": "forecast", + "granularity": "daily", + "startDateTime": "2021-04-18T01:32:42Z", + "endDateTime": "2021-04-18T01:32:42Z", + "name": "Delete Job", + "description": "For extension dtn.clearAg", + "properties": { + "region": "US" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": 12.4, + "id": "delete-weather-job", + "status": "Waiting", + "message": "Created job to delete weather data for job name 'delete-weather-job', party id 'test_party' 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", + "partyId": "test_party", + "boundaryId": "test_party", + "extensionId": "dtn.clearAg", + "name": "Delete Job", + "description": "For extension dtn.clearAg", + "properties": { + "region": "US" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_CreateDataIngestionJob.json new file mode 100644 index 000000000000..7b570f9481c9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_CreateDataIngestionJob.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-preview", + "job": { + "partyId": "test_party", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "extensionApiName": "dailyforecast", + "extensionApiInput": { + "start": 0, + "end": 5 + }, + "name": "TestWeatherJob", + "description": "Daily Forecast data for 5 days", + "properties": { + "region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": 12.4, + "id": "weather-job", + "status": "Waiting", + "message": "Created job to fetch weather data for job name 'TestWeatherJob', party id 'test_party' 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", + "partyId": "test_party", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "extensionApiName": "dailyforecast", + "extensionApiInput": { + "start": 0, + "end": 5 + }, + "name": "TestWeatherJob", + "description": "Daily Forecast data for 5 days", + "properties": { + "region": "Asia" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_GetDataDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_GetDataDeleteJobDetails.json new file mode 100644 index 000000000000..f4e4223194a7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_GetDataDeleteJobDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-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", + "partyId": "test_party", + "boundaryId": "test_party", + "weatherDataType": "forecast", + "granularity": "daily", + "startDateTime": "2021-04-18T01:32:42Z", + "endDateTime": "2021-04-18T01:32:42Z", + "name": "Delete Job", + "description": "For extension dtn.clearAg", + "properties": { + "region": "US" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..2d771554dd71 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_GetDataIngestionJobDetails.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-06-01-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", + "partyId": "test_party", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "extensionApiName": "dailyforecast", + "extensionApiInput": { + "start": 0, + "end": 5 + }, + "name": "TestWeatherJob", + "description": "Daily Forecast data for 5 days", + "properties": { + "region": "Asia" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_List.json new file mode 100644 index 000000000000..c01fc910046d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Weather_List.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "partyId": "PARTY123", + "boundaryId": "BOUNDARY123", + "extensionId": "DTN.ClearAg", + "weatherDataType": "Historical", + "granularity": "Daily", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ecd327e7-07f1-31b1-65ee-2162e193c055", + "partyId": "test_party", + "boundaryId": "test_boundary", + "extensionId": "dtn.clearAg", + "location": { + "latitude": 77.75695801443568, + "longitude": 12.30932563432023 + }, + "dateTime": "2020-12-23T00:00:00Z", + "unitSystemCode": "us-std", + "extensionVersion": "1.0", + "weatherDataType": "forecast", + "granularity": "daily", + "cloudCover": { + "unit": "%", + "value": 81.1 + }, + "dewPoint": { + "unit": "F", + "value": 26.0 + }, + "precipitation": { + "unit": "in", + "value": 0.1 + }, + "relativeHumidity": { + "unit": "%", + "value": 74.0 + }, + "temperature": { + "unit": "F", + "value": 33.0 + }, + "windGust": { + "unit": "mph", + "value": 50.0 + }, + "windSpeed": { + "unit": "mph", + "value": 31.0 + }, + "eTag": "\"2b00a419-0000-0700-0000-5fe1ae4c0000\"", + "properties": { + "air_temp_max": { + "unit": "F", + "value": 36.0 + }, + "air_temp_min": "29", + "cloudCoverDescriptor": "Becoming Broken Overcast", + "precipitationDescriptor": "Light Snow Likely", + "weatherDescriptor": "Light Snow Likely", + "windDirectionDescriptor": "East", + "windTrendDescriptor": "None", + "dewPointMax": { + "unit": "F", + "value": 28.0 + }, + "dewPointMin": { + "unit": "F", + "value": 22.0 + }, + "iceAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "liquidAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "longWaveRadiationAvg": { + "unit": "W/m^2", + "value": 291.0 + }, + "petPeriod": { + "unit": "in", + "value": 0.04 + }, + "precipProb": { + "unit": "%", + "value": 75.0 + }, + "relativeHumidityMax": { + "unit": "%", + "value": 81.0 + }, + "relativeHumidityMin": { + "unit": "%", + "value": 69.0 + }, + "shortWaveRadiationAvg": { + "unit": "W/m^2", + "value": 0.0 + }, + "snowAccPeriod": { + "unit": "in", + "value": 0.7 + }, + "sunshineDuration": { + "unit": "hours", + "value": 0.0 + }, + "windSpeed2mAvg": { + "unit": "mph", + "value": 24.0 + }, + "windSpeed2mMax": { + "unit": "mph", + "value": 32.0 + }, + "windSpeed2mMin": { + "unit": "mph", + "value": 17.0 + }, + "windSpeedMax": { + "unit": "mph", + "value": 42.0 + }, + "windSpeedMin": { + "unit": "mph", + "value": 23.0 + } + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..1b8ad61e7746 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "ZONE123", + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "ZONE123", + "resourceType": "zone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_CreateOrUpdate.json new file mode 100644 index 000000000000..a96f679d0106 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "Zone123", + "api-version": "2023-06-01-preview", + "zone": { + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_Delete.json new file mode 100644 index 000000000000..c27b96618923 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "Zone123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_Get.json new file mode 100644 index 000000000000..8f3cd2c67904 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "partyId": "PARTY123", + "zoneId": "Zone123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..a62e088f7c70 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "ZONE123", + "resourceType": "zone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_List.json new file mode 100644 index 000000000000..6a255d4d2e24 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/zones?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/2023-06-01-preview/examples/Zones_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_ListByPartyId.json new file mode 100644 index 000000000000..00709b52cbf8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-06-01-preview/examples/Zones_ListByPartyId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/zones?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/readme.md b/specification/agrifood/data-plane/readme.md index ec1379053f7a..e46fff3a7125 100644 --- a/specification/agrifood/data-plane/readme.md +++ b/specification/agrifood/data-plane/readme.md @@ -27,7 +27,7 @@ These are the global settings for the agfood. ```yaml openapi-type: data-plane -tag: package-2023-04-01-preview +tag: package-2023-06-01-preview directive: - suppress: LongRunningResponseStatusCode @@ -70,6 +70,15 @@ input-file: - Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json ``` +### Tag: package-2023-06-01-preview + +These settings apply only when `--tag=package-2023-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-06-01-preview' +input-file: + - Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json +``` + # Code Generation ## Swagger to SDK