Sensor Mappings - List
Returns a paginated list of sensor mapping resources.
GET {endpoint}/sensor-mappings?api-version=2023-11-01-preview
GET {endpoint}/sensor-mappings?sensorIds={sensorIds}&sensorPartnerIds={sensorPartnerIds}&partyIds={partyIds}&associatedResourceIds={associatedResourceIds}&associatedResourceType={associatedResourceType}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net |
api-version
|
query | True |
string |
The requested API version |
associated
|
query |
string[] |
Resource Ids of the resource. |
|
associated
|
query |
string |
Resource Types of the resource. i.e. Farmer, Farm, Field, SeasonalField, FarmOperationApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis. |
|
ids
|
query |
string[] |
Ids of the resource. |
|
max
|
query |
string date-time |
Maximum creation date of resource (inclusive). |
|
max
|
query |
string date-time |
Maximum last modified date of resource (inclusive). |
|
max
|
query |
integer int32 |
Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. |
|
min
|
query |
string date-time |
Minimum creation date of resource (inclusive). |
|
min
|
query |
string date-time |
Minimum last modified date of resource (inclusive). |
|
names
|
query |
string[] |
Names of the resource. |
|
party
|
query |
string[] |
Id of the parties. |
|
property
|
query |
string[] |
Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". |
|
sensor
|
query |
string[] |
Id of the sensors. |
|
sensor
|
query |
string[] |
Id of the sensor partners. |
|
skip
|
query |
string |
Skip token for getting next set of results. |
|
statuses
|
query |
string[] |
Statuses of the resource. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Authorization | True |
string |
Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
Error Headers x-ms-error-code: string |
Security
Authorization
Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.
Type:
apiKey
In:
header
Examples
SensorMappings_List
Sample request
GET {endpoint}/sensor-mappings?api-version=2023-11-01-preview
Sample response
{
"value": [
{
"sensorId": "s124",
"sensorPartnerId": "sp1",
"partyId": "aksaxena-party",
"associatedResource": {
"type": "Field",
"id": "Field123"
},
"id": "sm124",
"status": "sensor map created",
"createdDateTime": "2022-01-24T06:40:48Z",
"modifiedDateTime": "2022-01-24T06:41:05Z",
"eTag": "0501f236-0000-0700-0000-61ee4a010000",
"name": "my new sensor map",
"description": "description for mapping",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
],
"skipToken": "skipToken",
"nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}
Definitions
Name | Description |
---|---|
Error |
An error from the Azure AgPlatform service. |
Error |
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. |
Farm |
Resource Type. |
Geo |
Schema for storing resource type and resource id. |
Inner |
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. |
Sensor |
SensorMapping API model. |
Sensor |
Paged response contains list of requested objects and a URL link to get the next set of results. |
Error
An error from the Azure AgPlatform service.
Name | Type | Description |
---|---|---|
code |
string |
Server-defined set of error codes. |
details |
Error[] |
Array of details about specific errors that led to this reported error. |
innererror |
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. |
|
message |
string |
Human-readable representation of the error. |
target |
string |
Target of the error. |
ErrorResponse
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.
Name | Type | Description |
---|---|---|
error |
An error from the Azure AgPlatform service. |
|
traceId |
string |
Unique trace Id. |
FarmHierarchyGeoResourceType
Resource Type.
Name | Type | Description |
---|---|---|
ApplicationData |
string |
|
Field |
string |
|
HarvestData |
string |
|
PlantTissueAnalysis |
string |
|
PlantingData |
string |
|
Prescription |
string |
|
SeasonalField |
string |
|
TillageData |
string |
|
Zone |
string |
GeoResource
Schema for storing resource type and resource id.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id. |
type |
Resource Type. |
InnerError
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
Name | Type | Description |
---|---|---|
code |
string |
Specific error code than was provided by the containing error. |
innererror |
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. |
SensorMapping
SensorMapping API model.
Name | Type | Description |
---|---|---|
associatedResource |
Schema for storing resource type and resource id. |
|
createdBy |
string |
Created by user/tenant id. |
createdDateTime |
string |
Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. |
description |
string |
Textual description of the resource. |
eTag |
string |
The ETag value to implement optimistic concurrency. |
id |
string |
Id of the resource. |
modifiedBy |
string |
Modified by user/tenant id. |
modifiedDateTime |
string |
Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. |
name |
string |
Name to identify resource. |
partyId |
string |
Id of the associated party. |
properties |
|
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. |
sensorId |
string |
Id of the associated sensor. |
sensorPartnerId |
string |
Id of the associated sensor partner. |
status |
string |
Status of the resource. |
SensorMappingListResponse
Paged response contains list of requested objects and a URL link to get the next set of results.
Name | Type | Description |
---|---|---|
nextLink |
string |
Continuation link (absolute URI) to the next page of results in the list. |
skipToken |
string |
Token used in retrieving the next page. If null, there are no additional pages. |
value |
List of requested objects. |