Boundaries - Search

Service:: Azure Data Manager for Agriculture

Version d'API:: 2023-06-01-preview

Recherchez des limites entre toutes les parties par champs et en croisant la géométrie.

POST /boundaries?api-version=2023-06-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API demandée

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 essayé des appels non authentifiés avant.

Corps de la demande

Nom	Type	Description
ids	string[]	ID de la ressource.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Pour plus d’informations : https://geojson.org/). Remarque : Les coordonnées sont attendues au format [Longitude, Latitude].
maxArea	number (double)	Superficie maximale de la limite (inclusive).
maxCreatedDateTime	string (date-time)	Date de création maximale de la ressource (inclusive).
maxLastModifiedDateTime	string (date-time)	Date de dernière modification maximale de la ressource (inclusive).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	Nombre maximal d’éléments nécessaires (inclus). Minimum = 10, Maximum = 1000, Valeur par défaut = 50.
minArea	number (double)	Superficie minimale de la limite (inclusive).
minCreatedDateTime	string (date-time)	Date de création minimale de la ressource (inclusive).
minLastModifiedDateTime	string (date-time)	Date de dernière modification minimale de la ressource (inclusive).
names	string[]	Noms de la ressource.
parentIds	string[]	ID parent de la ressource.
parentType	BoundaryParentType	Type du parent auquel il appartient.
propertyFilters	string[]	Filtre les paires clé-valeur dans l’objet Properties. par exemple , « {testKey} eq {testValue} ».
skipToken	string	Ignorez le jeton pour obtenir le jeu de résultats suivant.
statuses	string[]	États de la ressource.
type	string	Tapez-le.

Réponses

Nom	Type	Description
200 OK	BoundaryMetadataListResponse	Succès
Other Status Codes	ErrorResponse	Erreur En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

BoundaryMetadataListResponse

Succès

Other Status Codes

ErrorResponse

Erreur

En-têtes

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 essayé des appels non authentifiés avant.

Type: apiKey
Dans: header

Exemples

Boundaries_Search

Exemple de requête

HTTP

POST /boundaries?api-version=2023-06-01-preview

{
  "ids": [
    "BOUNDARY123"
  ],
  "names": [
    "John Smith's Boundary"
  ],
  "propertyFilters": [
    "RetailerId"
  ],
  "statuses": [
    "Active"
  ],
  "minCreatedDateTime": "2021-04-22T12:53:39Z",
  "maxCreatedDateTime": "2021-04-22T12:53:39Z",
  "minLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxPageSize": 50,
  "skipToken": "string",
  "parentType": "Field",
  "parentIds": [
    "FIELD123"
  ],
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          10.98958969116211,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.284911882713146
        ]
      ]
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "parentId": "FIELD123",
      "parentType": "Field",
      "area": {
        "unit": "Acre",
        "value": 60.405
      },
      "name": "John Smith's Boundary",
      "description": "Some description"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

Définitions

Nom	Description
BoundaryMetadata	Schéma des métadonnées de ressource de limite.
BoundaryMetadataListResponse	La réponse paginée contient la liste des objets demandés et un lien d’URL pour obtenir le jeu de résultats suivant.
BoundaryParentType	Type du parent auquel il appartient. Par exemple, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
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 pour le document de référence ErrorResponse.
GeoJsonObjectType	Type d’objet GeoJSON.
InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.
Measure	Schéma pour le stockage de la lecture et de l’unité de mesure.
MultiPolygon	Géométrie multipolygon.
Point	Géométrie de point.
Polygon	Géométrie de polygone.
SearchBoundaryQuery	Paramètres SearchAllBoundaries et SearchBoundaries.

BoundaryMetadata

Object

Schéma des métadonnées de ressource de limite.

