Sensor Data Models - Create Or Update

Referência

Serviço:: Azure Data Manager for Agriculture

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

Criar uma entidade de modelo de dados de sensor.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}?api-version=2023-11-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O nome do anfitrião do espaço de nomes, por exemplo, admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	ID do modelo de dados do sensor.
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	Necessário	Tipo	Description
measures	True	<string, SensorDataModelMeasure>	Mapa do tipo de sensor para as medidas do sensor.
description		string	Descrição textual do recurso.
manufacturer		string	Fabricante do sensor.
name		string	Nome para identificar o recurso.
productCode		string	Sensor productCode.
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).
status		string	Estado do recurso.
type		string	Tipo de sensor.

Respostas

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

Name

Tipo

Description

200 OK

SensorDataModel

Success

201 Created

SensorDataModel

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 à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

SensorDataModels_CreateOrUpdate

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Código de estado:: 201

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

Definições

Name	Description
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.
SensorDataModel	Modelo da API SensorModel.
SensorDataModelMeasure	Detalhes da medida do modelo do sensor.
SensorDataType	Tipo de dados de medida do sensor.

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.

SensorDataModel

Modelo da API SensorModel.

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.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
id	string	ID do recurso.
manufacturer	string	Fabricante do sensor.
measures	<string, SensorDataModelMeasure>	Mapa do tipo de sensor para as medidas do sensor.
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.
productCode	string	Sensor productCode.
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).
sensorPartnerId	string	ID do parceiro de sensor associado.
status	string	Estado do recurso.
type	string	Tipo de sensor.

SensorDataModelMeasure

Detalhes da medida do modelo do sensor.

Name	Tipo	Description
dataType	SensorDataType	Tipo de dados de medida do sensor.
description	string	Descrição da medida do sensor.
properties		Uma coleção de pares de valores chave para o modelo de dados do sensor. Cada par não pode ter uma chave superior a 50 carateres e não pode ter um valor superior a 150 carateres. Nota: pode ser fornecido um máximo de 25 pares de valores de chave para um modelo e apenas são suportados valores de cadeia, numeral e datetime (yyy-MM-ddTHH:mm:ssZ).
type	string	Tipo de medição de dados do sensor.
unit	string	Unidade de medida do sensor.

SensorDataType

Tipo de dados de medida do sensor.

Name	Tipo	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string

Partilhar via

Sensor Data Models - Create Or Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Authorization

Exemplos

SensorDataModels_CreateOrUpdate

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

Recursos adicionais