Sensor Partner Integrations - Create Or Update

Servicio:

Azure Data Manager for Agriculture

Versión de la API:

2023-11-01-preview

Cree o actualice una integración con un asociado de sensor.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string uri	Nombre de host del espacio de nombres, por ejemplo, admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	Identificador de la integración que se va a crear.
sensorPartnerId	path	True	string	Identificador del asociado del sensor.
api-version	query	True	string	La versión de API solicitada

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
Authorization	True	string	Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
description	string	Descripción textual del recurso.
name	string	Nombre para identificar el recurso.
partyId	string	Id. de la fiesta.
properties		Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
status	string	Estado del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	SensorPartnerIntegrationModel	Correcto
201 Created	SensorPartnerIntegrationModel	Creado
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Seguridad

Authorization

Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Tipo: apiKey
En: header

Ejemplos

SensorPartnerIntegrations_CreateOrUpdate

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
Error	Error del servicio Azure AgPlatform.
ErrorResponse	Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses el documento de referencia ErrorResponse.
InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.
SensorPartnerIntegrationModel	Modelo de integración de asociados de sensor.

Error

Error del servicio Azure AgPlatform.

Nombre	Tipo	Description
code	string	Conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses el documento de referencia ErrorResponse.

Nombre	Tipo	Description
error	Error	Error del servicio Azure AgPlatform.
traceId	string	Identificador de seguimiento único.

InnerError

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.

Nombre	Tipo	Description
code	string	Código de error específico del proporcionado por el error contenedor.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.

SensorPartnerIntegrationModel

Modelo de integración de asociados de sensor.

Nombre	Tipo	Description
createdBy	string	Creado por el identificador de usuario o inquilino.
createdDateTime	string	Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
description	string	Descripción textual del recurso.
eTag	string	Valor ETag para implementar la simultaneidad optimista.
id	string	Identificador del recurso.
integrationId	string	Identificador de la integración.
modifiedBy	string	Modificado por el identificador de usuario o inquilino.
modifiedDateTime	string	Fecha y hora en que se modificó por última vez el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string	Nombre para identificar el recurso.
partyId	string	Id. de la fiesta.
properties		Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
sensorPartnerId	string	Identificador del asociado del sensor asociado.
status	string	Estado del recurso.