Sensor Events - List

Referência

Serviço:: Azure Data Manager for Agriculture

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

Retorna uma lista de dados de eventos do sensor. O período de tempo para a consulta é limitado a 90 dias por vez. Retorna eventos dos últimos 90 dias quando startDateTime e endDateTime não são fornecidos.

GET {endpoint}/sensor-events?sensorId={sensorId}&sensorPartnerId={sensorPartnerId}&api-version=2023-11-01-preview

Com parâmetros opcionais:

GET {endpoint}/sensor-events?sensorId={sensorId}&sensorPartnerId={sensorPartnerId}&startDateTime={startDateTime}&endDateTime={endDateTime}&excludeDuplicateEvents={excludeDuplicateEvents}&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
api-version	query	True	string	A versão da API solicitada
sensorId	query	True	string	ID do sensor associado.
sensorPartnerId	query	True	string	ID do parceiro de sensor associado.
endDateTime	query		string date-time	Tempo de término do intervalo de pesquisa de eventos de sensor (inclusivo), formato de exemplo: aaaa-MM-ddTHH:mm:ssZ. Ele será truncado até segundos se a fração for fornecida.
excludeDuplicateEvents	query		boolean	Sinalizador para excluir eventos duplicados e usar somente os mais recentes (Padrão: false).
startDateTime	query		string date-time	Tempo de início do intervalo de pesquisa de eventos de sensor (inclusivo), formato de exemplo: aaaa-MM-ddTHH:mm:ssZ. Ele será truncado até segundos se a fração for fornecida.

Cabeçalho da solicitação

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.

Respostas

Nome

Tipo

Description

200 OK

SensorEventListResponse

Êxito

Other Status Codes

Erro

Cabeçalhos

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.

Tipo: apiKey
Em: header

Exemplos

SensorEvents_List

Solicitação de exemplo

HTTP

GET {endpoint}/sensor-events?sensorId=S124&sensorPartnerId=Davis&startDateTime=2018-01-01T00:00:43Z&endDateTime=2019-01-01T00:00:43Z&excludeDuplicateEvents=True&api-version=2023-11-01-preview

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "partyId": "prbhad-party",
      "eventDateTime": "2018-01-01T00:30:00Z",
      "ingestionDateTime": "2021-09-20T05:56:09Z",
      "measures": {
        "soil_moisture": {
          "unit": "m",
          "value": 30.1
        }
      }
    },
    {
      "partyId": "prbhad-party",
      "eventDateTime": "2018-01-01T00:31:00Z",
      "ingestionDateTime": "2021-09-20T05:56:09Z",
      "measures": {
        "soil_moisture": {
          "unit": "m",
          "value": 31.1
        }
      }
    }
  ]
}

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.
FarmHierarchyGeoResourceType	Tipo de recurso.
GeoResource	Esquema para armazenar o tipo de recurso e a ID do recurso.
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.
SensorEvent	Modelo de resposta a eventos do sensor.
SensorEventListResponse	A resposta paginada contém a lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

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.

FarmHierarchyGeoResourceType

Tipo de recurso.

Nome	Tipo	Description
ApplicationData	string
Field	string
HarvestData	string
PlantTissueAnalysis	string
PlantingData	string
Prescription	string
SeasonalField	string
TillageData	string
Zone	string

GeoResource

Esquema para armazenar o tipo de recurso e a ID do recurso.

Nome	Tipo	Description
id	string	ID do recurso.
type	FarmHierarchyGeoResourceType	Tipo de recurso.

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.

SensorEvent

Modelo de resposta a eventos do sensor.

Nome	Tipo	Description
associatedResource	GeoResource	Esquema para armazenar o tipo de recurso e a ID do recurso.
eventDateTime	string	DateTime da observação de eventos do sensor.
ingestionDateTime	string	DateTime da ingestão de eventos do sensor no armazenamento de dados.
measures		Medidas do sensor.
partyId	string	ID da parte associada.
sensorId	string	ID do sensor.
sensorPartnerId	string	ID do parceiro do sensor.

SensorEventListResponse

A resposta paginada contém a lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

Nome	Tipo	Description
nextLink	string	Link de continuação (URI absoluto) para a próxima página de resultados na lista.
skipToken	string	Token usado na recuperação da próxima página. Se for nulo, não haverá páginas adicionais.
value	SensorEvent[]	Lista de objetos solicitados.