Sensor Data Models - Create Or Update

Referência

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Criar uma entidade de modelo de dados do sensor.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O nome do host do namespace, 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 solicitada

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Corpo da solicitação

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

Nome	Obrigatório	Tipo	Description
measures	True	<string, SensorDataModelMeasure>	Mapa do tipo de sensor para medidas de sensor.
description		string	Descrição textual do recurso.
manufacturer		string	Fabricante do sensor.
name		string	Nome para identificar o recurso.
productCode		string	ProductCode do sensor.
properties			Uma coleção de pares chave-valor 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. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ).
status		string	Status do recurso.
type		string	Tipo de sensor.

Respostas

Nome	Tipo	Description
200 OK	SensorDataModel	Êxito
201 Created	SensorDataModel	Criado
Other Status Codes	ErrorResponse	Erro Headers x-ms-error-code: string

Nome

Tipo

Description

200 OK

SensorDataModel

Êxito

201 Created

SensorDataModel

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. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Type: apiKey
In: header

Exemplos

SensorDataModels_CreateOrUpdate

Sample Request

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

Sample Response

Status code:: 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
  }
}

Status code:: 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

Nome	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço AgPlatform do Azure. Consulte 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. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
SensorDataModel	Modelo de API SensorModel.
SensorDataModelMeasure	Detalhes da medida do modelo de sensor.
SensorDataType	Tipo de dados de medida do sensor.

Error

Um erro do serviço AgPlatform do Azure.

Nome	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 esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível ao olho humano do erro.
target	string	Destino do erro.

ErrorResponse

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

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

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

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

SensorDataModel

Modelo de API SensorModel.

Nome	Tipo	Description
createdBy	string	Criado por ID de usuário/locatário.
createdDateTime	string	Data e hora em que o recurso foi criado; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.
description	string	Descrição textual do recurso.
eTag	string	O valor de 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 medidas de sensor.
modifiedBy	string	Modificado por ID de usuário/locatário.
modifiedDateTime	string	Data e hora em que o recurso foi modificado pela última vez; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.
name	string	Nome para identificar o recurso.
productCode	string	ProductCode do sensor.
properties		Uma coleção de pares chave-valor 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. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ).
sensorPartnerId	string	ID do parceiro de sensor associado.
status	string	Status do recurso.
type	string	Tipo de sensor.

SensorDataModelMeasure

Detalhes da medida do modelo de sensor.

Nome	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 chave-valor para o modelo de dados do sensor. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: há suporte para um máximo de 25 pares de valores de chave para um modelo e apenas valores de cadeia de caracteres, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ).
type	string	Tipo de medida de dados do sensor.
unit	string	Unidade de medida do sensor.

SensorDataType

Tipo de dados de medida do sensor.

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

Compartilhar via

Sensor Data Models - Create Or Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Authorization

Exemplos

SensorDataModels_CreateOrUpdate

Sample Request

Sample Response

Definições

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

Recursos adicionais