Nom	Type	Description
area	Measure	Schéma pour le stockage de la lecture et de l’unité de mesure.
createdBy	string	Créé par l’ID utilisateur/locataire.
createdDateTime	string (date-time)	Date et heure de création de la ressource, exemple de format : aaaa-MM-ddTHH :mm :ssZ.
description	string minLength: 0 maxLength: 500	Description textuelle de la ressource.
eTag	string	Valeur ETag pour implémenter l’accès concurrentiel optimiste.
id	string	ID de ressource unique.
modifiedBy	string	Modifié par l’ID utilisateur/locataire.
modifiedDateTime	string (date-time)	Date et heure de la dernière modification de la ressource, exemple de format : aaaa-MM-ddTHH :mm :ssZ.
name	string minLength: 0 maxLength: 100	Nom pour identifier la ressource.
parentId	string	ID du parent auquel il appartient.
parentType	BoundaryParentType	Type du parent auquel il appartient.
partyId	string	ID de partie.
properties		Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir de clé supérieure à 50 caractères et ne doit pas avoir de valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires clé-valeur peuvent être fournies pour une ressource et uniquement des valeurs chaîne, numération et datetime (aaaa-MM-jjTHH :mm :ssZ) sont prises en charge.
source	string minLength: 2 maxLength: 100	Source de la ressource.
status	string minLength: 0 maxLength: 100	État de la ressource.
type	string	Tapez-le.

BoundaryMetadataListResponse

Object

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

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

BoundaryParentType

Énumération

Type du parent auquel il appartient. Par exemple, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Valeur	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Object

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string minLength: 1	Ensemble défini par le serveur de codes d’erreur.
details	Error[]	Tableau de détails sur des 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 pour le document de référence InnerError.
message	string minLength: 1	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Object

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

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

GeoJsonObjectType

Énumération

Type d’objet GeoJSON.

Valeur	Description
Point
Polygon
MultiPolygon

InnerError

Object

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

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

Measure

Object

Schéma pour le stockage de la lecture et de l’unité de mesure.

Nom	Type	Description
unit	string minLength: 1 maxLength: 50	Unité de données.
value	number (double)	Valeur de données.

MultiPolygon

Object

Géométrie multipolygon.

Nom	Type	Description
coordinates	number[] (double)	Obtient ou définit les coordonnées de l’objet GeoJSON. Il doit s’agir d’un tableau de polygones, chaque polygone contient la liste des anneaux linéaires. Pour les polygones avec plus d’un de ces anneaux, le premier DOIT être l’anneau extérieur, et tout autre doit être des anneaux intérieurs.
type	string: MultiPolygon	Type d’objet GeoJSON.

Point

Object

Géométrie de point.

Nom	Type	Description
coordinates	number[] (double)	Obtient ou définit la coordonnée de ce point. Il doit s’agir d’un tableau de 2 ou 3 éléments pour un système 2D ou 3D.
type	string: Point	Type d’objet GeoJSON.

Polygon

Object

Géométrie de polygone.

Nom	Type	Description
coordinates	number[] (double)	Obtient ou définit le type de l’objet GeoJSON. Il doit s’agir d’un tableau de tableaux de coordonnées en anneau linéaires. Pour les polygones avec plus d’un de ces anneaux, le premier DOIT être l’anneau extérieur, et tout autre doit être des anneaux intérieurs.
type	string: Polygon	Type d’objet GeoJSON.

SearchBoundaryQuery

Object

Paramètres SearchAllBoundaries et SearchBoundaries.

Nom	Type	Valeur par défaut	Description
ids	string[]		ID de la ressource.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON (Pour plus d’informations : https://geojson.org/). Remarque : Les coordonnées sont attendues au format [Longitude, Latitude].
maxArea	number (double)		Superficie maximale de la limite (inclusive).
maxCreatedDateTime	string (date-time)		Date de création maximale de la ressource (inclusive).
maxLastModifiedDateTime	string (date-time)		Date de dernière modification maximale de la ressource (inclusive).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	Nombre maximal d’éléments nécessaires (inclus). Minimum = 10, Maximum = 1000, Valeur par défaut = 50.
minArea	number (double)		Superficie minimale de la limite (inclusive).
minCreatedDateTime	string (date-time)		Date de création minimale de la ressource (inclusive).
minLastModifiedDateTime	string (date-time)		Date de dernière modification minimale de la ressource (inclusive).
names	string[]		Noms de la ressource.
parentIds	string[]		ID parent de la ressource.
parentType	BoundaryParentType		Type du parent auquel il appartient.
propertyFilters	string[]		Filtre les paires clé-valeur dans l’objet Properties. par exemple , « {testKey} eq {testValue} ».
skipToken	string		Ignorez le jeton pour obtenir le jeu de résultats suivant.
statuses	string[]		États de la ressource.
type	string		Tapez-le.

Partager via

Boundaries - Search

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

Boundaries_Search

Exemple de requête

Exemple de réponse

Définitions

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery