Sensor Data Models - Create Or Update
Cree una entidad de modelo de datos del sensor.
PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}?api-version=2023-11-01-preview
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
Nombre de host del espacio de nombres, por ejemplo, admaInstanceName.farmbeats.azure.net |
sensor
|
path | True |
string |
Identificador del modelo de datos del sensor. |
sensor
|
path | True |
string |
Identificador del asociado del sensor. |
api-version
|
query | True |
string |
La versión de API solicitada |
Encabezado de la solicitud
Media Types: "application/merge-patch+json"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
Authorization | True |
string |
Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes. |
Cuerpo de la solicitud
Media Types: "application/merge-patch+json"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
measures | True |
<string,
Sensor |
Mapa del tipo de sensor a las medidas del sensor. |
description |
string |
Descripción textual del recurso. |
|
manufacturer |
string |
Fabricante del sensor. |
|
name |
string |
Nombre para identificar el recurso. |
|
productCode |
string |
Sensor productCode. |
|
properties |
Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ). |
||
status |
string |
Estado del recurso. |
|
type |
string |
Tipo de sensor. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Correcto |
|
201 Created |
Creado |
|
Other Status Codes |
Error Encabezados x-ms-error-code: string |
Seguridad
Authorization
Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.
Tipo:
apiKey
En:
header
Ejemplos
SensorDataModels_CreateOrUpdate
Solicitud de ejemplo
PATCH {endpoint}/sensor-partners/sp1/sensor-data-models/sdm124?api-version=2023-11-01-preview
{
"type": "Sensor",
"manufacturer": "Some sensor manufacturer",
"productCode": "soil m",
"measures": {
"soilMoisture": {
"description": "measures soil moisture",
"dataType": "Bool",
"type": "sm",
"unit": "none",
"properties": {
"abc": "def",
"elevation": 5
}
}
},
"status": "new",
"name": "my sdm for soil moisture",
"description": "description goes here",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
Respuesta de muestra
{
"type": "Sensor",
"manufacturer": "Some sensor manufacturer",
"productCode": "soil m",
"measures": {
"soilMoisture": {
"description": "measures soil moisture",
"dataType": "Bool",
"type": "sm",
"unit": "none",
"properties": {
"abc": "def",
"elevation": 5
}
}
},
"sensorPartnerId": "sp1",
"id": "sdm124",
"status": "new",
"createdDateTime": "2022-01-24T06:12:15Z",
"modifiedDateTime": "2022-01-24T06:12:42Z",
"eTag": "040161a2-0000-0700-0000-61ee435a0000",
"name": "my sdm for soil moisture",
"description": "description goes here",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
{
"type": "Sensor",
"manufacturer": "Some sensor manufacturer",
"productCode": "soil m",
"measures": {
"soilMoisture": {
"description": "measures soil moisture",
"dataType": "Bool",
"type": "sm",
"unit": "none",
"properties": {
"abc": "def",
"elevation": 5
}
}
},
"sensorPartnerId": "sp1",
"id": "sdm124",
"status": "new",
"createdDateTime": "2022-01-24T06:12:15Z",
"modifiedDateTime": "2022-01-24T06:12:15Z",
"eTag": "040158a0-0000-0700-0000-61ee433f0000",
"name": "my sdm for soil moisture",
"description": "description goes here",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
Definiciones
Nombre | Description |
---|---|
Error |
Error del servicio Azure AgPlatform. |
Error |
Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses el documento de referencia ErrorResponse. |
Inner |
Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError. |
Sensor |
Modelo de API sensorModel. |
Sensor |
Detalles de la medida del modelo del sensor. |
Sensor |
Sensor mide el tipo de datos. |
Error
Error del servicio Azure AgPlatform.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Conjunto definido por el servidor de códigos de error. |
details |
Error[] |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
innererror |
Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError. |
|
message |
string |
Representación legible del error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses el documento de referencia ErrorResponse.
Nombre | Tipo | Description |
---|---|---|
error |
Error del servicio Azure AgPlatform. |
|
traceId |
string |
Identificador de seguimiento único. |
InnerError
Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error específico del proporcionado por el error contenedor. |
innererror |
Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError. |
SensorDataModel
Modelo de API sensorModel.
Nombre | Tipo | Description |
---|---|---|
createdBy |
string |
Creado por el identificador de usuario o inquilino. |
createdDateTime |
string |
Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ. |
description |
string |
Descripción textual del recurso. |
eTag |
string |
Valor ETag para implementar la simultaneidad optimista. |
id |
string |
Identificador del recurso. |
manufacturer |
string |
Fabricante del sensor. |
measures |
<string,
Sensor |
Mapa del tipo de sensor a las medidas del sensor. |
modifiedBy |
string |
Modificado por el identificador de usuario o inquilino. |
modifiedDateTime |
string |
Fecha y hora en que se modificó por última vez el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ. |
name |
string |
Nombre para identificar el recurso. |
productCode |
string |
Sensor productCode. |
properties |
Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ). |
|
sensorPartnerId |
string |
Identificador del asociado del sensor asociado. |
status |
string |
Estado del recurso. |
type |
string |
Tipo de sensor. |
SensorDataModelMeasure
Detalles de la medida del modelo del sensor.
Nombre | Tipo | Description |
---|---|---|
dataType |
Sensor mide el tipo de datos. |
|
description |
string |
Descripción de la medida del sensor. |
properties |
Colección de pares clave-valor para el modelo de datos del sensor. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un modelo y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ). |
|
type |
string |
Tipo de medida de datos del sensor. |
unit |
string |
Unidad de medida del sensor. |
SensorDataType
Sensor mide el tipo de datos.
Nombre | Tipo | Description |
---|---|---|
Bool |
string |
|
DateTime |
string |
|
Double |
string |
|
Long |
string |
|
String |
string |