Sensor Data Models - Create Or Update

Serviço:: Azure Data Manager for Agriculture

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

Crie 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 de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você 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 minLength: 0 maxLength: 500	Descrição textual do recurso.
manufacturer		string minLength: 0 maxLength: 100	Fabricante do sensor.
name		string minLength: 0 maxLength: 100	Nome para identificar o recurso.
productCode		string minLength: 0 maxLength: 100	ProductCode do sensor.
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. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
status		string minLength: 0 maxLength: 100	Status do recurso.
type		string minLength: 0 maxLength: 100	Tipo de sensor.

Respostas

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

Nome

Tipo

Description

200 OK

SensorDataModel

Êxito

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

Tipo: apiKey
Em: header

Exemplos

SensorDataModels_CreateOrUpdate

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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 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 que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para 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

Objeto

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string minLength: 1	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 para o documento de referência InnerError.
message	string minLength: 1	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Objeto

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.

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

InnerError

Objeto

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

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que 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 para o documento de referência InnerError.

SensorDataModel

Objeto

Modelo de API SensorModel.

Nome	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: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
id	string	ID do recurso.
manufacturer	string minLength: 0 maxLength: 100	Fabricante do sensor.
measures	<string, SensorDataModelMeasure>	Mapa do tipo de sensor para medidas de sensor.
modifiedBy	string	Modificado pela ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
productCode	string minLength: 0 maxLength: 100	ProductCode do sensor.
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. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
sensorPartnerId	string	ID do parceiro de sensor associado.
status	string minLength: 0 maxLength: 100	Status do recurso.
type	string minLength: 0 maxLength: 100	Tipo de sensor.

SensorDataModelMeasure

Objeto

Detalhes da medida do modelo de sensor.

Nome	Tipo	Description
dataType	SensorDataType minLength: 2 maxLength: 100	Tipo de dados de medida do sensor.
description	string minLength: 0 maxLength: 500	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: um máximo de 25 pares de valor de chave pode ser fornecido para um modelo e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) são compatíveis.
type	string minLength: 0 maxLength: 100	Tipo de medida de dados do sensor.
unit	string minLength: 0 maxLength: 100	Unidade de medida do sensor.

SensorDataType

Enumeração

Tipo de dados de medida do sensor.

Valor	Description
Bool
Double
DateTime
Long
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

Solicitação de exemplo

Resposta de exemplo

Definições

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType