Sensor Partner Integrations - List

Référence

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Obtient des modèles d’intégration de partenaires.

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

With optional parameters:

GET {endpoint}/sensor-partners/{sensorPartnerId}/integrations?partyIds={partyIds}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	Nom d’hôte de l’espace de noms, par exemple admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	ID du partenaire de capteur associé.
api-version	query	True	string	Version de l’API demandée
ids	query		string[]	ID de la ressource.
maxCreatedDateTime	query		string date-time	Date de création maximale de la ressource (inclusive).
maxLastModifiedDateTime	query		string date-time	Date maximale de dernière modification de la ressource (inclusive).
maxPageSize	query		integer int32	Nombre maximal d’éléments nécessaires (inclus). Minimum = 10, Maximum = 1000, Valeur par défaut = 50.
minCreatedDateTime	query		string date-time	Date de création minimale de la ressource (inclusive).
minLastModifiedDateTime	query		string date-time	Date minimale de dernière modification de la ressource (inclusive).
names	query		string[]	Noms de la ressource.
partyIds	query		string[]	Ids des parties.
propertyFilters	query		string[]	Filtres sur les paires clé-valeur dans l’objet Properties. par exemple « {testKey} eq {testValue} ».
skipToken	query		string	Ignorer le jeton pour obtenir le jeu de résultats suivant.
statuses	query		string[]	États de la ressource.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Réponses

Nom	Type	Description
200 OK	SensorPartnerIntegrationModelListResponse	Succès
Other Status Codes	ErrorResponse	Error Headers x-ms-error-code: string

Nom

Type

Description

200 OK

SensorPartnerIntegrationModelListResponse

Succès

Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Sécurité

Authorization

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Type: apiKey
In: header

Exemples

SensorPartnerIntegrations_List

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "integrationId": "I123",
      "partyId": "prbhad-party",
      "sensorPartnerId": "Davis",
      "id": "I123",
      "status": "string",
      "createdDateTime": "2021-11-22T05:07:14Z",
      "modifiedDateTime": "2022-01-04T11:17:08Z",
      "eTag": "8900a6d8-0000-0700-0000-61d42cb40000",
      "name": "string",
      "description": "string",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      }
    },
    {
      "integrationId": "I456",
      "partyId": "prbhad-party2",
      "sensorPartnerId": "Davis",
      "id": "I456",
      "status": "string",
      "createdDateTime": "2022-01-12T10:33:54Z",
      "modifiedDateTime": "2022-01-12T10:33:54Z",
      "eTag": "8d014fe2-0000-0700-0000-61deae920000",
      "name": "string",
      "description": "string",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      }
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations?maxPageSize=10&api-version=2023-11-01-preview&skipToken=W3sidG9rZW4iOiIrUklEOn4xQ1VyQU9zRU8zMXZucGdCQUFBQUFBPT0jUlQ6MSNUUkM6MTAjSVNWOjIjSUVPOjY1NTUxI1FDRjo0I0ZQQzpBZ0ppQm1JR1lnWUVBRytlRDRBPSIsInJhbmdlIjp7Im1pbiI6IiIsIm1heCI6IkZGIn19XQ"
}

Définitions

Nom	Description
Error	Erreur du service Azure AgPlatform.
ErrorResponse	Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.
InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.
SensorPartnerIntegrationModel	Modèle d’intégration de partenaire de capteur.
SensorPartnerIntegrationModelListResponse	La réponse paginée contient la liste des objets demandés et un lien URL pour obtenir l’ensemble de résultats suivant.

Error

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string	Ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.
message	string	Représentation contrôlable de visu de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.

Nom	Type	Description
error	Error	Erreur du service Azure AgPlatform.
traceId	string	ID de trace unique.

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Nom	Type	Description
code	string	Code d’erreur spécifique fourni par l’erreur contenant.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

SensorPartnerIntegrationModel

Modèle d’intégration de partenaire de capteur.

Nom	Type	Description
createdBy	string	Créé par l’ID utilisateur/locataire.
createdDateTime	string	Date/Heure de création de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.
description	string	Description textuelle de la ressource.
eTag	string	Valeur ETag pour implémenter l’accès concurrentiel optimiste.
id	string	ID de la ressource.
integrationId	string	ID de l’intégration.
modifiedBy	string	Modifié par l’ID utilisateur/locataire.
modifiedDateTime	string	Date/Heure de la dernière modification de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.
name	string	Nom destiné à identifier la ressource.
partyId	string	ID de la partie.
properties		Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir une clé supérieure à 50 caractères et ne doit pas avoir une valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires de valeur de clé peut être fourni pour une ressource et seules les valeurs string, numeral et datetime (aaaa-MM-ddTHH :mm :ssZ) sont prises en charge.
sensorPartnerId	string	ID du partenaire de capteur associé.
status	string	État de la ressource.

SensorPartnerIntegrationModelListResponse

La réponse paginée contient la liste des objets demandés et un lien URL pour obtenir l’ensemble de résultats suivant.

Nom	Type	Description
nextLink	string	Lien de continuation (URI absolu) vers la page suivante de résultats de la liste.
skipToken	string	Jeton utilisé pour récupérer la page suivante. Si la valeur est null, il n’y a pas de pages supplémentaires.
value	SensorPartnerIntegrationModel[]	Liste des objets demandés.

Partager via

Sensor Partner Integrations - List

Paramètres URI

En-tête de la demande

Réponses

Sécurité

Authorization

Exemples

SensorPartnerIntegrations_List

Sample Request

Sample Response

Définitions

Error

ErrorResponse

InnerError

SensorPartnerIntegrationModel

SensorPartnerIntegrationModelListResponse

Ressources supplémentaires