swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector TillageData API schemes: - https tags: - name: TillageData paths: /parties/{partyId}/tillage-data: get: tags: - TillageData description: Returns a paginated list of tillage data resources under a particular farm. operationId: microsoftAzureTillagedataListbypartyid 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 summary: Microsoft Azure Get Parties Partyid Tillage Data /parties/{partyId}/tillage-data/{tillageDataId}: get: tags: - TillageData description: Get a specified tillage data resource under a particular party. operationId: microsoftAzureTillagedataGet produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: tillageDataId description: ID of the tillage data resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/TillageData' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: TillageData_Get: $ref: ./examples/TillageData_Get.json summary: Microsoft Azure Get Parties Partyid Tillage Data Tillagedataid patch: tags: - TillageData description: Creates or updates an tillage data resource under a particular party. operationId: microsoftAzureTillagedataCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: partyId description: ID of the associated party. required: true type: string - in: path name: tillageDataId description: ID of the tillage data resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: tillageData description: Tillage data resource payload to create or update. required: true schema: $ref: '#/definitions/TillageData' responses: '200': description: Success schema: $ref: '#/definitions/TillageData' '201': description: Created schema: $ref: '#/definitions/TillageData' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: TillageData_CreateOrUpdate: $ref: ./examples/TillageData_CreateOrUpdate.json summary: Microsoft Azure Patch Parties Partyid Tillage Data Tillagedataid delete: tags: - TillageData description: Deletes a specified tillage data resource under a particular party. operationId: microsoftAzureTillagedataDelete produces: - application/json parameters: - in: path name: partyId description: ID of the associated party resource. required: true type: string - in: path name: tillageDataId description: ID of the tillage data. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '204': description: No Content default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: TillageData_Delete: $ref: ./examples/TillageData_Delete.json summary: Microsoft Azure Delete Parties Partyid Tillage Data Tillagedataid /tillage-data: get: tags: - TillageData description: Returns a paginated list of tillage data resources across all parties. operationId: microsoftAzureTillagedataList 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 summary: Microsoft Azure Get Tillage Data /tillage-data/cascade-delete/{jobId}: put: tags: - TillageData description: Create cascade delete job for tillage data resource. operationId: microsoftAzureTillagedataCreatecascadedeletejob produces: - application/json parameters: - in: path name: jobId description: Job Id supplied by end user. required: true type: string - in: query name: partyId description: Id of the party. required: true type: string - in: query name: tillageDataId description: Id of the tillage data. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '202': description: Accepted schema: $ref: '#/definitions/CascadeDeleteJob' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: TillageData_CreateCascadeDeleteJob: $ref: ./examples/TillageData_CreateCascadeDeleteJob.json summary: Microsoft Azure Put Tillage Data Cascade Delete Jobid get: tags: - TillageData description: Get cascade delete job for tillage data resource. operationId: microsoftAzureTillagedataGetcascadedeletejobdetails produces: - application/json parameters: - in: path name: jobId description: Id of the job. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/CascadeDeleteJob' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: TillageData_GetCascadeDeleteJobDetails: $ref: ./examples/TillageData_GetCascadeDeleteJobDetails.json summary: Microsoft Azure Get Tillage Data Cascade Delete Jobid /tillage-data:search: post: tags: - TillageData description: Search for TillageData across all parties by intersecting geometry. operationId: microsoftAzureTillagedataSearch consumes: - application/json produces: - application/json parameters: - in: query name: skipToken description: Skip token for getting next set of results. type: string - in: query name: maxPageSize description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50. type: integer format: int32 default: 50 maximum: 1000 minimum: 10 - in: query name: api-version description: The requested API version required: true type: string - in: body name: searchFarmOperationQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchTillageDataQuery' responses: '200': description: Success schema: $ref: '#/definitions/TillageDataMetaDataListResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: TillageData_Search: $ref: ./examples/TillageData_Search.json summary: Microsoft Azure Post Tillage Data:search definitions: GeoResource: description: Schema for storing resource type and resource id. type: object properties: type: description: Resource Type. enum: - Field - SeasonalField - Zone - Prescription - PlantTissueAnalysis - PlantingData - ApplicationData - HarvestData - TillageData type: string x-ms-enum: name: FarmHierarchyGeoResourceType modelAsString: true id: description: Resource Id. type: string TillageDataMetaData: description: Schema of tillage data resource. type: object properties: tillageDepth: $ref: '#/definitions/Measure' tillagePressure: $ref: '#/definitions/Measure' area: $ref: '#/definitions/Measure' operationModifiedDateTime: format: date-time description: "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself." type: string example: '2021-02-10T11:10:21Z' operationStartDateTime: format: date-time description: 'Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string example: '2020-12-31T11:10:21Z' operationEndDateTime: format: date-time description: 'End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string example: '2021-01-31T11:10:21Z' associatedResource: $ref: '#/definitions/GeoResource' partyId: description: Party ID which belongs to the operation data. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true status: description: Status of the resource. maxLength: 100 minLength: 0 type: string createdDateTime: format: date-time description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true example: '2020-12-31T11:10:21Z' modifiedDateTime: format: date-time description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true example: '2020-12-31T11:10:21Z' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string name: description: Name to identify resource. maxLength: 100 minLength: 0 type: string description: description: Textual description of the resource. maxLength: 500 minLength: 0 type: string createdBy: description: Created by user/tenant id. type: string readOnly: true modifiedBy: description: Modified by user/tenant id. type: string readOnly: true properties: description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 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 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 TillageDataMetaDataListResponse: description: Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/TillageDataMetaData' skipToken: description: Token used in retrieving the next page. If null, there are no additional pages. type: string nextLink: description: Continuation link (absolute URI) to the next page of results in the list. type: string SearchTillageDataQuery: description: SearchTillageDataQuery. type: object properties: minTillageDepth: format: double description: Minimum measured tillage depth (inclusive). type: number maxTillageDepth: format: double description: Maximum measured tillage depth (inclusive). type: number minTillagePressure: format: double description: Minimum pressure applied to a tillage implement (inclusive). type: number maxTillagePressure: format: double description: Maximum pressure applied to a tillage implement (inclusive). type: number associatedResourceIds: description: Resource Ids of the resource. type: array items: type: string associatedResourceType: description: "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis." type: string minOperationStartDateTime: format: date-time description: 'Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).' type: string maxOperationStartDateTime: format: date-time description: 'Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).' type: string minOperationEndDateTime: format: date-time description: 'Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).' type: string maxOperationEndDateTime: format: date-time description: 'Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).' type: string minOperationModifiedDateTime: format: date-time description: 'Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).' type: string maxOperationModifiedDateTime: format: date-time description: 'Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).' type: string sources: description: Sources of the operation data. type: array items: type: string minArea: format: double description: Minimum acreage of the boundary (inclusive). type: number maxArea: format: double description: Maximum acreage of the boundary (inclusive). type: number ids: description: Ids of the resource. type: array items: type: string names: description: Names of the resource. type: array items: type: string propertyFilters: description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"." type: array items: type: string statuses: description: Statuses of the resource. type: array items: type: string minCreatedDateTime: format: date-time description: Minimum creation date of resource (inclusive). type: string maxCreatedDateTime: format: date-time description: Maximum creation date of resource (inclusive). type: string minLastModifiedDateTime: format: date-time description: Minimum last modified date of resource (inclusive). type: string maxLastModifiedDateTime: format: date-time description: Maximum last modified date of resource (inclusive). type: string intersectsWithGeometry: $ref: '#/definitions/GeoJsonObject' partyId: description: Party ID which belongs to the operation data. type: string 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 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 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 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' 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 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' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'