Sensors - Create Or Update

Referência

Serviço:: Azure Data Manager for Agriculture

Versão da API:: 2023-11-01-preview

Crie uma entidade de sensor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Id do recurso do sensor.
sensorPartnerId	path	True	string	Id do parceiro do sensor.
api-version	query	True	string	A versão da API solicitada

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 de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se tiver tentado chamadas não autenticadas antes.

Corpo do Pedido

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

Name	Tipo	Description
depthInMeters	number[] (double)	Profundidade de cada sensor medida em metros. Como a umidade do sensor em 2m, 4m, 6m.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
deviceId	string	ID do dispositivo associado.
hardwareId	string	Id do hardware associado.
integrationId	string	ID de integração para o dispositivo.
location	Location	Classe de modelo de localização.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
port	Port	Esquema para armazenar valores de porta.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Nota: Um máximo de 25 pares de valores de chave podem ser fornecidos para um recurso e apenas valores de string, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ) são suportados.
sensorDataModelId	string	Id do modelo de dados do sensor associado.
status	string minLength: 0 maxLength: 100	Status do recurso.
type	string minLength: 0 maxLength: 100	Tipo de sensor.

Respostas

Name	Tipo	Description
200 OK	Sensor	Sucesso
201 Created	Sensor	Criado
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

Sensor

Sucesso

201 Created

Sensor

Criado

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Sensors_CreateOrUpdate

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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
  }
}

Código de estado:: 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
  }
}

Definições

Name	Description
Error	Um erro do serviço Azure AgPlatform.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.
InnerError	Erro interno contendo lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
Location	Classe de modelo de localização.
Port	Esquema para armazenar valores de porta.
Sensor	Modelo API do sensor.

Error

Object

Um erro do serviço Azure AgPlatform.

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

ErrorResponse

Object

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

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

InnerError

Object

Erro interno contendo lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

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

Location

Object

Classe de modelo de localização.

Name	Tipo	Description
latitude	number (double) minimum: -90 maximum: 90	Latitude do local.
longitude	number (double) minimum: -180 maximum: 180	Longitude do local.

Port

Object

Esquema para armazenar valores de porta.

Name	Tipo	Description
name	string minLength: 1 maxLength: 50	Nome da porta.
type	string minLength: 0 maxLength: 100	Tipo de porta digital/analógica.

Sensor

Object

Modelo API do sensor.

Name	Tipo	Description
createdBy	string	Criado por ID de usuário/locatário.
createdDateTime	string (date-time)	Data-hora em que o recurso foi criado, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
depthInMeters	number[] (double)	Profundidade de cada sensor medida em metros. Como a umidade do sensor em 2m, 4m, 6m.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
deviceId	string	ID do dispositivo associado.
eTag	string	O valor ETag para implementar simultaneidade otimista.
hardwareId	string	Id do hardware associado.
id	string	Id do recurso.
integrationId	string	ID de integração para o dispositivo.
location	Location	Classe de modelo de localização.
modifiedBy	string	Modificado pelo ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
port	Port	Esquema para armazenar valores de porta.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Nota: Um máximo de 25 pares de valores de chave podem ser fornecidos para um recurso e apenas valores de string, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ) são suportados.
sensorDataModelId	string	Id do modelo de dados do sensor associado.
sensorPartnerId	string	ID do parceiro do sensor associado.
status	string minLength: 0 maxLength: 100	Status do recurso.
type	string minLength: 0 maxLength: 100	Tipo de sensor.

Partilhar via

Sensors - Create Or Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Authorization

Exemplos

Sensors_CreateOrUpdate

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorResponse

InnerError

Location

Port

Sensor