Compartir a través de

Devices - Create Or Update

  • Referencia
Servicio:
Azure Data Manager for Agriculture
Versión de la API:
2023-11-01-preview

Cree una entidad de dispositivo.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/devices/{deviceId}?api-version=2023-11-01-preview

Parámetros de identificador URI

Nombre En Requerido Tipo Description
deviceId
 path True

string

Identificador del recurso de dispositivo.
endpoint
 path True

string

uri

Nombre de host del espacio de nombres, por ejemplo, admaInstanceName.farmbeats.azure.net
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
description

string

Descripción textual del recurso.
deviceDataModelId

string

Id. del modelo de datos de dispositivo asociado.
hardwareId

string

HardwareId del dispositivo.
integrationId

string

Identificador de integración para el dispositivo.
location

Location

Clase de modelo de ubicación.
name

string

Nombre para identificar el recurso.
parentDeviceId

string

Id. de dispositivo primario para este dispositivo.
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).
reportingIntervalInSeconds

integer

Intervalo en el que el dispositivo envía datos en segundos.
status

string

Estado del recurso.
type

string

Tipo de dispositivo.

Respuestas

Nombre Tipo Description
200 OK

Device

Correcto
201 Created

Device

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

Devices_CreateOrUpdate

Solicitud de ejemplo

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

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Respuesta de muestra

status code:
200 
{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}
status code:
201 
{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definiciones

Nombre Description
Device

Modelo de API de dispositivo.
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.

Device

Modelo de API de dispositivo.

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.
deviceDataModelId

string

Id. del modelo de datos de dispositivo asociado.
eTag

string

Valor ETag para implementar la simultaneidad optimista.
hardwareId

string

HardwareId del dispositivo.
id

string

Identificador del recurso.
integrationId

string

Identificador 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.
parentDeviceId

string

Id. de dispositivo primario para este dispositivo.
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).
reportingIntervalInSeconds

integer

Intervalo en el que el dispositivo envía datos en segundos.
sensorPartnerId

string

Identificador del asociado del sensor asociado.
status

string

Estado del recurso.
type

string

Tipo de dispositivo.

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

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.