Microsoft.AgFoodPlatform (preview:2023-04-01)

2025/09/26 • 197 deleted methods

ApplicationData_List (removed)
Description :  Returns a paginated list of application data resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /application-data
{
minAvgMaterial:
{
Description: Minimum average amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Maximum average amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Minimum total amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Maximum total amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: A flag indicating whether product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ApplicationData_CreateCascadeDeleteJob (removed)
Description :  Create cascade delete job for application data resource.
Reference :  Link ¶

⚼ Request

PUT:  /application-data/cascade-delete/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: Id of the application data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ApplicationData_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for application data resource.
Reference :  Link ¶

⚼ Request

GET:  /application-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ApplicationData_ListByPartyId (removed)
Description :  Returns a paginated list of application data resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/application-data
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
minAvgMaterial:
{
Description: Minimum average amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Maximum average amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Minimum total amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Maximum total amount of material applied during the application (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: A flag indicating whether product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ApplicationData_Get (removed)
Description :  Get a specified application data resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/application-data/{applicationDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: ID of the application data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: A flag indicating whether product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ApplicationData_CreateOrUpdate (removed)
Description :  Creates or updates an application data resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/application-data/{applicationDataId}
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: ID of the application data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
applicationData:
{
Description: Application data resource payload to create or update. ,
Required: True ,
}
{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: A flag indicating whether product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: A flag indicating whether product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: A flag indicating whether product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
ApplicationData_Delete (removed)
Description :  Deletes a specified application data resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/application-data/{applicationDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: ID of the application data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Attachments_ListByPartyId (removed)
Description :  Returns a paginated list of attachment resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/attachments
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
resourceIds:
{
Description: Resource Ids of the resource. ,
Required: False ,
}
array ,
resourceTypes:
{
Description: Resource Types of the resource. i.e. Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
ApplicationData: No description available. ,
HarvestData: No description available. ,
TillageData: No description available. ,
PlantingData: No description available. ,
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Attachments_Get (removed)
Description :  Gets a specified attachment resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/attachments/{attachmentId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of the attachment. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
ApplicationData: No description available. ,
HarvestData: No description available. ,
TillageData: No description available. ,
PlantingData: No description available. ,
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Attachments_CreateOrUpdate (removed)
Description :  Creates or updates an attachment resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/attachments/{attachmentId}
{
partyId:
{
Description: Id of the associated party resource. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of the attachment resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
file:
{
Description: File to be uploaded. ,
Format: binary ,
Required: False ,
}
file ,
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
ApplicationData: No description available. ,
HarvestData: No description available. ,
TillageData: No description available. ,
PlantingData: No description available. ,
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
ApplicationData: No description available. ,
HarvestData: No description available. ,
TillageData: No description available. ,
PlantingData: No description available. ,
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Attachments_Delete (removed)
Description :  Deletes a specified attachment resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/attachments/{attachmentId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of the attachment. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Attachments_Download (removed)
Description :  Downloads and returns attachment as response for the given input filePath.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/attachments/{attachmentId}/file
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of attachment to be downloaded. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_List (removed)
Description :  Returns a paginated list of boundary resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /boundaries
{
parentType:
{
Description: Type of the parent it belongs to. ,
Required: False ,
}
string ,
type:
{
Description: Type it belongs to. ,
Required: False ,
}
string ,
parentIds:
{
Description: Parent Ids of the resource. ,
Required: False ,
}
array ,
minArea:
{
Description: Minimum area of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum acreage of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified boundary.
Reference :  Link ¶

⚼ Request

PUT:  /boundaries/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
boundaryId:
{
Description: ID of the boundary to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for specified boundary.
Reference :  Link ¶

⚼ Request

GET:  /boundaries/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_ListByPartyId (removed)
Description :  Returns a paginated list of boundary resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/boundaries
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
parentType:
{
Description: Type of the parent it belongs to. ,
Required: False ,
}
string ,
type:
{
Description: Type it belongs to. ,
Required: False ,
}
string ,
parentIds:
{
Description: Parent Ids of the resource. ,
Required: False ,
}
array ,
minArea:
{
Description: Minimum area of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum acreage of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_SearchByPartyId (removed)
Description :  Search for boundaries by fields and intersecting geometry.
Reference :  Link ¶

⚼ Request

POST:  /parties/{partyId}/boundaries
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
searchBoundaryQuery:
{
Description: Query filters. ,
Required: True ,
}
{
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
[
string ,
]
,
names:
{
Description: Names of the resource. ,
Required: False ,
}
[
string ,
]
,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. e.g. "{testKey} eq {testValue}". ,
Required: False ,
}
[
string ,
]
,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
[
string ,
]
,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
parentType:
{
Description: Type of the parent it belongs to. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type it belongs to. ,
Required: False ,
}
string ,
parentIds:
{
Description: Parent Ids of the resource. ,
Required: False ,
}
[
string ,
]
,
minArea:
{
Description: Minimum acreage of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum acreage of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
intersectsWithGeometry:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_CreateOrUpdate (removed)
Description :  Creates or updates a boundary resource.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/boundaries/{boundaryId}
{
partyId:
{
Description: Id of the party resource. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
boundary:
{
Description: Boundary resource payload to create or update. ,
Required: True ,
}
{
geometry:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
type:
{
Description: Indicates the type of boundary belonging to a parent. ,
Required: False ,
}
string ,
crs:
{
Description: Coordinate Reference System. ,
Required: False ,
}
string ,
centroid:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
bbox:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. i.e. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
geometry:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
type:
{
Description: Indicates the type of boundary belonging to a parent. ,
Required: False ,
}
string ,
crs:
{
Description: Coordinate Reference System. ,
Required: False ,
}
string ,
centroid:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
bbox:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. i.e. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
geometry:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
type:
{
Description: Indicates the type of boundary belonging to a parent. ,
Required: False ,
}
string ,
crs:
{
Description: Coordinate Reference System. ,
Required: False ,
}
string ,
centroid:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
bbox:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. i.e. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_Get (removed)
Description :  Gets a specified boundary resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/boundaries/{boundaryId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
geometry:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
type:
{
Description: Indicates the type of boundary belonging to a parent. ,
Required: False ,
}
string ,
crs:
{
Description: Coordinate Reference System. ,
Required: False ,
}
string ,
centroid:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
bbox:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
parentId:
{
Description: Id of the parent it belongs to. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
parentType:
{
Description: Type of the parent it belongs to. i.e. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData. ,
Enum:
{
Field: No description available. ,
SeasonalField: No description available. ,
Zone: No description available. ,
Prescription: No description available. ,
PlantTissueAnalysis: No description available. ,
ApplicationData: No description available. ,
PlantingData: No description available. ,
TillageData: No description available. ,
HarvestData: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_Delete (removed)
Description :  Deletes a specified boundary resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/boundaries/{boundaryId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Boundaries_GetOverlap (removed)
Description :  Returns overlapping area between two boundary Ids.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/boundaries/{boundaryId}/overlap
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary. ,
Required: True ,
}
string ,
otherPartyId:
{
Description: PartyId of the other field. ,
Required: True ,
}
string ,
otherBoundaryId:
{
Description: Id of the other boundary. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boundaryArea:
{
Description: Acreage of Main boundary. ,
Format: double ,
Required: False ,
}
number ,
otherBoundaryArea:
{
Description: Acreage of other boundary. ,
Format: double ,
Required: False ,
}
number ,
intersectingArea:
{
Description: Acreage of intersecting boundary. ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
CropProducts_List (removed)
Description :  Returns a paginated list of crop product resources.
Reference :  Link ¶

⚼ Request

GET:  /crop-products
{
cropIds:
{
Description: CropIds of the resource. ,
Required: False ,
}
array ,
brands:
{
Description: Brands of the resource. ,
Required: False ,
}
array ,
products:
{
Description: Products of the resource. ,
Required: False ,
}
array ,
traits:
{
Description: Traits of the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
cropIds:
{
Description: Ids of the crops it belongs to. Note: A maximum of 25 crops can be associated with a cropProduct. ,
Required: False ,
}
[
string ,
]
,
brand:
{
Description: CropProduct Brand. ,
Required: False ,
}
string ,
product:
{
Description: CropProduct product. ,
Required: False ,
}
string ,
trait:
{
Description: CropProduct trait. ,
Required: False ,
}
string ,
relativeMaturity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
treatments:
{
Description: CropProduct treatments. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
CropProducts_Get (removed)
Description :  Gets a specified crop Product resource.
Reference :  Link ¶

⚼ Request

GET:  /crop-products/{cropProductId}
{
cropProductId:
{
Description: Id of the crop Product. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
cropIds:
{
Description: Ids of the crops it belongs to. Note: A maximum of 25 crops can be associated with a cropProduct. ,
Required: False ,
}
[
string ,
]
,
brand:
{
Description: CropProduct Brand. ,
Required: False ,
}
string ,
product:
{
Description: CropProduct product. ,
Required: False ,
}
string ,
trait:
{
Description: CropProduct trait. ,
Required: False ,
}
string ,
relativeMaturity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
treatments:
{
Description: CropProduct treatments. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
CropProducts_CreateOrUpdate (removed)
Description :  Creates or updates a crop Product resource.
Reference :  Link ¶

⚼ Request

PATCH:  /crop-products/{cropProductId}
{
cropProductId:
{
Description: Id of the crop Product resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
cropProduct:
{
Description: Crop Product resource payload to create or update. ,
Required: True ,
}
{
cropIds:
{
Description: Ids of the crops it belongs to. Note: A maximum of 25 crops can be associated with a cropProduct. ,
Required: False ,
}
[
string ,
]
,
brand:
{
Description: CropProduct Brand. ,
Required: False ,
}
string ,
product:
{
Description: CropProduct product. ,
Required: False ,
}
string ,
trait:
{
Description: CropProduct trait. ,
Required: False ,
}
string ,
relativeMaturity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
treatments:
{
Description: CropProduct treatments. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
cropIds:
{
Description: Ids of the crops it belongs to. Note: A maximum of 25 crops can be associated with a cropProduct. ,
Required: False ,
}
[
string ,
]
,
brand:
{
Description: CropProduct Brand. ,
Required: False ,
}
string ,
product:
{
Description: CropProduct product. ,
Required: False ,
}
string ,
trait:
{
Description: CropProduct trait. ,
Required: False ,
}
string ,
relativeMaturity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
treatments:
{
Description: CropProduct treatments. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
cropIds:
{
Description: Ids of the crops it belongs to. Note: A maximum of 25 crops can be associated with a cropProduct. ,
Required: False ,
}
[
string ,
]
,
brand:
{
Description: CropProduct Brand. ,
Required: False ,
}
string ,
product:
{
Description: CropProduct product. ,
Required: False ,
}
string ,
trait:
{
Description: CropProduct trait. ,
Required: False ,
}
string ,
relativeMaturity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
treatments:
{
Description: CropProduct treatments. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
CropProducts_Delete (removed)
Description :  Deletes a specified crop Product resource.
Reference :  Link ¶

⚼ Request

DELETE:  /crop-products/{cropProductId}
{
cropProductId:
{
Description: Id of the crop Product. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Crops_List (removed)
Description :  Returns a paginated list of crop resources.
Reference :  Link ¶

⚼ Request

GET:  /crops
{
phenotypes:
{
Description: Crop phenotypes of the resource. ,
Required: False ,
}
array ,
breedingMethods:
{
Description: Breeding method of the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
phenotype:
{
Description: Crop phenotype. ,
Required: False ,
}
string ,
breedingMethod:
{
Description: Breeding Method. ,
Enum:
{
VARIETY: No description available. ,
HYBRID: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
measurements:
{
Description: Measurements. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Crops_Get (removed)
Description :  Gets a specified crop resource.
Reference :  Link ¶

⚼ Request

GET:  /crops/{cropId}
{
cropId:
{
Description: Id of the crop. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
phenotype:
{
Description: Crop phenotype. ,
Required: False ,
}
string ,
breedingMethod:
{
Description: Breeding Method. ,
Enum:
{
VARIETY: No description available. ,
HYBRID: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
measurements:
{
Description: Measurements. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Crops_CreateOrUpdate (removed)
Description :  Creates or updates a crop resource.
Reference :  Link ¶

⚼ Request

PATCH:  /crops/{cropId}
{
cropId:
{
Description: Id of the crop resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
crop:
{
Description: Crop resource payload to create or update. ,
Required: True ,
}
{
phenotype:
{
Description: Crop phenotype. ,
Required: False ,
}
string ,
breedingMethod:
{
Description: Breeding Method. ,
Enum:
{
VARIETY: No description available. ,
HYBRID: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
measurements:
{
Description: Measurements. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
phenotype:
{
Description: Crop phenotype. ,
Required: False ,
}
string ,
breedingMethod:
{
Description: Breeding Method. ,
Enum:
{
VARIETY: No description available. ,
HYBRID: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
measurements:
{
Description: Measurements. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
phenotype:
{
Description: Crop phenotype. ,
Required: False ,
}
string ,
breedingMethod:
{
Description: Breeding Method. ,
Enum:
{
VARIETY: No description available. ,
HYBRID: No description available. ,
UNKNOWN: No description available. ,
}
,
Required: False ,
}
enum ,
measurements:
{
Description: Measurements. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Crops_Delete (removed)
Description :  Deletes Crop for given crop id.
Reference :  Link ¶

⚼ Request

DELETE:  /crops/{cropId}
{
cropId:
{
Description: Id of crop to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
DeviceDataModels_List (removed)
Description :  Returns a paginated list of device data model resources.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/device-data-models
{
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: True ,
}
string ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Device productCode. ,
Required: False ,
}
string ,
ports:
{
Description: List of device ports supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
DeviceDataModels_CreateOrUpdate (removed)
Description :  Create a device data model entity.
Reference :  Link ¶

⚼ Request

PATCH:  /sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
deviceDataModelId:
{
Description: Id of the device data model. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
deviceDataModelObject:
{
Description: Device data model object details. ,
Required: True ,
}
{
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Device productCode. ,
Required: False ,
}
string ,
ports:
{
Description: List of device ports supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Device productCode. ,
Required: False ,
}
string ,
ports:
{
Description: List of device ports supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Device productCode. ,
Required: False ,
}
string ,
ports:
{
Description: List of device ports supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
DeviceDataModels_Get (removed)
Description :  Gets a device data model entity.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
deviceDataModelId:
{
Description: Id of the device data model resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Device productCode. ,
Required: False ,
}
string ,
ports:
{
Description: List of device ports supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
DeviceDataModels_Delete (removed)
Description :  Deletes a device data model entity.
Reference :  Link ¶

⚼ Request

DELETE:  /sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
deviceDataModelId:
{
Description: Id of the device data model resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Devices_List (removed)
Description :  Returns a paginated list of device resources.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/devices
{
parentDeviceIds:
{
Description: Id's of the parent devices. ,
Required: False ,
}
array ,
deviceDataModelIds:
{
Description: Id's of the device data models. ,
Required: False ,
}
array ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: True ,
}
string ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
deviceDataModelId:
{
Description: Id of the associated device data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Device hardwareId. ,
Required: False ,
}
string ,
reportingIntervalInSeconds:
{
Description: Interval at which the device sends data in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
parentDeviceId:
{
Description: Parent device Id for this device. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Devices_CreateOrUpdate (removed)
Description :  Create a device entity.
Reference :  Link ¶

⚼ Request

PATCH:  /sensor-partners/{sensorPartnerId}/devices/{deviceId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
deviceId:
{
Description: Id of the device resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
deviceDetails:
{
Description: Device object details. ,
Required: True ,
}
{
deviceDataModelId:
{
Description: Id of the associated device data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Device hardwareId. ,
Required: False ,
}
string ,
reportingIntervalInSeconds:
{
Description: Interval at which the device sends data in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
parentDeviceId:
{
Description: Parent device Id for this device. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
deviceDataModelId:
{
Description: Id of the associated device data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Device hardwareId. ,
Required: False ,
}
string ,
reportingIntervalInSeconds:
{
Description: Interval at which the device sends data in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
parentDeviceId:
{
Description: Parent device Id for this device. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
deviceDataModelId:
{
Description: Id of the associated device data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Device hardwareId. ,
Required: False ,
}
string ,
reportingIntervalInSeconds:
{
Description: Interval at which the device sends data in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
parentDeviceId:
{
Description: Parent device Id for this device. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Devices_Get (removed)
Description :  Gets a device entity.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/devices/{deviceId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
deviceId:
{
Description: Id of the device resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
deviceDataModelId:
{
Description: Id of the associated device data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
type:
{
Description: Type of device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Device hardwareId. ,
Required: False ,
}
string ,
reportingIntervalInSeconds:
{
Description: Interval at which the device sends data in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
parentDeviceId:
{
Description: Parent device Id for this device. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Devices_Delete (removed)
Description :  Deletes a device entity.
Reference :  Link ¶

⚼ Request

DELETE:  /sensor-partners/{sensorPartnerId}/devices/{deviceId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
deviceId:
{
Description: Id of the device resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
FarmOperations_CreateDataIngestionJob (removed)
Description :  Create a farm operation data ingestion job.
Reference :  Link ¶

⚼ Request

PUT:  /farm-operations/ingest-data/{jobId}
{
jobId:
{
Description: Job Id supplied by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Authentication provider Id. ,
Required: True ,
}
string ,
operations:
{
Description: List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. ,
Required: False ,
}
[
string ,
]
,
startYear:
{
Description: Start Year (Minimum = 2000, Maximum = CurrentYear). ,
Format: int32 ,
Required: True ,
}
integer ,
isIncremental:
{
Description: Use this to pull only the incremental changes from the last run. ,
Required: False ,
}
boolean ,
providerInput:
{
Description: Schema for provider input for Farm operations job. ,
Required: True ,
}
{
shapeType:
{
Description: Type of shape file to be ingested from JohnDeere. Possible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
}
,
Required: True ,
}
enum ,
shapeResolution:
{
Description: Resolution of shape file to be ingested from JohnDeere. Possible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. ,
Enum:
{
EachSection: No description available. ,
EachSensor: No description available. ,
OneHertz: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Authentication provider Id. ,
Required: True ,
}
string ,
operations:
{
Description: List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. ,
Required: False ,
}
[
string ,
]
,
startYear:
{
Description: Start Year (Minimum = 2000, Maximum = CurrentYear). ,
Format: int32 ,
Required: True ,
}
integer ,
isIncremental:
{
Description: Use this to pull only the incremental changes from the last run. ,
Required: False ,
}
boolean ,
providerInput:
{
Description: Schema for provider input for Farm operations job. ,
Required: True ,
}
{
shapeType:
{
Description: Type of shape file to be ingested from JohnDeere. Possible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
}
,
Required: True ,
}
enum ,
shapeResolution:
{
Description: Resolution of shape file to be ingested from JohnDeere. Possible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. ,
Enum:
{
EachSection: No description available. ,
EachSensor: No description available. ,
OneHertz: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
FarmOperations_GetDataIngestionJobDetails (removed)
Description :  Get a farm operation data ingestion job.
Reference :  Link ¶

⚼ Request

GET:  /farm-operations/ingest-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Authentication provider Id. ,
Required: True ,
}
string ,
operations:
{
Description: List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. ,
Required: False ,
}
[
string ,
]
,
startYear:
{
Description: Start Year (Minimum = 2000, Maximum = CurrentYear). ,
Format: int32 ,
Required: True ,
}
integer ,
isIncremental:
{
Description: Use this to pull only the incremental changes from the last run. ,
Required: False ,
}
boolean ,
providerInput:
{
Description: Schema for provider input for Farm operations job. ,
Required: True ,
}
{
shapeType:
{
Description: Type of shape file to be ingested from JohnDeere. Possible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
}
,
Required: True ,
}
enum ,
shapeResolution:
{
Description: Resolution of shape file to be ingested from JohnDeere. Possible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. ,
Enum:
{
EachSection: No description available. ,
EachSensor: No description available. ,
OneHertz: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_List (removed)
Description :  Returns a paginated list of farm resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /farms
{
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified farm.
Reference :  Link ¶

⚼ Request

PUT:  /farms/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
farmId:
{
Description: ID of the farm to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified farm.
Reference :  Link ¶

⚼ Request

GET:  /farms/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_ListByPartyId (removed)
Description :  Returns a paginated list of farm resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/farms
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_Get (removed)
Description :  Gets a specified farm resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/farms/{farmId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
farmId:
{
Description: ID of the farm resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_CreateOrUpdate (removed)
Description :  Creates or updates a farm resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/farms/{farmId}
{
partyId:
{
Description: Id of the associated party resource. ,
Required: True ,
}
string ,
farmId:
{
Description: Id of the farm resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
farm:
{
Description: Farm resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Farms_Delete (removed)
Description :  Deletes a specified farm resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/farms/{farmId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
farmId:
{
Description: Id of the farm. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_List (removed)
Description :  Returns a paginated list of field resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /fields
{
farmIds:
{
Description: Farm Ids of the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified field.
Reference :  Link ¶

⚼ Request

GET:  /fields/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified field.
Reference :  Link ¶

⚼ Request

PUT:  /fields/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
fieldId:
{
Description: ID of the field to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_ListByPartyId (removed)
Description :  Returns a paginated list of field resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/fields
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
farmIds:
{
Description: Farm Ids of the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_Get (removed)
Description :  Gets a specified field resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/fields/{fieldId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
fieldId:
{
Description: Id of the field. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_CreateOrUpdate (removed)
Description :  Creates or Updates a field resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/fields/{fieldId}
{
partyId:
{
Description: Id of the associated party resource. ,
Required: True ,
}
string ,
fieldId:
{
Description: Id of the field resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
field:
{
Description: Field resource payload to create or update. ,
Required: True ,
}
{
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Fields_Delete (removed)
Description :  Deletes a specified field resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/fields/{fieldId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
fieldId:
{
Description: Id of the field. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
HarvestData_List (removed)
Description :  Returns a paginated list of harvest data resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /harvest-data
{
minTotalYield:
{
Description: Minimum Yield value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalYield:
{
Description: Maximum Yield value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgYield:
{
Description: Minimum AvgYield value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgYield:
{
Description: Maximum AvgYield value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTotalWetMass:
{
Description: Minimum Total WetMass value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalWetMass:
{
Description: Maximum Total WetMass value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgWetMass:
{
Description: Minimum AvgWetMass value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgWetMass:
{
Description: Maximum AvgWetMass value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgMoisture:
{
Description: Minimum AvgMoisture value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgMoisture:
{
Description: Maximum AvgMoisture value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgSpeed:
{
Description: Minimum AvgSpeed value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgSpeed:
{
Description: Maximum AvgSpeed value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Harvest product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
HarvestData_CreateCascadeDeleteJob (removed)
Description :  Create cascade delete job for harvest data resource.
Reference :  Link ¶

⚼ Request

PUT:  /harvest-data/cascade-delete/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: Id of the harvest data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
HarvestData_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for harvest data resource.
Reference :  Link ¶

⚼ Request

GET:  /harvest-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
HarvestData_ListByPartyId (removed)
Description :  Returns a paginated list of harvest data resources under a particular farm.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/harvest-data
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
minTotalYield:
{
Description: Minimum Yield value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalYield:
{
Description: Maximum Yield value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgYield:
{
Description: Minimum AvgYield value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgYield:
{
Description: Maximum AvgYield value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTotalWetMass:
{
Description: Minimum Total WetMass value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalWetMass:
{
Description: Maximum Total WetMass value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgWetMass:
{
Description: Minimum AvgWetMass value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgWetMass:
{
Description: Maximum AvgWetMass value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgMoisture:
{
Description: Minimum AvgMoisture value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgMoisture:
{
Description: Maximum AvgMoisture value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgSpeed:
{
Description: Minimum AvgSpeed value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgSpeed:
{
Description: Maximum AvgSpeed value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Harvest product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
HarvestData_Get (removed)
Description :  Get a specified harvest data resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/harvest-data/{harvestDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: ID of the harvest data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Harvest product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
HarvestData_CreateOrUpdate (removed)
Description :  Creates or updates harvest data resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/harvest-data/{harvestDataId}
{
partyId:
{
Description: ID of the party. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: ID of the harvest data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
harvestData:
{
Description: Harvest data resource payload to create or update. ,
Required: True ,
}
{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Harvest product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Harvest product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Harvest product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
HarvestData_Delete (removed)
Description :  Deletes a specified harvest data resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/harvest-data/{harvestDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: ID of the harvest data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ImageProcessing_CreateRasterizeJob (removed)
Description :  Create a ImageProcessing Rasterize job.
Reference :  Link ¶

⚼ Request

PUT:  /image-processing/rasterize/{jobId}
{
jobId:
{
Description: JobId provided by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
shapefileAttachmentId:
{
Description: Shapefile attachment Id. ,
Required: True ,
}
string ,
shapefileColumnNames:
{
Description: List of shapefile column names to create raster attachments. ,
Required: True ,
}
[
string ,
]
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
shapefileAttachmentId:
{
Description: Shapefile attachment Id. ,
Required: True ,
}
string ,
shapefileColumnNames:
{
Description: List of shapefile column names to create raster attachments. ,
Required: True ,
}
[
string ,
]
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ImageProcessing_GetRasterizeJob (removed)
Description :  Get ImageProcessing Rasterize job's details.
Reference :  Link ¶

⚼ Request

GET:  /image-processing/rasterize/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
shapefileAttachmentId:
{
Description: Shapefile attachment Id. ,
Required: True ,
}
string ,
shapefileColumnNames:
{
Description: List of shapefile column names to create raster attachments. ,
Required: True ,
}
[
string ,
]
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
InsightAttachments_ListByPartyIdModelIdAndResource (removed)
Description :  Returns a paginated list of insight resources.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightIds:
{
Description: List of insight IDs. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
insightId:
{
Description: InsightID for this InsightAttachment. ,
Required: True ,
}
string ,
modelId:
{
Description: ModelID for this InsightAttachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
InsightAttachments_CreateOrUpdate (removed)
Description :  Creates or updates insight entity.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightAttachmentId:
{
Description: Id of the insight resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
file:
{
Description: File to be uploaded. ,
Format: binary ,
Required: False ,
}
file ,
insightId:
{
Description: InsightID for this InsightAttachment. ,
Required: True ,
}
string ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
insightId:
{
Description: InsightID for this InsightAttachment. ,
Required: True ,
}
string ,
modelId:
{
Description: ModelID for this InsightAttachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
insightId:
{
Description: InsightID for this InsightAttachment. ,
Required: True ,
}
string ,
modelId:
{
Description: ModelID for this InsightAttachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
InsightAttachments_Get (removed)
Description :  Gets a specified insight resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightAttachmentId:
{
Description: Id of the insight attachment resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
insightId:
{
Description: InsightID for this InsightAttachment. ,
Required: True ,
}
string ,
modelId:
{
Description: ModelID for this InsightAttachment. ,
Required: False ,
}
string ,
resourceType:
{
Description: Associated Resource type for this attachment. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Associated Resource id for this attachment. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original File Name for this attachment. ,
Required: False ,
}
string ,
partyId:
{
Description: PartyId id for this attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date when resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date when resource was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
InsightAttachments_Delete (removed)
Description :  Deletes a specified insight resource.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightAttachmentId:
{
Description: Id of the insight attachment resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
InsightAttachments_Download (removed)
Description :  Downloads and returns insight-attachment as response for the given input filePath.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}/file
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightAttachmentId:
{
Description: Id of the insight attachment resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Insights_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.
Reference :  Link ¶

⚼ Request

PUT:  /insights/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource Type. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightId:
{
Description: Insight id. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Insights_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified insight.
Reference :  Link ¶

⚼ Request

GET:  /insights/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Insights_ListByPartyIdModelIdAndResource (removed)
Description :  Returns a paginated list of insight resources.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
minInsightStartDateTime:
{
Description: Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
maxInsightStartDateTime:
{
Description: Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
minInsightEndDateTime:
{
Description: Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
maxInsightEndDateTime:
{
Description: Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
measurementFilters:
{
Description: Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. eg. "measureKey.unit eq {testValue}" where testValue is string. eg. "measureKey.value eq {testValue}" where testValue = double. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Id of the associated resource. ,
Required: False ,
}
string ,
modelVersion:
{
Description: Version of the associated model. ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Gets link for attachments. ,
Required: False ,
}
string ,
insightStartDateTime:
{
Description: Start date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
insightEndDateTime:
{
Description: End date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
measurements:
{
Description: Measures to capture insights results. ,
Required: False ,
}
object ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Insights_CreateOrUpdate (removed)
Description :  Creates or updates insight entity.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightId:
{
Description: Id of the insight resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
insightData:
{
Description: Insight data. ,
Required: True ,
}
{
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Id of the associated resource. ,
Required: False ,
}
string ,
modelVersion:
{
Description: Version of the associated model. ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Gets link for attachments. ,
Required: False ,
}
string ,
insightStartDateTime:
{
Description: Start date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
insightEndDateTime:
{
Description: End date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
measurements:
{
Description: Measures to capture insights results. ,
Required: False ,
}
object ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Id of the associated resource. ,
Required: False ,
}
string ,
modelVersion:
{
Description: Version of the associated model. ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Gets link for attachments. ,
Required: False ,
}
string ,
insightStartDateTime:
{
Description: Start date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
insightEndDateTime:
{
Description: End date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
measurements:
{
Description: Measures to capture insights results. ,
Required: False ,
}
object ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Id of the associated resource. ,
Required: False ,
}
string ,
modelVersion:
{
Description: Version of the associated model. ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Gets link for attachments. ,
Required: False ,
}
string ,
insightStartDateTime:
{
Description: Start date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
insightEndDateTime:
{
Description: End date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
measurements:
{
Description: Measures to capture insights results. ,
Required: False ,
}
object ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Insights_Get (removed)
Description :  Gets a specified insight resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightId:
{
Description: Id of the insight resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
modelId:
{
Description: Id of the associated model. ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Enum:
{
Party: No description available. ,
Farm: No description available. ,
Field: No description available. ,
SeasonalField: No description available. ,
Boundary: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Id of the associated resource. ,
Required: False ,
}
string ,
modelVersion:
{
Description: Version of the associated model. ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Gets link for attachments. ,
Required: False ,
}
string ,
insightStartDateTime:
{
Description: Start date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
insightEndDateTime:
{
Description: End date to which the insight is related. ,
Format: date-time ,
Required: False ,
}
string ,
measurements:
{
Description: Measures to capture insights results. ,
Required: False ,
}
object ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Insights_Delete (removed)
Description :  Deletes a specified insight resource.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
modelId:
{
Description: Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource type associated with the record. ,
Required: True ,
}
string ,
resourceId:
{
Description: Id of the associated resource. ,
Required: True ,
}
string ,
insightId:
{
Description: Id of the insight resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_List (removed)
Description :  Returns a paginated list of management zone resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /management-zones
{
types:
{
Description: Types of the ManagementZone. ,
Required: False ,
}
array ,
cropIds:
{
Description: CropIds of the ManagementZone. ,
Required: False ,
}
array ,
seasonIds:
{
Description: SeasonIds of the ManagementZone. ,
Required: False ,
}
array ,
fieldIds:
{
Description: FieldIds of the ManagementZone. ,
Required: False ,
}
array ,
sources:
{
Description: Sources of the ManagementZone. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id associated with the ManagementZone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the ManagementZone. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id associated with the ManagementZone. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id associated with the ManagementZone. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id associated with the ManagementZone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified job id.
Reference :  Link ¶

⚼ Request

GET:  /management-zones/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified management zone.
Reference :  Link ¶

⚼ Request

PUT:  /management-zones/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
managementZoneId:
{
Description: ID of the management zone to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_ListByPartyId (removed)
Description :  Returns a paginated list of management zone resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/management-zones
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
types:
{
Description: Types of the ManagementZone. ,
Required: False ,
}
array ,
cropIds:
{
Description: CropIds of the ManagementZone. ,
Required: False ,
}
array ,
seasonIds:
{
Description: SeasonIds of the ManagementZone. ,
Required: False ,
}
array ,
fieldIds:
{
Description: FieldIds of the ManagementZone. ,
Required: False ,
}
array ,
sources:
{
Description: Sources of the ManagementZone. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id associated with the ManagementZone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the ManagementZone. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id associated with the ManagementZone. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id associated with the ManagementZone. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id associated with the ManagementZone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_Get (removed)
Description :  Gets a specified management zone resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/management-zones/{managementZoneId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
managementZoneId:
{
Description: Id of the management zone. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id associated with the ManagementZone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the ManagementZone. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id associated with the ManagementZone. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id associated with the ManagementZone. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id associated with the ManagementZone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_CreateOrUpdate (removed)
Description :  Creates or updates a management zone resource.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/management-zones/{managementZoneId}
{
partyId:
{
Description: Id of the party resource. ,
Required: True ,
}
string ,
managementZoneId:
{
Description: Id of the management zone resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
managementZone:
{
Description: ManagementZone resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party Id associated with the ManagementZone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the ManagementZone. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id associated with the ManagementZone. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id associated with the ManagementZone. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id associated with the ManagementZone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id associated with the ManagementZone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the ManagementZone. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id associated with the ManagementZone. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id associated with the ManagementZone. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id associated with the ManagementZone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
partyId:
{
Description: Party Id associated with the ManagementZone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the ManagementZone. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id associated with the ManagementZone. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id associated with the ManagementZone. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id associated with the ManagementZone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ManagementZones_Delete (removed)
Description :  Deletes a specified management zone resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/management-zones/{managementZoneId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
managementZoneId:
{
Description: Id of the management zone. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ModelInference_CreateBiomassModelJob (removed)
Description :  Create a Biomass Model job.
Reference :  Link ¶

⚼ Request

PUT:  /model-inference/models/microsoft-biomass/infer-data/{jobId}
{
jobId:
{
Description: JobId provided by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which biomass is being calculated. ,
Required: True ,
}
string ,
modelVersion:
{
Description: The version of the biomass model to be run. Available Value: 1.0 . ,
Required: True ,
}
string ,
cropName:
{
Description: Crop name for biomass model. Available Value: Corn. ,
Enum:
{
Corn: No description available. ,
}
,
Required: True ,
}
enum ,
plantingStartDateTime:
{
Description: Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
weatherExtensionId:
{
Description: ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices. ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Values: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
imageResolution:
{
Description: ImageResolution in meters. Available values: 10, 20, 60. ,
Format: double ,
Required: True ,
}
number ,
imageFormat:
{
Description: ImageFormat. Available value: TIF. ,
Enum:
{
TIF: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which biomass is being calculated. ,
Required: True ,
}
string ,
modelVersion:
{
Description: The version of the biomass model to be run. Available Value: 1.0 . ,
Required: True ,
}
string ,
cropName:
{
Description: Crop name for biomass model. Available Value: Corn. ,
Enum:
{
Corn: No description available. ,
}
,
Required: True ,
}
enum ,
plantingStartDateTime:
{
Description: Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
weatherExtensionId:
{
Description: ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices. ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Values: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
imageResolution:
{
Description: ImageResolution in meters. Available values: 10, 20, 60. ,
Format: double ,
Required: True ,
}
number ,
imageFormat:
{
Description: ImageFormat. Available value: TIF. ,
Enum:
{
TIF: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ModelInference_GetBiomassModelJob (removed)
Description :  Get Biomass Model job's details.
Reference :  Link ¶

⚼ Request

GET:  /model-inference/models/microsoft-biomass/infer-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which biomass is being calculated. ,
Required: True ,
}
string ,
modelVersion:
{
Description: The version of the biomass model to be run. Available Value: 1.0 . ,
Required: True ,
}
string ,
cropName:
{
Description: Crop name for biomass model. Available Value: Corn. ,
Enum:
{
Corn: No description available. ,
}
,
Required: True ,
}
enum ,
plantingStartDateTime:
{
Description: Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
weatherExtensionId:
{
Description: ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices. ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Values: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
imageResolution:
{
Description: ImageResolution in meters. Available values: 10, 20, 60. ,
Format: double ,
Required: True ,
}
number ,
imageFormat:
{
Description: ImageFormat. Available value: TIF. ,
Enum:
{
TIF: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ModelInference_CreateSensorPlacementModelJob (removed)
Description :  Create a Sensor Placement Model job.
Reference :  Link ¶

⚼ Request

PUT:  /model-inference/models/microsoft-sensor-placement/infer-data/{jobId}
{
jobId:
{
Description: JobId provided by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which sensor placement is being calculated. ,
Required: True ,
}
string ,
modelVersion:
{
Description: The version of the sensor placement model to be run. ,
Required: True ,
}
string ,
inferenceStartDateTime:
{
Description: Start datetime for satellite data to be pulled. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: End datetime for satellite data to be pulled. ,
Format: date-time ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
sensorType:
{
Description: SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture. ,
Required: True ,
}
string ,
isRanked:
{
Description: IsRanked, if True the sensor placements will be ranked. ,
Required: True ,
}
boolean ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which sensor placement is being calculated. ,
Required: True ,
}
string ,
modelVersion:
{
Description: The version of the sensor placement model to be run. ,
Required: True ,
}
string ,
inferenceStartDateTime:
{
Description: Start datetime for satellite data to be pulled. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: End datetime for satellite data to be pulled. ,
Format: date-time ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
sensorType:
{
Description: SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture. ,
Required: True ,
}
string ,
isRanked:
{
Description: IsRanked, if True the sensor placements will be ranked. ,
Required: True ,
}
boolean ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ModelInference_GetSensorPlacementModelJob (removed)
Description :  Get Sensor Placement Model job's details.
Reference :  Link ¶

⚼ Request

GET:  /model-inference/models/microsoft-sensor-placement/infer-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which sensor placement is being calculated. ,
Required: True ,
}
string ,
modelVersion:
{
Description: The version of the sensor placement model to be run. ,
Required: True ,
}
string ,
inferenceStartDateTime:
{
Description: Start datetime for satellite data to be pulled. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: End datetime for satellite data to be pulled. ,
Format: date-time ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
sensorType:
{
Description: SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture. ,
Required: True ,
}
string ,
isRanked:
{
Description: IsRanked, if True the sensor placements will be ranked. ,
Required: True ,
}
boolean ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ModelInference_CreateSoilMoistureModelJob (removed)
Description :  Create a SoilMoisture Model job.
Reference :  Link ¶

⚼ Request

PUT:  /model-inference/models/microsoft-soil-moisture/infer-data/{jobId}
{
jobId:
{
Description: JobId provided by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which soil moisture is being calculated. ,
Required: True ,
}
string ,
sensorDataModelId:
{
Description: Sensor data model Id. ,
Required: True ,
}
string ,
sensorPartnerId:
{
Description: Sensor partner Id. ,
Required: True ,
}
string ,
inferenceStartDateTime:
{
Description: Inference start date time for soil moisture calculations. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: Inference end date time for soil moisture calculations. ,
Format: date-time ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
imageResolution:
{
Description: ImageResolution in meters. Available values: 10, 20, 60. ,
Format: double ,
Required: True ,
}
number ,
imageFormat:
{
Description: ImageFormat. Available value: TIF. ,
Enum:
{
TIF: No description available. ,
}
,
Required: True ,
}
enum ,
modelVersion:
{
Description: The version of the soil moisture model to be run. ,
Required: True ,
}
string ,
sensorDefinition:
{
Description: Schema for storing sensor definition keywords. ,
Required: True ,
}
{
sensorMeasurement:
{
Description: The measurement name for sensor measure in sensorDataModel. ,
Required: True ,
}
string ,
minProperty:
{
Description: The measurement name for minimum measurement value. ,
Required: True ,
}
string ,
maxProperty:
{
Description: The measurement name for maximum measurement value. ,
Required: True ,
}
string ,
}
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which soil moisture is being calculated. ,
Required: True ,
}
string ,
sensorDataModelId:
{
Description: Sensor data model Id. ,
Required: True ,
}
string ,
sensorPartnerId:
{
Description: Sensor partner Id. ,
Required: True ,
}
string ,
inferenceStartDateTime:
{
Description: Inference start date time for soil moisture calculations. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: Inference end date time for soil moisture calculations. ,
Format: date-time ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
imageResolution:
{
Description: ImageResolution in meters. Available values: 10, 20, 60. ,
Format: double ,
Required: True ,
}
number ,
imageFormat:
{
Description: ImageFormat. Available value: TIF. ,
Enum:
{
TIF: No description available. ,
}
,
Required: True ,
}
enum ,
modelVersion:
{
Description: The version of the soil moisture model to be run. ,
Required: True ,
}
string ,
sensorDefinition:
{
Description: Schema for storing sensor definition keywords. ,
Required: True ,
}
{
sensorMeasurement:
{
Description: The measurement name for sensor measure in sensorDataModel. ,
Required: True ,
}
string ,
minProperty:
{
Description: The measurement name for minimum measurement value. ,
Required: True ,
}
string ,
maxProperty:
{
Description: The measurement name for maximum measurement value. ,
Required: True ,
}
string ,
}
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
ModelInference_GetSoilMoistureModelJob (removed)
Description :  Get SoilMoisture Model job's details.
Reference :  Link ¶

⚼ Request

GET:  /model-inference/models/microsoft-soil-moisture/infer-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which soil moisture is being calculated. ,
Required: True ,
}
string ,
sensorDataModelId:
{
Description: Sensor data model Id. ,
Required: True ,
}
string ,
sensorPartnerId:
{
Description: Sensor partner Id. ,
Required: True ,
}
string ,
inferenceStartDateTime:
{
Description: Inference start date time for soil moisture calculations. ,
Format: date-time ,
Required: True ,
}
string ,
inferenceEndDateTime:
{
Description: Inference end date time for soil moisture calculations. ,
Format: date-time ,
Required: True ,
}
string ,
satelliteProvider:
{
Description: Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise). ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
satelliteSource:
{
Description: Source of satellite data. Available Value: Sentinel_2_L2A. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
imageResolution:
{
Description: ImageResolution in meters. Available values: 10, 20, 60. ,
Format: double ,
Required: True ,
}
number ,
imageFormat:
{
Description: ImageFormat. Available value: TIF. ,
Enum:
{
TIF: No description available. ,
}
,
Required: True ,
}
enum ,
modelVersion:
{
Description: The version of the soil moisture model to be run. ,
Required: True ,
}
string ,
sensorDefinition:
{
Description: Schema for storing sensor definition keywords. ,
Required: True ,
}
{
sensorMeasurement:
{
Description: The measurement name for sensor measure in sensorDataModel. ,
Required: True ,
}
string ,
minProperty:
{
Description: The measurement name for minimum measurement value. ,
Required: True ,
}
string ,
maxProperty:
{
Description: The measurement name for maximum measurement value. ,
Required: True ,
}
string ,
}
,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
NutrientAnalyses_List (removed)
Description :  Returns a paginated list of nutrient analysis resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /nutrient-analyses
{
parentType:
{
Description: Type of the parent it belongs to. i.e. PlantTissueAnalysis. ,
Required: False ,
}
string ,
parentIds:
{
Description: Parent ids of the resource. ,
Required: False ,
}
array ,
classifications:
{
Description: Classifications for nutrient analyses. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party id for this nutrient analysis. ,
Required: False ,
}
string ,
parentId:
{
Description: Parent id for this nutrient analysis. ,
Required: False ,
}
string ,
parentType:
{
Description: Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. ,
Enum:
{
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: Unit for this nutrient analysis. ,
Required: False ,
}
string ,
value:
{
Description: Value for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueLow:
{
Description: Reference value low for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueHigh:
{
Description: Reference value high for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
classification:
{
Description: Classification for this nutrient analysis. ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommendation for this nutrient analysis. ,
Required: False ,
}
string ,
products:
{
Description: Products for this nutrient analysis. ,
Required: False ,
}
[
{
rate:
{
Description: Rate of the product. ,
Required: False ,
}
string ,
instruction:
{
Description: Instruction of the resource. ,
Required: False ,
}
string ,
product:
{
Description: Product of the resource. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
NutrientAnalyses_ListByPartyId (removed)
Description :  Returns a paginated list of nutrient analysis resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/nutrient-analyses
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
parentType:
{
Description: Type of the parent it belongs to. i.e. PlantTissueAnalysis. ,
Required: False ,
}
string ,
parentIds:
{
Description: Parent ids of the resource. ,
Required: False ,
}
array ,
classifications:
{
Description: Classifications for nutrient analyses. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party id for this nutrient analysis. ,
Required: False ,
}
string ,
parentId:
{
Description: Parent id for this nutrient analysis. ,
Required: False ,
}
string ,
parentType:
{
Description: Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. ,
Enum:
{
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: Unit for this nutrient analysis. ,
Required: False ,
}
string ,
value:
{
Description: Value for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueLow:
{
Description: Reference value low for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueHigh:
{
Description: Reference value high for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
classification:
{
Description: Classification for this nutrient analysis. ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommendation for this nutrient analysis. ,
Required: False ,
}
string ,
products:
{
Description: Products for this nutrient analysis. ,
Required: False ,
}
[
{
rate:
{
Description: Rate of the product. ,
Required: False ,
}
string ,
instruction:
{
Description: Instruction of the resource. ,
Required: False ,
}
string ,
product:
{
Description: Product of the resource. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
NutrientAnalyses_Get (removed)
Description :  Gets a specified nutrient analysis resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
nutrientAnalysisId:
{
Description: Id of the nutrient analysis. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party id for this nutrient analysis. ,
Required: False ,
}
string ,
parentId:
{
Description: Parent id for this nutrient analysis. ,
Required: False ,
}
string ,
parentType:
{
Description: Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. ,
Enum:
{
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: Unit for this nutrient analysis. ,
Required: False ,
}
string ,
value:
{
Description: Value for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueLow:
{
Description: Reference value low for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueHigh:
{
Description: Reference value high for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
classification:
{
Description: Classification for this nutrient analysis. ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommendation for this nutrient analysis. ,
Required: False ,
}
string ,
products:
{
Description: Products for this nutrient analysis. ,
Required: False ,
}
[
{
rate:
{
Description: Rate of the product. ,
Required: False ,
}
string ,
instruction:
{
Description: Instruction of the resource. ,
Required: False ,
}
string ,
product:
{
Description: Product of the resource. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
NutrientAnalyses_CreateOrUpdate (removed)
Description :  Creates or updates a nutrient analysis resource.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}
{
partyId:
{
Description: Id of the party resource. ,
Required: True ,
}
string ,
nutrientAnalysisId:
{
Description: Id of the nutrient analysis resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
nutrientAnalysis:
{
Description: NutrientAnalysis resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party id for this nutrient analysis. ,
Required: False ,
}
string ,
parentId:
{
Description: Parent id for this nutrient analysis. ,
Required: False ,
}
string ,
parentType:
{
Description: Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. ,
Enum:
{
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: Unit for this nutrient analysis. ,
Required: False ,
}
string ,
value:
{
Description: Value for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueLow:
{
Description: Reference value low for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueHigh:
{
Description: Reference value high for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
classification:
{
Description: Classification for this nutrient analysis. ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommendation for this nutrient analysis. ,
Required: False ,
}
string ,
products:
{
Description: Products for this nutrient analysis. ,
Required: False ,
}
[
{
rate:
{
Description: Rate of the product. ,
Required: False ,
}
string ,
instruction:
{
Description: Instruction of the resource. ,
Required: False ,
}
string ,
product:
{
Description: Product of the resource. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
partyId:
{
Description: Party id for this nutrient analysis. ,
Required: False ,
}
string ,
parentId:
{
Description: Parent id for this nutrient analysis. ,
Required: False ,
}
string ,
parentType:
{
Description: Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. ,
Enum:
{
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: Unit for this nutrient analysis. ,
Required: False ,
}
string ,
value:
{
Description: Value for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueLow:
{
Description: Reference value low for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueHigh:
{
Description: Reference value high for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
classification:
{
Description: Classification for this nutrient analysis. ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommendation for this nutrient analysis. ,
Required: False ,
}
string ,
products:
{
Description: Products for this nutrient analysis. ,
Required: False ,
}
[
{
rate:
{
Description: Rate of the product. ,
Required: False ,
}
string ,
instruction:
{
Description: Instruction of the resource. ,
Required: False ,
}
string ,
product:
{
Description: Product of the resource. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
partyId:
{
Description: Party id for this nutrient analysis. ,
Required: False ,
}
string ,
parentId:
{
Description: Parent id for this nutrient analysis. ,
Required: False ,
}
string ,
parentType:
{
Description: Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. ,
Enum:
{
PlantTissueAnalysis: No description available. ,
}
,
Required: False ,
}
enum ,
unit:
{
Description: Unit for this nutrient analysis. ,
Required: False ,
}
string ,
value:
{
Description: Value for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueLow:
{
Description: Reference value low for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
referenceValueHigh:
{
Description: Reference value high for this nutrient analysis. ,
Format: double ,
Required: False ,
}
number ,
classification:
{
Description: Classification for this nutrient analysis. ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommendation for this nutrient analysis. ,
Required: False ,
}
string ,
products:
{
Description: Products for this nutrient analysis. ,
Required: False ,
}
[
{
rate:
{
Description: Rate of the product. ,
Required: False ,
}
string ,
instruction:
{
Description: Instruction of the resource. ,
Required: False ,
}
string ,
product:
{
Description: Product of the resource. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
NutrientAnalyses_Delete (removed)
Description :  Deletes a specified nutrient analysis resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
nutrientAnalysisId:
{
Description: Id of the nutrient analysis. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthProviders_List (removed)
Description :  Returns a paginated list of oauthProvider resources.
Reference :  Link ¶

⚼ Request

GET:  /oauth/providers
{
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
appId:
{
Description: OAuth App Id for given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for given Provider. Note: Won't be sent in response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for given Provider. Note: currently Applicable to Climate provider. Won't be sent in response. ,
Required: False ,
}
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) Note: Currently applicable for JohnDeere. ,
Required: False ,
}
boolean ,
id:
{
Description: Unique OAuth provider ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthProviders_Get (removed)
Description :  Get a specified oauthProvider resource.
Reference :  Link ¶

⚼ Request

GET:  /oauth/providers/{oauthProviderId}
{
oauthProviderId:
{
Description: ID of the oauthProvider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
appId:
{
Description: OAuth App Id for given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for given Provider. Note: Won't be sent in response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for given Provider. Note: currently Applicable to Climate provider. Won't be sent in response. ,
Required: False ,
}
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) Note: Currently applicable for JohnDeere. ,
Required: False ,
}
boolean ,
id:
{
Description: Unique OAuth provider ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthProviders_CreateOrUpdate (removed)
Description :  Creates or updates an oauthProvider resource.
Reference :  Link ¶

⚼ Request

PATCH:  /oauth/providers/{oauthProviderId}
{
oauthProviderId:
{
Description: ID of oauthProvider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
oauthProvider:
{
Description: OauthProvider resource payload to create or update. ,
Required: True ,
}
{
appId:
{
Description: OAuth App Id for given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for given Provider. Note: Won't be sent in response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for given Provider. Note: currently Applicable to Climate provider. Won't be sent in response. ,
Required: False ,
}
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) Note: Currently applicable for JohnDeere. ,
Required: False ,
}
boolean ,
id:
{
Description: Unique OAuth provider ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
appId:
{
Description: OAuth App Id for given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for given Provider. Note: Won't be sent in response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for given Provider. Note: currently Applicable to Climate provider. Won't be sent in response. ,
Required: False ,
}
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) Note: Currently applicable for JohnDeere. ,
Required: False ,
}
boolean ,
id:
{
Description: Unique OAuth provider ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
appId:
{
Description: OAuth App Id for given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for given Provider. Note: Won't be sent in response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for given Provider. Note: currently Applicable to Climate provider. Won't be sent in response. ,
Required: False ,
}
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) Note: Currently applicable for JohnDeere. ,
Required: False ,
}
boolean ,
id:
{
Description: Unique OAuth provider ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthProviders_Delete (removed)
Description :  Deletes an specified oauthProvider resource.
Reference :  Link ¶

⚼ Request

DELETE:  /oauth/providers/{oauthProviderId}
{
oauthProviderId:
{
Description: ID of oauthProvider. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthProviders_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for oauthProvider resource.
Reference :  Link ¶

⚼ Request

GET:  /oauth/providers/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
oauthProviderId:
{
Description: The id of the oauth provider. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthProviders_CreateCascadeDeleteJob (removed)
Description :  Create cascade delete job for oauthProvider resource.
Reference :  Link ¶

⚼ Request

PUT:  /oauth/providers/cascade-delete/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
oauthProviderId:
{
Description: Id of the application data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
oauthProviderId:
{
Description: The id of the oauth provider. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthTokens_List (removed)
Description :  Returns a list of OAuthToken documents.
Reference :  Link ¶

⚼ Request

GET:  /oauth/tokens
{
authProviderIds:
{
Description: Name of AuthProvider. ,
Required: False ,
}
array ,
partyIds:
{
Description: List of parties. ,
Required: False ,
}
array ,
isValid:
{
Description: If the token object is valid. ,
Required: False ,
}
boolean ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party ID for this OAuth config. ,
Required: True ,
}
string ,
authProviderId:
{
Description: ID of the OAuth provider resource containing app information. ,
Required: True ,
}
string ,
isValid:
{
Description: An optional flag indicating whether the token is a valid or expired (Default value: true). ,
Required: False ,
}
boolean ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthTokens_GetCascadeDeleteJobDetails (removed)
Description :  Get remove job for OAuth token.
Reference :  Link ¶

⚼ Request

GET:  /oauth/tokens/remove/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
OAuthTokens_CreateCascadeDeleteJob (removed)
Description :  Create remove job for OAuth token.
Reference :  Link ¶

⚼ Request

PUT:  /oauth/tokens/remove/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
oauthProviderId:
{
Description: Id of the OAuthProvider. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Parties_List (removed)
Description :  Returns a paginated list of party resources.
Reference :  Link ¶

⚼ Request

GET:  /parties
{
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Parties_Get (removed)
Description :  Gets a specified party resource.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Parties_CreateOrUpdate (removed)
Description :  Creates or updates a party resource.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}
{
partyId:
{
Description: Id of the party resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
party:
{
Description: Party resource payload to create or update. ,
Required: True ,
}
{
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Parties_Delete (removed)
Description :  Deletes a specified party resource.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}
{
partyId:
{
Description: Id of party to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Parties_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified party.
Reference :  Link ¶

⚼ Request

GET:  /parties/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Parties_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified party.
Reference :  Link ¶

⚼ Request

PUT:  /parties/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the party to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantingData_ListByPartyId (removed)
Description :  Returns a paginated list of planting data resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/planting-data
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
minAvgPlantingRate:
{
Description: Minimum AvgPlantingRate value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgPlantingRate:
{
Description: Maximum AvgPlantingRate value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Minimum TotalMaterial value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Maximum TotalMaterial value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgMaterial:
{
Description: Minimum AvgMaterial value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Maximum AvgMaterial value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Planting product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantingData_Get (removed)
Description :  Get a specified planting data resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/planting-data/{plantingDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: ID of the planting data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Planting product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantingData_CreateOrUpdate (removed)
Description :  Creates or updates an planting data resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/planting-data/{plantingDataId}
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: ID of the planting data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
plantingData:
{
Description: Planting data resource payload to create or update. ,
Required: True ,
}
{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Planting product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Planting product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Planting product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
PlantingData_Delete (removed)
Description :  Deletes a specified planting data resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/planting-data/{plantingDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: ID of the planting data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantingData_List (removed)
Description :  Returns a paginated list of planting data resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /planting-data
{
minAvgPlantingRate:
{
Description: Minimum AvgPlantingRate value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgPlantingRate:
{
Description: Maximum AvgPlantingRate value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Minimum TotalMaterial value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Maximum TotalMaterial value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minAvgMaterial:
{
Description: Minimum AvgMaterial value(inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Maximum AvgMaterial value (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Planting product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantingData_CreateCascadeDeleteJob (removed)
Description :  Create cascade delete job for planting data resource.
Reference :  Link ¶

⚼ Request

PUT:  /planting-data/cascade-delete/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: Id of the planting data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantingData_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for planting data resource.
Reference :  Link ¶

⚼ Request

GET:  /planting-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_ListByPartyId (removed)
Description :  Returns a paginated list of plant tissue analysis resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/plant-tissue-analyses
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
seasonIds:
{
Description: Season ids of the plant tissue analyses. ,
Required: False ,
}
array ,
cropIds:
{
Description: Crop ids of the plant tissue analyses. ,
Required: False ,
}
array ,
cropProductsIds:
{
Description: Crop products ids of the plant tissue analyses. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Field ids of the plant tissue analyses. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Id of the associated Party. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
cropId:
{
Description: Id of the associated Crop. ,
Required: False ,
}
string ,
cropProductId:
{
Description: Id of the associated Crop product. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the associated Season. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: Planting datetime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
growthStage:
{
Description: Growth stage for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPart:
{
Description: Plant part for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPosition:
{
Description: Plant position for this plant tissue analysis. ,
Required: False ,
}
string ,
plantAppearance:
{
Description: Plant appearance for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionCondition:
{
Description: Sample collection condition for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionDateTime:
{
Description: Sample collection dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
sampleReceivedDateTime:
{
Description: Sample received dateTime. ,
Format: date-time ,
Required: False ,
}
string ,
sampleTestResultDateTime:
{
Description: Sample test result dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
labDetails:
{
Description: Model for representing LabDetails object. ,
Required: False ,
}
{
code:
{
Description: Code of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
address:
{
Description: Address of the resource. ,
Required: False ,
}
string ,
}
,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_Get (removed)
Description :  Gets a specified plant tissue analysis resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
plantTissueAnalysisId:
{
Description: Id of the plant tissue analysis. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Id of the associated Party. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
cropId:
{
Description: Id of the associated Crop. ,
Required: False ,
}
string ,
cropProductId:
{
Description: Id of the associated Crop product. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the associated Season. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: Planting datetime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
growthStage:
{
Description: Growth stage for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPart:
{
Description: Plant part for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPosition:
{
Description: Plant position for this plant tissue analysis. ,
Required: False ,
}
string ,
plantAppearance:
{
Description: Plant appearance for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionCondition:
{
Description: Sample collection condition for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionDateTime:
{
Description: Sample collection dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
sampleReceivedDateTime:
{
Description: Sample received dateTime. ,
Format: date-time ,
Required: False ,
}
string ,
sampleTestResultDateTime:
{
Description: Sample test result dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
labDetails:
{
Description: Model for representing LabDetails object. ,
Required: False ,
}
{
code:
{
Description: Code of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
address:
{
Description: Address of the resource. ,
Required: False ,
}
string ,
}
,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_CreateOrUpdate (removed)
Description :  Creates or updates a plant tissue analysis resource.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}
{
partyId:
{
Description: Id of the party resource. ,
Required: True ,
}
string ,
plantTissueAnalysisId:
{
Description: Id of the plant tissue analysis resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
plantTissueAnalysis:
{
Description: PlantTissueAnalysis resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Id of the associated Party. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
cropId:
{
Description: Id of the associated Crop. ,
Required: False ,
}
string ,
cropProductId:
{
Description: Id of the associated Crop product. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the associated Season. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: Planting datetime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
growthStage:
{
Description: Growth stage for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPart:
{
Description: Plant part for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPosition:
{
Description: Plant position for this plant tissue analysis. ,
Required: False ,
}
string ,
plantAppearance:
{
Description: Plant appearance for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionCondition:
{
Description: Sample collection condition for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionDateTime:
{
Description: Sample collection dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
sampleReceivedDateTime:
{
Description: Sample received dateTime. ,
Format: date-time ,
Required: False ,
}
string ,
sampleTestResultDateTime:
{
Description: Sample test result dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
labDetails:
{
Description: Model for representing LabDetails object. ,
Required: False ,
}
{
code:
{
Description: Code of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
address:
{
Description: Address of the resource. ,
Required: False ,
}
string ,
}
,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
partyId:
{
Description: Id of the associated Party. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
cropId:
{
Description: Id of the associated Crop. ,
Required: False ,
}
string ,
cropProductId:
{
Description: Id of the associated Crop product. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the associated Season. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: Planting datetime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
growthStage:
{
Description: Growth stage for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPart:
{
Description: Plant part for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPosition:
{
Description: Plant position for this plant tissue analysis. ,
Required: False ,
}
string ,
plantAppearance:
{
Description: Plant appearance for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionCondition:
{
Description: Sample collection condition for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionDateTime:
{
Description: Sample collection dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
sampleReceivedDateTime:
{
Description: Sample received dateTime. ,
Format: date-time ,
Required: False ,
}
string ,
sampleTestResultDateTime:
{
Description: Sample test result dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
labDetails:
{
Description: Model for representing LabDetails object. ,
Required: False ,
}
{
code:
{
Description: Code of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
address:
{
Description: Address of the resource. ,
Required: False ,
}
string ,
}
,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
partyId:
{
Description: Id of the associated Party. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
cropId:
{
Description: Id of the associated Crop. ,
Required: False ,
}
string ,
cropProductId:
{
Description: Id of the associated Crop product. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the associated Season. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: Planting datetime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
growthStage:
{
Description: Growth stage for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPart:
{
Description: Plant part for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPosition:
{
Description: Plant position for this plant tissue analysis. ,
Required: False ,
}
string ,
plantAppearance:
{
Description: Plant appearance for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionCondition:
{
Description: Sample collection condition for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionDateTime:
{
Description: Sample collection dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
sampleReceivedDateTime:
{
Description: Sample received dateTime. ,
Format: date-time ,
Required: False ,
}
string ,
sampleTestResultDateTime:
{
Description: Sample test result dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
labDetails:
{
Description: Model for representing LabDetails object. ,
Required: False ,
}
{
code:
{
Description: Code of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
address:
{
Description: Address of the resource. ,
Required: False ,
}
string ,
}
,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_Delete (removed)
Description :  Deletes a specified plant tissue analysis resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
plantTissueAnalysisId:
{
Description: Id of the plant tissue analysis. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_List (removed)
Description :  Returns a paginated list of plant tissue analysis resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /plant-tissue-analyses
{
seasonIds:
{
Description: Season ids of the plant tissue analyses. ,
Required: False ,
}
array ,
cropIds:
{
Description: Crop ids of the plant tissue analyses. ,
Required: False ,
}
array ,
cropProductsIds:
{
Description: Crop products ids of the plant tissue analyses. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Field ids of the plant tissue analyses. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Id of the associated Party. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
cropId:
{
Description: Id of the associated Crop. ,
Required: False ,
}
string ,
cropProductId:
{
Description: Id of the associated Crop product. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the associated Season. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: Planting datetime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
growthStage:
{
Description: Growth stage for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPart:
{
Description: Plant part for this plant tissue analysis. ,
Required: False ,
}
string ,
plantPosition:
{
Description: Plant position for this plant tissue analysis. ,
Required: False ,
}
string ,
plantAppearance:
{
Description: Plant appearance for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionCondition:
{
Description: Sample collection condition for this plant tissue analysis. ,
Required: False ,
}
string ,
sampleCollectionDateTime:
{
Description: Sample collection dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
sampleReceivedDateTime:
{
Description: Sample received dateTime. ,
Format: date-time ,
Required: False ,
}
string ,
sampleTestResultDateTime:
{
Description: Sample test result dateTime for this plant tissue analysis. ,
Format: date-time ,
Required: False ,
}
string ,
labDetails:
{
Description: Model for representing LabDetails object. ,
Required: False ,
}
{
code:
{
Description: Code of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
address:
{
Description: Address of the resource. ,
Required: False ,
}
string ,
}
,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified plant tissue analysis.
Reference :  Link ¶

⚼ Request

PUT:  /plant-tissue-analyses/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
plantTissueAnalysisId:
{
Description: ID of the plant tissue analysis to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PlantTissueAnalyses_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified plant tissue analysis.
Reference :  Link ¶

⚼ Request

GET:  /plant-tissue-analyses/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_ListByPartyId (removed)
Description :  Returns a paginated list of prescription map resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/prescription-maps
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
types:
{
Description: Types of the resource. ,
Required: False ,
}
array ,
cropIds:
{
Description: Crop Ids of the resource. ,
Required: False ,
}
array ,
seasonIds:
{
Description: Season Ids of the resource. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Field Ids of the resource. ,
Required: False ,
}
array ,
sources:
{
Description: Sources for the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
type:
{
Description: Prescription map type. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_Get (removed)
Description :  Gets a specified prescription map resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/prescription-maps/{prescriptionMapId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
prescriptionMapId:
{
Description: Id of the prescription map. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
type:
{
Description: Prescription map type. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_CreateOrUpdate (removed)
Description :  Creates or Updates a prescription map resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/prescription-maps/{prescriptionMapId}
{
partyId:
{
Description: Id of the associated party resource. ,
Required: True ,
}
string ,
prescriptionMapId:
{
Description: Id of the prescription map resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
prescriptionMap:
{
Description: PrescriptionMap resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
type:
{
Description: Prescription map type. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
type:
{
Description: Prescription map type. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
type:
{
Description: Prescription map type. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_Delete (removed)
Description :  Deletes a specified prescription map resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/prescription-maps/{prescriptionMapId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
prescriptionMapId:
{
Description: Id of the prescriptionMap. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_List (removed)
Description :  Returns a paginated list of prescription map resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /prescription-maps
{
types:
{
Description: Types of the resource. ,
Required: False ,
}
array ,
cropIds:
{
Description: Crop Ids of the resource. ,
Required: False ,
}
array ,
seasonIds:
{
Description: Season Ids of the resource. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Field Ids of the resource. ,
Required: False ,
}
array ,
sources:
{
Description: Sources for the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
type:
{
Description: Prescription map type. ,
Required: False ,
}
string ,
seasonId:
{
Description: Season Id. ,
Required: False ,
}
string ,
cropId:
{
Description: Crop Id. ,
Required: False ,
}
string ,
fieldId:
{
Description: Field Id. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified prescription map.
Reference :  Link ¶

⚼ Request

GET:  /prescription-maps/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
PrescriptionMaps_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified prescription map.
Reference :  Link ¶

⚼ Request

PUT:  /prescription-maps/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
prescriptionMapId:
{
Description: ID of the prescription map to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_ListByPartyId (removed)
Description :  Returns a paginated list of prescription resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/prescriptions
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
prescriptionMapIds:
{
Description: Prescription Map Ids of the resource. ,
Required: False ,
}
array ,
types:
{
Description: Types of the resource. ,
Required: False ,
}
array ,
productCodes:
{
Description: Product Codes of the resource. ,
Required: False ,
}
array ,
productNames:
{
Description: Product Names of the resource. ,
Required: False ,
}
array ,
sources:
{
Description: Sources for the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
prescriptionMapId:
{
Description: Prescription map Id. ,
Required: False ,
}
string ,
productCode:
{
Description: Product Code. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
type:
{
Description: Prescription type. ,
Required: False ,
}
string ,
measurements:
{
Description: Measures. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_Get (removed)
Description :  Gets a specified prescription resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/prescriptions/{prescriptionId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
prescriptionId:
{
Description: Id of the prescription. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
prescriptionMapId:
{
Description: Prescription map Id. ,
Required: False ,
}
string ,
productCode:
{
Description: Product Code. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
type:
{
Description: Prescription type. ,
Required: False ,
}
string ,
measurements:
{
Description: Measures. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_CreateOrUpdate (removed)
Description :  Creates or Updates a prescription resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/prescriptions/{prescriptionId}
{
partyId:
{
Description: Id of the associated party resource. ,
Required: True ,
}
string ,
prescriptionId:
{
Description: Id of the prescription resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
prescription:
{
Description: Prescription resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
prescriptionMapId:
{
Description: Prescription map Id. ,
Required: False ,
}
string ,
productCode:
{
Description: Product Code. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
type:
{
Description: Prescription type. ,
Required: False ,
}
string ,
measurements:
{
Description: Measures. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
prescriptionMapId:
{
Description: Prescription map Id. ,
Required: False ,
}
string ,
productCode:
{
Description: Product Code. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
type:
{
Description: Prescription type. ,
Required: False ,
}
string ,
measurements:
{
Description: Measures. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
prescriptionMapId:
{
Description: Prescription map Id. ,
Required: False ,
}
string ,
productCode:
{
Description: Product Code. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
type:
{
Description: Prescription type. ,
Required: False ,
}
string ,
measurements:
{
Description: Measures. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_Delete (removed)
Description :  Deletes a specified prescription resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/prescriptions/{prescriptionId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
prescriptionId:
{
Description: Id of the prescription. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_List (removed)
Description :  Returns a paginated list of prescription resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /prescriptions
{
prescriptionMapIds:
{
Description: Prescription Map Ids of the resource. ,
Required: False ,
}
array ,
types:
{
Description: Types of the resource. ,
Required: False ,
}
array ,
productCodes:
{
Description: Product Codes of the resource. ,
Required: False ,
}
array ,
productNames:
{
Description: Product Names of the resource. ,
Required: False ,
}
array ,
sources:
{
Description: Sources for the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
prescriptionMapId:
{
Description: Prescription map Id. ,
Required: False ,
}
string ,
productCode:
{
Description: Product Code. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
type:
{
Description: Prescription type. ,
Required: False ,
}
string ,
measurements:
{
Description: Measures. ,
Required: False ,
}
object ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified prescription.
Reference :  Link ¶

⚼ Request

GET:  /prescriptions/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Prescriptions_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified prescription.
Reference :  Link ¶

⚼ Request

PUT:  /prescriptions/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
prescriptionId:
{
Description: ID of the prescription to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Scenes_List (removed)
Description :  Returns a paginated list of scene resources.
Reference :  Link ¶

⚼ Request

GET:  /scenes
{
provider:
{
Description: Provider name of scene data. ,
Required: True ,
}
string ,
partyId:
{
Description: PartyId. ,
Required: True ,
}
string ,
boundaryId:
{
Description: BoundaryId. ,
Required: True ,
}
string ,
source:
{
Description: Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C. ,
Required: True ,
}
string ,
startDateTime:
{
Description: Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
maxCloudCoveragePercentage:
{
Description: Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. ,
Format: double ,
Required: False ,
}
number ,
maxDarkPixelCoveragePercentage:
{
Description: Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. ,
Format: double ,
Required: False ,
}
number ,
imageNames:
{
Description: List of image names to be filtered. ,
Required: False ,
}
array ,
imageResolutions:
{
Description: List of image resolutions in meters to be filtered. ,
Required: False ,
}
array ,
imageFormats:
{
Description: List of image formats to be filtered. ,
Required: False ,
}
array ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
sceneDateTime:
{
Description: Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
provider:
{
Description: Data provider of the scene. ,
Required: False ,
}
string ,
source:
{
Description: Data source of the scene. ,
Required: False ,
}
string ,
imageFiles:
{
Description: Collection of image files. ,
Required: False ,
}
[
{
fileLink:
{
Description: Link of the image file. ,
Required: False ,
}
string ,
name:
{
Description: Name of the image file. ,
Required: True ,
}
string ,
imageFormat:
{
Description: Supported image formats for scene resource. ,
Enum:
{
TIF: No description available. ,
}
,
Required: False ,
}
enum ,
resolution:
{
Description: Resolution of image file in meters. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
imageFormat:
{
Description: Supported image formats for scene resource. ,
Enum:
{
TIF: No description available. ,
}
,
Required: False ,
}
enum ,
cloudCoverPercentage:
{
Description: Cloud cover percentage of the scene. ,
Format: double ,
Required: False ,
}
number ,
darkPixelPercentage:
{
Description: Dark pixel percentage of the scene. ,
Format: double ,
Required: False ,
}
number ,
ndviMedianValue:
{
Description: Median of NDVI of the scene. ,
Format: double ,
Required: False ,
}
number ,
boundaryId:
{
Description: Boundary ID which belongs to the scene. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the scene. ,
Required: False ,
}
string ,
id:
{
Description: Unique scene resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Scenes_Download (removed)
Description :  Downloads and returns file Stream as response for the given input filePath.
Reference :  Link ¶

⚼ Request

GET:  /scenes/downloadFiles
{
filePath:
{
Description: cloud storage path of scene file. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Scenes_CreateSatelliteDataIngestionJob (removed)
Description :  Create a satellite data ingestion job.
Reference :  Link ¶

⚼ Request

PUT:  /scenes/satellite/ingest-data/{jobId}
{
jobId:
{
Description: JobId provided by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which satellite data is being fetched. ,
Required: True ,
}
string ,
startDateTime:
{
Description: Start Date. ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: End Date. ,
Format: date-time ,
Required: True ,
}
string ,
provider:
{
Description: Provider of satellite data. ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
source:
{
Description: Source of satellite data. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: Data Model for SatelliteIngestionJobRequest. ,
Required: False ,
}
{
imageNames:
{
Description: List of ImageNames. ,
Required: False ,
}
[
string ,
]
,
imageFormats:
{
Description: List of ImageFormats. Available value: TIF. ,
Required: False ,
}
[
string ,
]
,
imageResolutions:
{
Description: List of ImageResolutions in meters. Available values: 10, 20, 60. ,
Required: False ,
}
[
number ,
]
,
}
,
providerClientId:
{
Description: Provider client id for authenticating to provider to pull satellite data. ,
Required: False ,
}
string ,
providerClientSecret:
{
Description: Provider client secret for authenticating to provider to pull satellite data. ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which satellite data is being fetched. ,
Required: True ,
}
string ,
startDateTime:
{
Description: Start Date. ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: End Date. ,
Format: date-time ,
Required: True ,
}
string ,
provider:
{
Description: Provider of satellite data. ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
source:
{
Description: Source of satellite data. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: Data Model for SatelliteIngestionJobRequest. ,
Required: False ,
}
{
imageNames:
{
Description: List of ImageNames. ,
Required: False ,
}
[
string ,
]
,
imageFormats:
{
Description: List of ImageFormats. Available value: TIF. ,
Required: False ,
}
[
string ,
]
,
imageResolutions:
{
Description: List of ImageResolutions in meters. Available values: 10, 20, 60. ,
Required: False ,
}
[
number ,
]
,
}
,
providerClientId:
{
Description: Provider client id for authenticating to provider to pull satellite data. ,
Required: False ,
}
string ,
providerClientSecret:
{
Description: Provider client secret for authenticating to provider to pull satellite data. ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Scenes_GetSatelliteDataIngestionJobDetails (removed)
Description :  Get a satellite data ingestion job.
Reference :  Link ¶

⚼ Request

GET:  /scenes/satellite/ingest-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which satellite data is being fetched. ,
Required: True ,
}
string ,
startDateTime:
{
Description: Start Date. ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: End Date. ,
Format: date-time ,
Required: True ,
}
string ,
provider:
{
Description: Provider of satellite data. ,
Enum:
{
Microsoft: No description available. ,
SentinelHub: No description available. ,
}
,
Required: True ,
}
enum ,
source:
{
Description: Source of satellite data. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
Sentinel_2_L1C: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: Data Model for SatelliteIngestionJobRequest. ,
Required: False ,
}
{
imageNames:
{
Description: List of ImageNames. ,
Required: False ,
}
[
string ,
]
,
imageFormats:
{
Description: List of ImageFormats. Available value: TIF. ,
Required: False ,
}
[
string ,
]
,
imageResolutions:
{
Description: List of ImageResolutions in meters. Available values: 10, 20, 60. ,
Required: False ,
}
[
number ,
]
,
}
,
providerClientId:
{
Description: Provider client id for authenticating to provider to pull satellite data. ,
Required: False ,
}
string ,
providerClientSecret:
{
Description: Provider client secret for authenticating to provider to pull satellite data. ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Scenes_SearchFeatures (removed)
Description :  Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.
Reference :  Link ¶

⚼ Request

POST:  /scenes/stac-collections/{collectionId}:search
{
collectionId:
{
Description: Collection Id to be searched. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: Maximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Skip token for getting next set of results. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
searchFeaturesQuery:
{
Description: Query filters. ,
Required: True ,
}
{
startDateTime:
{
Description: Start datetime of the time interval in which to search for Features. ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: End datetime of the time interval in which to search for Features. ,
Format: date-time ,
Required: True ,
}
string ,
intersects:
{
Description: GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
bbox:
{
Description: Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers. The coordinate reference system of the values is WGS84 longitude/latitude. ,
Required: False ,
}
[
number ,
]
,
featureIds:
{
Description: Array of feature ids to return. ,
Required: False ,
}
[
string ,
]
,
providerClientId:
{
Description: Provider client id for authenticating to provider to pull satellite data. ,
Required: True ,
}
string ,
providerClientSecret:
{
Description: Provider client secret for authenticating to provider to pull satellite data. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
features:
{
Description: List of features. ,
Required: True ,
}
[
{
stacVersion:
{
Description: The STAC version the Feature implements. ,
Required: True ,
}
string ,
stacExtensions:
{
Description: A list of extensions the Feature implements. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Provider identifier. Globally unique ID by Data provider. ,
Required: True ,
}
string ,
type:
{
Description: Type of the GeoJSON Object. It's value is always Feature. ,
Required: True ,
}
string ,
geometry:
{
Description: Defines the full footprint of the asset represented by this item. Its a GeoJSON geometry. ,
Required: False ,
}
object ,
bbox:
{
Description: Bounding box of the feature. ,
Required: False ,
}
[
number ,
]
,
properties:
{
Description: A dictionary of additional metadata for the item. ,
Required: True ,
}
object ,
links:
{
Description: List of link objects to resources and related URLs. ,
Required: True ,
}
[
{
href:
{
Description: The actual link in the format of an URL. ,
Required: True ,
}
string ,
rel:
{
Description: Relationship between the current document and the linked document. ,
Required: True ,
}
string ,
type:
{
Description: Media type of the referenced entity. ,
Required: False ,
}
string ,
title:
{
Description: A human readable title to be used in rendered displays of the link. ,
Required: False ,
}
string ,
}
,
]
,
assets:
{
Description: Dictionary of asset objects, each with a unique key. ,
Required: True ,
}
object ,
collection:
{
Description: The id of the STAC Collection this Feature references. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to do the POST request with same filters, to get next set of features. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Scenes_GetStacFeature (removed)
Description :  Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id.
Reference :  Link ¶

⚼ Request

GET:  /scenes/stac-collections/{collectionId}/features/{featureId}
{
collectionId:
{
Description: Collection Id to be fetched. ,
Required: True ,
}
string ,
featureId:
{
Description: Feature Id to be fetched. ,
Required: True ,
}
string ,
providerClientId:
{
Description: Provider client id for authenticating to provider to pull satellite data. ,
Required: True ,
}
string ,
providerClientSecret:
{
Description: Provider client secret for authenticating to provider to pull satellite data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
stacVersion:
{
Description: The STAC version the Feature implements. ,
Required: True ,
}
string ,
stacExtensions:
{
Description: A list of extensions the Feature implements. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Provider identifier. Globally unique ID by Data provider. ,
Required: True ,
}
string ,
type:
{
Description: Type of the GeoJSON Object. It's value is always Feature. ,
Required: True ,
}
string ,
geometry:
{
Description: Defines the full footprint of the asset represented by this item. Its a GeoJSON geometry. ,
Required: False ,
}
object ,
bbox:
{
Description: Bounding box of the feature. ,
Required: False ,
}
[
number ,
]
,
properties:
{
Description: A dictionary of additional metadata for the item. ,
Required: True ,
}
object ,
links:
{
Description: List of link objects to resources and related URLs. ,
Required: True ,
}
[
{
href:
{
Description: The actual link in the format of an URL. ,
Required: True ,
}
string ,
rel:
{
Description: Relationship between the current document and the linked document. ,
Required: True ,
}
string ,
type:
{
Description: Media type of the referenced entity. ,
Required: False ,
}
string ,
title:
{
Description: A human readable title to be used in rendered displays of the link. ,
Required: False ,
}
string ,
}
,
]
,
assets:
{
Description: Dictionary of asset objects, each with a unique key. ,
Required: True ,
}
object ,
collection:
{
Description: The id of the STAC Collection this Feature references. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_ListByPartyId (removed)
Description :  Returns a paginated list of seasonal field resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/seasonal-fields
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
farmIds:
{
Description: Farm Ids of the resource. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Field Ids of the resource. ,
Required: False ,
}
array ,
seasonIds:
{
Description: Season Ids of the resource. ,
Required: False ,
}
array ,
cropProductIds:
{
Description: CropProductIds of the resource. ,
Required: False ,
}
array ,
cropIds:
{
Description: Ids of the crop it belongs to. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season it belongs to. ,
Required: False ,
}
string ,
cropProductIds:
{
Description: CropProduct ids. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_Get (removed)
Description :  Gets a specified seasonal field resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/seasonal-fields/{seasonalFieldId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Id of the seasonal field. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season it belongs to. ,
Required: False ,
}
string ,
cropProductIds:
{
Description: CropProduct ids. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_CreateOrUpdate (removed)
Description :  Creates or Updates a seasonal field resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/seasonal-fields/{seasonalFieldId}
{
partyId:
{
Description: Id of the associated party resource. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Id of the seasonal field resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
seasonalField:
{
Description: Seasonal field resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season it belongs to. ,
Required: False ,
}
string ,
cropProductIds:
{
Description: CropProduct ids. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season it belongs to. ,
Required: False ,
}
string ,
cropProductIds:
{
Description: CropProduct ids. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season it belongs to. ,
Required: False ,
}
string ,
cropProductIds:
{
Description: CropProduct ids. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_Delete (removed)
Description :  Deletes a specified seasonal-field resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/seasonal-fields/{seasonalFieldId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Id of the seasonal field. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_List (removed)
Description :  Returns a paginated list of seasonal field resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /seasonal-fields
{
farmIds:
{
Description: Farm Ids of the resource. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Field Ids of the resource. ,
Required: False ,
}
array ,
seasonIds:
{
Description: Season Ids of the resource. ,
Required: False ,
}
array ,
cropProductIds:
{
Description: CropProductIds of the resource. ,
Required: False ,
}
array ,
cropIds:
{
Description: Ids of the crop it belongs to. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id. ,
Required: False ,
}
string ,
farmId:
{
Description: Id of the associated Farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated Field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season it belongs to. ,
Required: False ,
}
string ,
cropProductIds:
{
Description: CropProduct ids. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop it belongs to. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for specified seasonal field.
Reference :  Link ¶

⚼ Request

GET:  /seasonal-fields/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SeasonalFields_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified seasonal field.
Reference :  Link ¶

⚼ Request

PUT:  /seasonal-fields/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: ID of the seasonalField to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Seasons_List (removed)
Description :  Returns a paginated list of season resources.
Reference :  Link ¶

⚼ Request

GET:  /seasons
{
minStartDateTime:
{
Description: Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
maxStartDateTime:
{
Description: Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
minEndDateTime:
{
Description: Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
maxEndDateTime:
{
Description: Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
years:
{
Description: Years of the resource. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
startDateTime:
{
Description: Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Season year. ,
Format: int32 ,
Required: False ,
}
integer ,
geographicIdentifier:
{
Description: Geographic Identifier. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Seasons_Get (removed)
Description :  Gets a specified season resource.
Reference :  Link ¶

⚼ Request

GET:  /seasons/{seasonId}
{
seasonId:
{
Description: Id of the season. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
startDateTime:
{
Description: Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Season year. ,
Format: int32 ,
Required: False ,
}
integer ,
geographicIdentifier:
{
Description: Geographic Identifier. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Seasons_CreateOrUpdate (removed)
Description :  Creates or updates a season resource.
Reference :  Link ¶

⚼ Request

PATCH:  /seasons/{seasonId}
{
seasonId:
{
Description: Id of the season resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
season:
{
Description: Season resource payload to create or update. ,
Required: True ,
}
{
startDateTime:
{
Description: Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Season year. ,
Format: int32 ,
Required: False ,
}
integer ,
geographicIdentifier:
{
Description: Geographic Identifier. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
startDateTime:
{
Description: Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Season year. ,
Format: int32 ,
Required: False ,
}
integer ,
geographicIdentifier:
{
Description: Geographic Identifier. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
startDateTime:
{
Description: Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Season year. ,
Format: int32 ,
Required: False ,
}
integer ,
geographicIdentifier:
{
Description: Geographic Identifier. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Seasons_Delete (removed)
Description :  Deletes a specified season resource.
Reference :  Link ¶

⚼ Request

DELETE:  /seasons/{seasonId}
{
seasonId:
{
Description: Id of the season. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorDataModels_List (removed)
Description :  Returns a paginated list of sensor data model resources.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/sensor-data-models
{
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: True ,
}
string ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Sensor manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Sensor productCode. ,
Required: False ,
}
string ,
measures:
{
Description: Map of sensor type to sensor measures. ,
Required: True ,
}
object ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorDataModels_CreateOrUpdate (removed)
Description :  Create a sensor data model entity.
Reference :  Link ¶

⚼ Request

PATCH:  /sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorDataModelId:
{
Description: Id of the sensor data model. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
sensorDataModelObject:
{
Description: Sensor data model object details. ,
Required: True ,
}
{
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Sensor manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Sensor productCode. ,
Required: False ,
}
string ,
measures:
{
Description: Map of sensor type to sensor measures. ,
Required: True ,
}
object ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Sensor manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Sensor productCode. ,
Required: False ,
}
string ,
measures:
{
Description: Map of sensor type to sensor measures. ,
Required: True ,
}
object ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Sensor manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Sensor productCode. ,
Required: False ,
}
string ,
measures:
{
Description: Map of sensor type to sensor measures. ,
Required: True ,
}
object ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorDataModels_Get (removed)
Description :  Gets a sensor data model entity.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorDataModelId:
{
Description: Id of the sensor data model resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Sensor manufacturer. ,
Required: False ,
}
string ,
productCode:
{
Description: Sensor productCode. ,
Required: False ,
}
string ,
measures:
{
Description: Map of sensor type to sensor measures. ,
Required: True ,
}
object ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorDataModels_Delete (removed)
Description :  Deletes a sensor data model entity.
Reference :  Link ¶

⚼ Request

DELETE:  /sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorDataModelId:
{
Description: Id of the sensor data model resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorEvents_List (removed)
Description :  Returns a list of sensor events data. Time span for query is limited to 90 days at a time. Returns last 90 days events when startDateTime and endDateTime are not provided.
Reference :  Link ¶

⚼ Request

GET:  /sensor-events
{
sensorId:
{
Description: Id of the associated sensor. ,
Required: True ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: True ,
}
string ,
startDateTime:
{
Description: Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. It is truncated upto seconds if fraction is provided. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. It is truncated upto seconds if fraction is provided. ,
Format: date-time ,
Required: False ,
}
string ,
excludeDuplicateEvents:
{
Description: Flag to exclude duplicate events and take the latest ones only (Default: false). ,
Required: False ,
}
boolean ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
sensorId:
{
Description: Id of the sensor. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
eventDateTime:
{
Description: DateTime of sensor event observation. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionDateTime:
{
Description: DateTime of sensor event ingestion to data store. ,
Format: date-time ,
Required: False ,
}
string ,
measures:
{
Description: Sensor measures. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorMappings_List (removed)
Description :  Returns a paginated list of sensor mapping resources.
Reference :  Link ¶

⚼ Request

GET:  /sensor-mappings
{
sensorIds:
{
Description: Id of the sensors. ,
Required: False ,
}
array ,
sensorPartnerIds:
{
Description: Id of the sensor partners. ,
Required: False ,
}
array ,
partyIds:
{
Description: Id of the parties. ,
Required: False ,
}
array ,
boundaryIds:
{
Description: Id of the boundaries. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
sensorId:
{
Description: Id of the associated sensor. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorMappings_CreateOrUpdate (removed)
Description :  Create a sensor mapping entity.
Reference :  Link ¶

⚼ Request

PATCH:  /sensor-mappings/{sensorMappingId}
{
sensorMappingId:
{
Description: Id of the sensor mapping. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
sensorMappingObject:
{
Description: Sensor mapping object details. ,
Required: True ,
}
{
sensorId:
{
Description: Id of the associated sensor. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
sensorId:
{
Description: Id of the associated sensor. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
sensorId:
{
Description: Id of the associated sensor. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorMappings_Get (removed)
Description :  Gets a sensor mapping entity.
Reference :  Link ¶

⚼ Request

GET:  /sensor-mappings/{sensorMappingId}
{
sensorMappingId:
{
Description: Id of the sensor mapping resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sensorId:
{
Description: Id of the associated sensor. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the associated party. ,
Required: False ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorMappings_Delete (removed)
Description :  Deletes a sensor mapping entity.
Reference :  Link ¶

⚼ Request

DELETE:  /sensor-mappings/{sensorMappingId}
{
sensorMappingId:
{
Description: Id of the sensor mapping resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorPartnerIntegrations_List (removed)
Description :  Gets partner integration models.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/integrations
{
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: True ,
}
string ,
partyIds:
{
Description: Ids of the parties. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
integrationId:
{
Description: Id of the integration. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorPartnerIntegrations_CreateOrUpdate (removed)
Description :  Create or update an integration with a sensor partner.
Reference :  Link ¶

⚼ Request

PATCH:  /sensor-partners/{sensorPartnerId}/integrations/{integrationId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
integrationId:
{
Description: Id of the integration to be created. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
sensorPartnerIntegrationModel:
{
Description: Partner integration model. ,
Required: True ,
}
{
integrationId:
{
Description: Id of the integration. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
integrationId:
{
Description: Id of the integration. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
integrationId:
{
Description: Id of the integration. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorPartnerIntegrations_Get (removed)
Description :  Gets a partner integration model entity.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/integrations/{integrationId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
integrationId:
{
Description: Id of the integration object. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
integrationId:
{
Description: Id of the integration. ,
Required: False ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: False ,
}
string ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorPartnerIntegrations_Delete (removed)
Description :  Deletes a partner integration model entity.
Reference :  Link ¶

⚼ Request

DELETE:  /sensor-partners/{sensorPartnerId}/integrations/{integrationId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
integrationId:
{
Description: Id of the integration to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SensorPartnerIntegrations_CheckConsent (removed)
Description :  Checks consent for partner integration.
Reference :  Link ¶

⚼ Request

POST:  /sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
integrationId:
{
Description: Id of the integration object. ,
Required: True ,
}
string ,
key:
{
Description: Partner integration key. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
consented:
{
Description: Flag to determine the status of partner integration consent. ,
Required: False ,
}
boolean ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
integrationId:
{
Description: Id of the integration. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Sensors_List (removed)
Description :  Returns a paginated list of sensor resources.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/sensors
{
sensorDataModelIds:
{
Description: Id's of the sensor data models. ,
Required: False ,
}
array ,
sensorMappingIds:
{
Description: Ids of the sensor mappings. ,
Required: False ,
}
array ,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: True ,
}
string ,
deviceIds:
{
Description: Id's of the devices. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
sensorDataModelId:
{
Description: Id of the associated sensor data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Id of the associated hardware. ,
Required: False ,
}
string ,
deviceId:
{
Description: Id of the associated device. ,
Required: False ,
}
string ,
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
port:
{
Description: Schema for storing port values. ,
Required: False ,
}
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
depthInMeters:
{
Description: Depth of each sensor measure in meters. Like sensor moisture at 2m, 4m, 6m. ,
Required: False ,
}
[
number ,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Sensors_CreateOrUpdate (removed)
Description :  Create a sensor entity.
Reference :  Link ¶

⚼ Request

PATCH:  /sensor-partners/{sensorPartnerId}/sensors/{sensorId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorId:
{
Description: Id of the sensor resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
sensorDetails:
{
Description: Sensor object details. ,
Required: True ,
}
{
sensorDataModelId:
{
Description: Id of the associated sensor data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Id of the associated hardware. ,
Required: False ,
}
string ,
deviceId:
{
Description: Id of the associated device. ,
Required: False ,
}
string ,
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
port:
{
Description: Schema for storing port values. ,
Required: False ,
}
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
depthInMeters:
{
Description: Depth of each sensor measure in meters. Like sensor moisture at 2m, 4m, 6m. ,
Required: False ,
}
[
number ,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
sensorDataModelId:
{
Description: Id of the associated sensor data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Id of the associated hardware. ,
Required: False ,
}
string ,
deviceId:
{
Description: Id of the associated device. ,
Required: False ,
}
string ,
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
port:
{
Description: Schema for storing port values. ,
Required: False ,
}
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
depthInMeters:
{
Description: Depth of each sensor measure in meters. Like sensor moisture at 2m, 4m, 6m. ,
Required: False ,
}
[
number ,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
sensorDataModelId:
{
Description: Id of the associated sensor data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Id of the associated hardware. ,
Required: False ,
}
string ,
deviceId:
{
Description: Id of the associated device. ,
Required: False ,
}
string ,
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
port:
{
Description: Schema for storing port values. ,
Required: False ,
}
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
depthInMeters:
{
Description: Depth of each sensor measure in meters. Like sensor moisture at 2m, 4m, 6m. ,
Required: False ,
}
[
number ,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Sensors_Get (removed)
Description :  Gets a sensor entity.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/sensors/{sensorId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorId:
{
Description: Id of the sensor resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sensorDataModelId:
{
Description: Id of the associated sensor data model. ,
Required: False ,
}
string ,
integrationId:
{
Description: Integration id for the device. ,
Required: False ,
}
string ,
hardwareId:
{
Description: Id of the associated hardware. ,
Required: False ,
}
string ,
deviceId:
{
Description: Id of the associated device. ,
Required: False ,
}
string ,
type:
{
Description: Type of sensor. ,
Required: False ,
}
string ,
location:
{
Description: Location model class. ,
Required: False ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
port:
{
Description: Schema for storing port values. ,
Required: False ,
}
{
name:
{
Description: Name of the port. ,
Required: False ,
}
string ,
type:
{
Description: Type of port digital/analog. ,
Required: False ,
}
string ,
}
,
depthInMeters:
{
Description: Depth of each sensor measure in meters. Like sensor moisture at 2m, 4m, 6m. ,
Required: False ,
}
[
number ,
]
,
sensorPartnerId:
{
Description: Id of the associated sensor partner. ,
Required: False ,
}
string ,
id:
{
Description: Id of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Sensors_Delete (removed)
Description :  Deletes a sensor entity.
Reference :  Link ¶

⚼ Request

DELETE:  /sensor-partners/{sensorPartnerId}/sensors/{sensorId}
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorId:
{
Description: Id of the sensor resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Sensors_GetConnectionString (removed)
Description :  Gets a sensor connection string.
Reference :  Link ¶

⚼ Request

GET:  /sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorId:
{
Description: Id of the sensor resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryDeviceConnectionString:
{
Description: Primary connection string of the ioTHub device. ,
Required: False ,
}
string ,
secondaryDeviceConnectionString:
{
Description: Secondary connection string of the ioTHub device. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Sensors_RenewConnectionString (removed)
Description :  Renews a sensor connection string.
Reference :  Link ¶

⚼ Request

POST:  /sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings/:renew
{
sensorPartnerId:
{
Description: Id of the sensor partner. ,
Required: True ,
}
string ,
sensorId:
{
Description: Id of the sensor resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
renewConnectionStringModel:
{
Description: Sensor's connection string model. ,
Required: True ,
}
{
connectionStringType:
{
Description: Specifies the type of connection string key to be renewed valid values - Primary/Secondary/Both. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
Both: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
primaryDeviceConnectionString:
{
Description: Primary connection string of the ioTHub device. ,
Required: False ,
}
string ,
secondaryDeviceConnectionString:
{
Description: Secondary connection string of the ioTHub device. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SolutionInference_Cancel (removed)
Description :  Cancels a job for given solution id.
Reference :  Link ¶

⚼ Request

POST:  /solutions/{solutionId}:cancel
{
solutionId:
{
Description: Id of solution for which job is to be cancelled. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
solutionInferenceRequest:
{
Description: solutionInferenceRequest containing input needed for job request processing. ,
Required: True ,
}
{
requestPath:
{
Description: RequestPath containing the api-version, query parameters and path route to be called for partner request. Expected format is "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Not following this format may result into validation errors. ,
Required: True ,
}
string ,
partnerRequestBody:
{
Description: Api input parameters required by partner to trigger/cancel job request. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SolutionInference_CreateOrUpdate (removed)
Description :  Creates a job trigger for a solution.
Reference :  Link ¶

⚼ Request

POST:  /solutions/{solutionId}:create
{
solutionId:
{
Description: Id of the solution resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
solutionInferenceRequest:
{
Description: solutionInferenceRequest containing input needed for job request processing. ,
Required: True ,
}
{
requestPath:
{
Description: RequestPath containing the api-version, query parameters and path route to be called for partner request. Expected format is "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Not following this format may result into validation errors. ,
Required: True ,
}
string ,
partnerRequestBody:
{
Description: Api input parameters required by partner to trigger/cancel job request. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
SolutionInference_Fetch (removed)
Description :  Fetches details of triggered job for a solution.
Reference :  Link ¶

⚼ Request

POST:  /solutions/{solutionId}:fetch
{
solutionId:
{
Description: Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
solutionInferenceRequest:
{
Description: solutionInferenceRequest containing input needed for job request processing. ,
Required: True ,
}
{
requestPath:
{
Description: RequestPath containing the api-version, query parameters and path route to be called for partner request. Expected format is "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Not following this format may result into validation errors. ,
Required: True ,
}
string ,
partnerRequestBody:
{
Description: Api input parameters required by partner to trigger/cancel job request. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
TillageData_ListByPartyId (removed)
Description :  Returns a paginated list of tillage data resources under a particular farm.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/tillage-data
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
minTillageDepth:
{
Description: Minimum measured tillage depth (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTillageDepth:
{
Description: Maximum measured tillage depth (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTillagePressure:
{
Description: Minimum pressure applied to a tillage implement (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTillagePressure:
{
Description: Maximum pressure applied to a tillage implement (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
TillageData_Get (removed)
Description :  Get a specified tillage data resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/tillage-data/{tillageDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: ID of the tillage data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
TillageData_CreateOrUpdate (removed)
Description :  Creates or updates an tillage data resource under a particular party.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/tillage-data/{tillageDataId}
{
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: ID of the tillage data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
tillageData:
{
Description: Tillage data resource payload to create or update. ,
Required: True ,
}
{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
TillageData_Delete (removed)
Description :  Deletes a specified tillage data resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/tillage-data/{tillageDataId}
{
partyId:
{
Description: ID of the associated party resource. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: ID of the tillage data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
TillageData_List (removed)
Description :  Returns a paginated list of tillage data resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /tillage-data
{
minTillageDepth:
{
Description: Minimum measured tillage depth (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTillageDepth:
{
Description: Maximum measured tillage depth (inclusive). ,
Format: double ,
Required: False ,
}
number ,
minTillagePressure:
{
Description: Minimum pressure applied to a tillage implement (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxTillagePressure:
{
Description: Maximum pressure applied to a tillage implement (inclusive). ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Sources of the operation data. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: Boundary IDs associated with operation data. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Minimum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Maximum area for which operation was applied (inclusive). ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
operationModifiedDateTime:
{
Description: Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link for attachments. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Optional boundary ID of the field for which operation was applied. ,
Required: False ,
}
string ,
partyId:
{
Description: Party ID which belongs to the operation data. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
TillageData_CreateCascadeDeleteJob (removed)
Description :  Create cascade delete job for tillage data resource.
Reference :  Link ¶

⚼ Request

PUT:  /tillage-data/cascade-delete/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: Id of the tillage data. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
TillageData_GetCascadeDeleteJobDetails (removed)
Description :  Get cascade delete job for tillage data resource.
Reference :  Link ¶

⚼ Request

GET:  /tillage-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Weather_List (removed)
Description :  Returns a paginated list of weather data.
Reference :  Link ¶

⚼ Request

GET:  /weather
{
partyId:
{
Description: Party ID. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Boundary ID. ,
Required: True ,
}
string ,
extensionId:
{
Description: ID of the weather extension. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: True ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: True ,
}
string ,
startDateTime:
{
Description: Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party ID. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Boundary ID. ,
Required: True ,
}
string ,
extensionId:
{
Description: ID of the weather extension. ,
Required: True ,
}
string ,
location:
{
Description: Location model class. ,
Required: True ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
dateTime:
{
Description: Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: True ,
}
string ,
unitSystemCode:
{
Description: Unit System like US/SI etc. ,
Required: False ,
}
string ,
extensionVersion:
{
Description: Version of the weather data extension. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: True ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: True ,
}
string ,
cloudCover:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
dewPoint:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
growingDegreeDay:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
precipitation:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
pressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
relativeHumidity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
soilMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
soilTemperature:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
temperature:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
visibility:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
wetBulbTemperature:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windChill:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windDirection:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windGust:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
id:
{
Description: Weather data ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
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 25 key value pairs can be provided for a resource and only string and numeral values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Weather_GetDataDeleteJobDetails (removed)
Description :  Get weather data delete job.
Reference :  Link ¶

⚼ Request

GET:  /weather/delete-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
partyId:
{
Description: The id of the party for which weather data is being fetched. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which weather data is being fetched. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data. Possible values include: 'forecast' , 'historical'. ,
Required: False ,
}
string ,
granularity:
{
Description: Granularity of weather data. Possible values include: 'daily' , 'hourly'. ,
Required: False ,
}
string ,
startDateTime:
{
Description: Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Weather_CreateDataDeleteJob (removed)
Description :  Create a weather data delete job.
Reference :  Link ¶

⚼ Request

PUT:  /weather/delete-data/{jobId}
{
jobId:
{
Description: Job Id supplied by end user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
partyId:
{
Description: The id of the party for which weather data is being fetched. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which weather data is being fetched. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data. Possible values include: 'forecast' , 'historical'. ,
Required: False ,
}
string ,
granularity:
{
Description: Granularity of weather data. Possible values include: 'daily' , 'hourly'. ,
Required: False ,
}
string ,
startDateTime:
{
Description: Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
partyId:
{
Description: The id of the party for which weather data is being fetched. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary object for which weather data is being fetched. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data. Possible values include: 'forecast' , 'historical'. ,
Required: False ,
}
string ,
granularity:
{
Description: Granularity of weather data. Possible values include: 'daily' , 'hourly'. ,
Required: False ,
}
string ,
startDateTime:
{
Description: Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Weather_GetDataIngestionJobDetails (removed)
Description :  Get weather ingestion job.
Reference :  Link ¶

⚼ Request

GET:  /weather/ingest-data/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boundaryId:
{
Description: The id of the boundary object for which weather data is being fetched. ,
Required: True ,
}
string ,
partyId:
{
Description: The id of the party for which weather data is being fetched. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which request is to be made. ,
Required: True ,
}
string ,
extensionApiInput:
{
Description: Extension api input dictionary which would be used to feed request query/body/parameter information. ,
Required: True ,
}
object ,
extensionDataProviderAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
extensionDataProviderApiKey:
{
Description: Api key of the weather data provider. ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Weather_CreateDataIngestionJob (removed)
Description :  Create a weather data ingestion job.
Reference :  Link ¶

⚼ Request

PUT:  /weather/ingest-data/{jobId}
{
jobId:
{
Description: Job id supplied by user. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by user. ,
Required: True ,
}
{
boundaryId:
{
Description: The id of the boundary object for which weather data is being fetched. ,
Required: True ,
}
string ,
partyId:
{
Description: The id of the party for which weather data is being fetched. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which request is to be made. ,
Required: True ,
}
string ,
extensionApiInput:
{
Description: Extension api input dictionary which would be used to feed request query/body/parameter information. ,
Required: True ,
}
object ,
extensionDataProviderAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
extensionDataProviderApiKey:
{
Description: Api key of the weather data provider. ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
boundaryId:
{
Description: The id of the boundary object for which weather data is being fetched. ,
Required: True ,
}
string ,
partyId:
{
Description: The id of the party for which weather data is being fetched. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which request is to be made. ,
Required: True ,
}
string ,
extensionApiInput:
{
Description: Extension api input dictionary which would be used to feed request query/body/parameter information. ,
Required: True ,
}
object ,
extensionDataProviderAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
extensionDataProviderApiKey:
{
Description: Api key of the weather data provider. ,
Required: False ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
WeatherData_Get (removed)
Description :  Returns a list of WeatherData.
Reference :  Link ¶

⚼ Request

POST:  /weather-data/:fetch
{
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
weatherDataProviderRequest:
{
Description: Weather data provider request. ,
Required: True ,
}
{
locations:
{
Description: List of locations for which weather data need to be fetched from the provider. ,
Required: False ,
}
[
{
type:
{
Description: Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. ,
Enum:
{
LatLong: No description available. ,
IataCode: No description available. ,
IcaoCode: No description available. ,
PlaceId: No description available. ,
PostalKey: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Location Value eg. "10,-25" for LocationType Type "LatLong". ,
Required: True ,
}
string ,
}
,
]
,
providerAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
providerApiKey:
{
Description: Api key of the weather data provider. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which request is to be made. ,
Required: True ,
}
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'. ,
Required: False ,
}
string ,
startTimeHours:
{
Description: Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.) ,
Format: int32 ,
Required: False ,
}
integer ,
endTimeHours:
{
Description: End of time range. Supported ranges are from 0 to 240. (Only applicable for DTN.ClearAg extension.) ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
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.) ,
Format: int32 ,
Required: False ,
}
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. ,
Required: True ,
}
string ,
additionalParams:
{
Description: Schema of additional parameters for weather data provider request. ,
Required: False ,
}
{
iconResolution:
{
Description: Icon Resolution (Only applicable for AzureWeatherMaps). ,
Required: False ,
}
string ,
details:
{
Description: Details (Only applicable for AzureWeatherMaps). ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-cache-hit:
{
Description: Indicate whether the request was cache hit or cache miss. ,
}
boolean ,
x-ms-response-latency-in-milliseconds:
{
Description: Time taken in milliseconds for processing the request at server side. ,
}
integer ,
}
,
$schema:
{
Description: Schema of Weather Data Provider Response. ,
}
{
weatherMetadata:
{
Description: Schema of Weather Metadata. ,
Required: True ,
}
{
extensionVersion:
{
Description: Version of the weather data extension. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg. ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which request is to be made. ,
Required: True ,
}
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'. ,
Required: False ,
}
string ,
startTimeHours:
{
Description: Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.) ,
Format: int32 ,
Required: False ,
}
integer ,
endTimeHours:
{
Description: End of time range. (Only applicable for DTN.ClearAg extension.) ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
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.) ,
Format: int32 ,
Required: False ,
}
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. ,
Required: True ,
}
string ,
additionalParams:
{
Description: Schema of additional parameters for weather data provider request. ,
Required: False ,
}
{
iconResolution:
{
Description: Icon Resolution (Only applicable for AzureWeatherMaps). ,
Required: False ,
}
string ,
details:
{
Description: Details (Only applicable for AzureWeatherMaps). ,
Required: False ,
}
boolean ,
}
,
}
,
status:
{
Description: Indicates a Succeeded, Failed, or PartiallySucceeded response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: List of weather data for all the weather locations. ,
Required: False ,
}
[
{
location:
{
Description: Schema of Location data. ,
Required: False ,
}
{
type:
{
Description: Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. ,
Enum:
{
LatLong: No description available. ,
IataCode: No description available. ,
IcaoCode: No description available. ,
PlaceId: No description available. ,
PostalKey: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Location Value eg. "10,-25" for LocationType Type "LatLong". ,
Required: True ,
}
string ,
}
,
requestCompletionTime:
{
Description: Request Completion Time in Utc of the location. ,
Required: False ,
}
string ,
lastRefreshedDateTime:
{
Description: Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
data:
{
Description: Schema of weather data. ,
Required: False ,
}
{
wetBulbTemperature:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
cloudCover:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
dayOfWeek:
{
Description: Day of week. ,
Required: False ,
}
[
string ,
]
,
dayOrNight:
{
Description: This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location. ,
Required: False ,
}
[
string ,
]
,
expirationTime:
{
Description: Expiration time in Utc format. ,
Required: False ,
}
[
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. ,
Required: False ,
}
[
string ,
]
,
iconCodeExtend:
{
Description: Code representing full set sensible weather. ,
Required: False ,
}
[
string ,
]
,
hasPrecipitation:
{
Description: Indicates whether there is precipitation or not. ,
Required: False ,
}
[
boolean ,
]
,
pressureMeanSeaLevel:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
relativeHumidity:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
temperature:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
temperatureDewPoint:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
temperatureFeelsLike:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
temperatureHeatIndex:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
temperatureWindChill:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
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). ,
Required: False ,
}
[
string ,
]
,
uvIndex:
{
Description: Hourly maximum UV index. ,
Required: False ,
}
[
string ,
]
,
validTimeLocal:
{
Description: Time forecast is valid in local apparent time. ,
Required: False ,
}
[
string ,
]
,
validTime:
{
Description: Time forecast is valid in Utc format. ,
Required: False ,
}
[
string ,
]
,
visibility:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
windDirection:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
windGust:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
windSpeed:
{
Description: Schema for storing measurement readings and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
values:
{
Description: Data values. ,
Required: False ,
}
[
number ,
]
,
}
,
wxPhraseLong:
{
Description: Hourly sensible weather phrase containing longer description. ,
Required: False ,
}
[
string ,
]
,
wxPhraseShort:
{
Description: Hourly sensible weather phrase containing short description. ,
Required: False ,
}
[
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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
errors:
{
Description: Model for errors encountered for all failed locations. ,
Required: False ,
}
{
locations:
{
Description: List of errors encountered for all failed locations. ,
Required: False ,
}
[
{
location:
{
Description: Schema of Location data. ,
Required: False ,
}
{
type:
{
Description: Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. ,
Enum:
{
LatLong: No description available. ,
IataCode: No description available. ,
IcaoCode: No description available. ,
PlaceId: No description available. ,
PostalKey: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Location Value eg. "10,-25" for LocationType Type "LatLong". ,
Required: True ,
}
string ,
}
,
code:
{
Description: Status code returned by data provider. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description of the error. ,
Required: False ,
}
string ,
retryable:
{
Description: Flag suggesting if retry attempt with same request body should be made to fetch required data. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_ListByPartyId (removed)
Description :  Returns a paginated list of zone resources under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/zones
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
types:
{
Description: Types of the Zones. ,
Required: False ,
}
array ,
managementZoneIds:
{
Description: ManagementZoneIds of the Zones. ,
Required: False ,
}
array ,
sources:
{
Description: Sources of the Zones. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id associated with the Zone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Zone. ,
Required: False ,
}
string ,
managementZoneId:
{
Description: Management Zone Id associated with the Zone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_Get (removed)
Description :  Gets a specified zone resource under a particular party.
Reference :  Link ¶

⚼ Request

GET:  /parties/{partyId}/zones/{zoneId}
{
partyId:
{
Description: Id of the associated party. ,
Required: True ,
}
string ,
zoneId:
{
Description: Id of the zone. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id associated with the Zone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Zone. ,
Required: False ,
}
string ,
managementZoneId:
{
Description: Management Zone Id associated with the Zone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_CreateOrUpdate (removed)
Description :  Creates or updates a Zone resource.
Reference :  Link ¶

⚼ Request

PATCH:  /parties/{partyId}/zones/{zoneId}
{
partyId:
{
Description: Id of the party resource. ,
Required: True ,
}
string ,
zoneId:
{
Description: Id of the zone resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
zone:
{
Description: Zone resource payload to create or update. ,
Required: True ,
}
{
partyId:
{
Description: Party Id associated with the Zone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Zone. ,
Required: False ,
}
string ,
managementZoneId:
{
Description: Management Zone Id associated with the Zone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id associated with the Zone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Zone. ,
Required: False ,
}
string ,
managementZoneId:
{
Description: Management Zone Id associated with the Zone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
partyId:
{
Description: Party Id associated with the Zone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Zone. ,
Required: False ,
}
string ,
managementZoneId:
{
Description: Management Zone Id associated with the Zone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_Delete (removed)
Description :  Deletes a specified zone resource under a particular party.
Reference :  Link ¶

⚼ Request

DELETE:  /parties/{partyId}/zones/{zoneId}
{
partyId:
{
Description: Id of the party. ,
Required: True ,
}
string ,
zoneId:
{
Description: Id of the zone. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_List (removed)
Description :  Returns a paginated list of zone resources across all parties.
Reference :  Link ¶

⚼ Request

GET:  /zones
{
types:
{
Description: Types of the Zones. ,
Required: False ,
}
array ,
managementZoneIds:
{
Description: ManagementZoneIds of the Zones. ,
Required: False ,
}
array ,
sources:
{
Description: Sources of the Zones. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: True ,
}
[
{
partyId:
{
Description: Party Id associated with the Zone. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Zone. ,
Required: False ,
}
string ,
managementZoneId:
{
Description: Management Zone Id associated with the Zone. ,
Required: False ,
}
string ,
id:
{
Description: Unique resource ID. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name to identify resource. ,
Required: False ,
}
string ,
description:
{
Description: Textual description of the resource. ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user/tenant id. ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified by user/tenant id. ,
Required: False ,
}
string ,
properties:
{
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 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. ,
Required: False ,
}
object ,
}
,
]
,
skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_GetCascadeDeleteJobDetails (removed)
Description :  Get a cascade delete job for specified job id.
Reference :  Link ¶

⚼ Request

GET:  /zones/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}
Zones_CreateCascadeDeleteJob (removed)
Description :  Create a cascade delete job for specified zone.
Reference :  Link ¶

⚼ Request

PUT:  /zones/cascade-delete/{jobId}
{
jobId:
{
Description: Job ID supplied by end user. ,
Required: True ,
}
string ,
partyId:
{
Description: ID of the associated party. ,
Required: True ,
}
string ,
zoneId:
{
Description: ID of the zone to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
partyId:
{
Description: Party Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
id:
{
Description: Unique job id. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Duration of the job in seconds. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Status message to capture more details of the job. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error Code when job failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
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. ,
}
{
error:
{
Description: An error from the Azure AgPlatform service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
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. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
,
}