Devices - Create Or Update

Referência

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Criar uma entidade de dispositivo.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
deviceId	path	True	string	ID do recurso do dispositivo.
endpoint	path	True	string uri	O nome do anfitrião do espaço de nomes, por exemplo, admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	ID do parceiro do sensor.
api-version	query	True	string	A versão da API pedida

Cabeçalho do Pedido

Media Types: "application/merge-patch+json"

Name	Necessário	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Corpo do Pedido

Media Types: "application/merge-patch+json"

Name	Tipo	Description
description	string	Descrição textual do recurso.
deviceDataModelId	string	ID do modelo de dados do dispositivo associado.
hardwareId	string	HardwareId do dispositivo.
integrationId	string	ID de integração do dispositivo.
location	Location	Classe de modelo de localização.
name	string	Nome para identificar o recurso.
parentDeviceId	string	ID do dispositivo principal para este dispositivo.
properties		Uma coleção de pares de valores chave que pertence ao recurso. Cada par não pode ter uma chave superior a 50 carateres e não pode ter um valor superior a 150 carateres. Nota: é possível fornecer um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (yyy-MM-ddTHH:mm:ssZ).
reportingIntervalInSeconds	integer	Intervalo no qual o dispositivo envia dados em segundos.
status	string	Estado do recurso.
type	string	Tipo de dispositivo.

Respostas

Name	Tipo	Description
200 OK	Device	Success
201 Created	Device	Criado
Other Status Codes	ErrorResponse	Erro Headers x-ms-error-code: string

Name

Tipo

Description

200 OK

Device

Success

201 Created

Device

Criado

Other Status Codes

ErrorResponse

Erro

Headers

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Type: apiKey
In: header

Exemplos

Devices_CreateOrUpdate

Sample Request

HTTP

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
  }
}

Sample Response

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
  }
}

Definições

Name	Description
Device	Modelo de API do dispositivo.
Error	Um erro do serviço Azure AgPlatform.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
Location	Classe de modelo de localização.

Device

Modelo de API do dispositivo.

Name	Tipo	Description
createdBy	string	Criado pelo ID de utilizador/inquilino.
createdDateTime	string	Data-hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
description	string	Descrição textual do recurso.
deviceDataModelId	string	ID do modelo de dados do dispositivo associado.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
hardwareId	string	HardwareId do dispositivo.
id	string	ID do recurso.
integrationId	string	ID de integração do dispositivo.
location	Location	Classe de modelo de localização.
modifiedBy	string	Modificado pelo ID de utilizador/inquilino.
modifiedDateTime	string	Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string	Nome para identificar o recurso.
parentDeviceId	string	ID do dispositivo principal para este dispositivo.
properties		Uma coleção de pares de valores chave que pertence ao recurso. Cada par não pode ter uma chave superior a 50 carateres e não pode ter um valor superior a 150 carateres. Nota: é possível fornecer um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (yyy-MM-ddTHH:mm:ssZ).
reportingIntervalInSeconds	integer	Intervalo no qual o dispositivo envia dados em segundos.
sensorPartnerId	string	ID do parceiro de sensor associado.
status	string	Estado do recurso.
type	string	Tipo de dispositivo.

Error

Um erro do serviço Azure AgPlatform.

Name	Tipo	Description
code	string	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Name	Tipo	Description
error	Error	Um erro do serviço Azure AgPlatform.
traceId	string	ID de rastreio exclusivo.

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Name	Tipo	Description
code	string	Código de erro específico do que foi fornecido pelo erro de contenção.
innererror	InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Location

Classe de modelo de localização.

Name	Tipo	Description
latitude	number	Latitude da localização.
longitude	number	Longitude da localização.

Partilhar via

Devices - Create Or Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Authorization

Exemplos

Devices_CreateOrUpdate

Sample Request

Sample Response

Definições

Device

Error

ErrorResponse

InnerError

Location

Recursos adicionais