Sensor Partner Integrations - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Criar ou atualizar uma integração com um parceiro de sensor.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/integrations/{integrationId}?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
integrationId	path	True	string	ID da integração a criar.
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	Tipo	Description
description	string	Descrição textual do recurso.
name	string	Nome para identificar o recurso.
partyId	string	ID da festa.
properties		Uma coleção de pares chave-valor 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: pode ser fornecido um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ) são suportados.
status	string	Estado do recurso.

Respostas

Name	Tipo	Description
200 OK	SensorPartnerIntegrationModel	Success
201 Created	SensorPartnerIntegrationModel	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. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Type: apiKey
In: header

Exemplos

SensorPartnerIntegrations_CreateOrUpdate

Sample Request

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

Sample Response

Status code:

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

Status code:

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

Name	Description
Error	Um erro do serviço AgPlatform do Azure.
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.
SensorPartnerIntegrationModel	Modelo de integração de parceiros de sensor.

Error

Um erro do serviço AgPlatform do Azure.

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 comunicado.
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 AgPlatform do Azure.
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 que contém.
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.

SensorPartnerIntegrationModel

Modelo de integração de parceiros de sensor.

Name	Tipo	Description
createdBy	string	Criado pelo ID de utilizador/inquilino.
createdDateTime	string	Data e hora em que o recurso foi criado, formato de exemplo: aaaa-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.
integrationId	string	ID da integração.
modifiedBy	string	Modificado pelo ID de utilizador/inquilino.
modifiedDateTime	string	Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string	Nome para identificar o recurso.
partyId	string	ID da festa.
properties		Uma coleção de pares chave-valor 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: pode ser fornecido um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ) são suportados.
sensorPartnerId	string	ID do parceiro de sensor associado.
status	string	Estado do recurso.