Sensors - Create Or Update

Referencia

Servicio:: Azure Data Manager for Agriculture

Versión de la API:: 2023-11-01-preview

Cree una entidad de sensor.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensors/{sensorId}?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
sensorId	path	True	string	Identificador del recurso del sensor.
sensorPartnerId	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	Tipo	Description
depthInMeters	number[]	Profundidad de cada medida del sensor en metros. Como la humedad del sensor a 2m, 4m, 6m.
description	string	Descripción textual del recurso.
deviceId	string	Identificador del dispositivo asociado.
hardwareId	string	Identificador del hardware asociado.
integrationId	string	Id. de integración para el dispositivo.
location	Location	Clase de modelo de ubicación.
name	string	Nombre para identificar el recurso.
port	Port	Esquema para almacenar valores de puerto.
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 puede proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores string, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
sensorDataModelId	string	Identificador del modelo de datos del sensor asociado.
status	string	Estado del recurso.
type	string	Tipo de sensor.

Respuestas

Nombre	Tipo	Description
200 OK	Sensor	Correcto
201 Created	Sensor	Creado
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

Sensor

Correcto

201 Created

Sensor

Creado

Other Status Codes

ErrorResponse

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

Sensors_CreateOrUpdate

Solicitud de ejemplo

HTTP

PATCH {endpoint}/sensor-partners/sp1/sensors/s124?api-version=2023-11-01-preview

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD 456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "status": "sm created",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Respuesta de muestra

status code:: 200

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

status code:: 201

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definiciones

Nombre	Description
Error	Error del servicio Azure AgPlatform.
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.
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.
Location	Clase de modelo de ubicación.
Port	Esquema para almacenar valores de puerto.
Sensor	Modelo de API de sensor.

Error

Error del servicio Azure AgPlatform.

Nombre	Tipo	Description
code	string	Conjunto de códigos de error definidos por el servidor.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	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	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	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.

Location

Clase de modelo de ubicación.

Nombre	Tipo	Description
latitude	number	Latitud de la ubicación.
longitude	number	Longitud de la ubicación.

Port

Esquema para almacenar valores de puerto.

Nombre	Tipo	Description
name	string	Nombre del puerto.
type	string	Tipo de puerto digital/analógico.

Sensor

Modelo de API de sensor.

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.
depthInMeters	number[]	Profundidad de cada medida del sensor en metros. Como la humedad del sensor a 2m, 4m, 6m.
description	string	Descripción textual del recurso.
deviceId	string	Identificador del dispositivo asociado.
eTag	string	Valor ETag para implementar la simultaneidad optimista.
hardwareId	string	Identificador del hardware asociado.
id	string	Identificador del recurso.
integrationId	string	Id. de integración para el dispositivo.
location	Location	Clase de modelo de ubicación.
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.
port	Port	Esquema para almacenar valores de puerto.
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 puede proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores string, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
sensorDataModelId	string	Identificador del modelo de datos del sensor asociado.
sensorPartnerId	string	Identificador del asociado del sensor asociado.
status	string	Estado del recurso.
type	string	Tipo de sensor.

Compartir a través de

Sensors - Create Or Update

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Authorization

Ejemplos

Sensors_CreateOrUpdate

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorResponse

InnerError

Location

Port

Sensor

Recursos adicionales