Sensor Partner Integrations - Create Or Update

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Crie ou atualize uma integração com um parceiro de sensor.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/integrations/{integrationId}?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
integrationId	path	True	string	ID da integração a ser criada.
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	Tipo	Description
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
partyId	string	Id da festa.
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.

Respostas

Nome	Tipo	Description
200 OK	SensorPartnerIntegrationModel	Êxito
201 Created	SensorPartnerIntegrationModel	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

SensorPartnerIntegrations_CreateOrUpdate

Solicitação de exemplo

HTTP

PATCH {endpoint}/sensor-partners/Davis/integrations/I123?api-version=2023-11-01-preview

{
  "partyId": "prbhad-party",
  "status": "string",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Resposta de exemplo

Código de status:

200

{
  "integrationId": "I123",
  "partyId": "prbhad-party",
  "sensorPartnerId": "Davis",
  "id": "I123",
  "status": "string",
  "createdDateTime": "2021-11-22T05:07:14Z",
  "modifiedDateTime": "2022-03-16T11:38:45Z",
  "eTag": "73023740-0000-0700-0000-6231cc450000",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Código de status:

201

{
  "integrationId": "I123",
  "partyId": "prbhad-party",
  "sensorPartnerId": "Davis",
  "id": "I123",
  "status": "string",
  "createdDateTime": "2022-03-16T11:39:41Z",
  "modifiedDateTime": "2022-03-16T11:39:41Z",
  "eTag": "73023a53-0000-0700-0000-6231cc7d0000",
  "name": "string",
  "description": "string",
  "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.
SensorPartnerIntegrationModel	Modelo de integração do parceiro de 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.

SensorPartnerIntegrationModel

Objeto

Modelo de integração do parceiro de sensor.

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.
integrationId	string	ID da integração.
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.
partyId	string	Id da festa.
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.