WFS - Get Features

Référence

Service:: Maps Creator

Version d'API:: 2.0

Utilisez pour obtenir une liste détaillée des fonctionnalités d’une collection.

L’API Get Features est une requête HTTP GET qui retourne une liste détaillée des fonctionnalités de la collection spécifiée.

L’API WFS suit la norme d’API Open Geospatial Consortium pour les fonctionnalités permettant d’interroger des jeux de données.

Un jeu de données se compose de plusieurs collections de fonctionnalités. Une collection de fonctionnalités est une collection de fonctionnalités d’un type similaire, basée sur un schéma commun.

Envoyer une demande d’obtention de fonctionnalités

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0

Avec des paramètres facultatifs:

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collectionId	path	True	string	Identificateur (nom) d’une collection spécifique
datasetId	path	True	string	Identificateur du jeu de données à partir duquel interroger.
geography	path	True	string	Ce paramètre spécifie l’emplacement de la ressource Creator Azure Maps. Les valeurs valides sont us et eu.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
bbox	query		number[]	Seules les fonctionnalités qui ont une géométrie qui croise le cadre englobant fourni sont sélectionnées. Coin inférieur gauche, axe des coordonnées 1 * Coin inférieur gauche, axe des coordonnées 2 * Coin supérieur droit, axe des coordonnées 1 * Coin supérieur droit, axe des coordonnées 2 Le système de référence de coordonnées des valeurs est WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84), sauf si un autre système de référence de coordonnées est spécifié dans le paramètre `bbox-crs`. Pour la longitude/latitude WGS84, les valeurs sont dans la plupart des cas la séquence de longitude minimale, de latitude minimale, de longitude maximale et de latitude maximale. Toutefois, dans les cas où la zone s’étend sur l’antiméridien, la première valeur (bord de la zone la plus à l’ouest) est supérieure à la troisième valeur (bord de la zone la plus à l’est).
filter	query		string	Expression de filtre pour rechercher des fonctionnalités avec des valeurs de propriété spécifiques dans une collection donnée. Seules les propriétés de fonctionnalité de type scalaire et égale à l’opérateur sont prises en charge. Il s’agit d’un paramètre spécial où le nom du paramètre est un nom de propriété respectant la casse. Le schéma de ce paramètre est {property name}={property value}. Sauf si « filter » est l’un des noms de propriété de la collection, « filter » ne doit pas être utilisé comme nom de paramètre. Pour rechercher des fonctionnalités avec la valeur de propriété « name » « 21N13 », utilisez « name=21N13 ». Plusieurs filtres sont pris en charge et doivent être représentés sous forme de paramètres de requête multiples. Par exemple, =&= Les valeurs string respectent la casse.
limit	query		integer	Le paramètre de limite facultatif limite le nombre de fonctionnalités présentées dans le document de réponse. Seules les fonctionnalités qui se trouvent au premier niveau de la collection dans le document de réponse sont comptabilisées. Les objets imbriqués contenus dans les fonctionnalités explicitement demandées ne sont pas comptabilisés. Minimum = 1 * Maximum = 500 * Default = 10

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	ExtendedGeoJsonFeatureCollection	OK
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps.

est Authorization URL spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, notre recommandation est d’utiliser l’approche des applications clientes confidentielles pour accéder à Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

GetFeatures

Exemple de requête

HTTP

GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46

Exemple de réponse

Code d’état:: 200

{
  "type": "FeatureCollection",
  "ontology": "Facility-2.0",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              139.6330405782921,
              35.45768668610856
            ],
            [
              139.63296283234274,
              35.45778390425868
            ],
            [
              139.63308672404617,
              35.45785022906202
            ],
            [
              139.6331451691671,
              35.45777714569986
            ],
            [
              139.6331274703629,
              35.45776767074717
            ],
            [
              139.63314677109963,
              35.45774353588138
            ],
            [
              139.6330405782921,
              35.45768668610856
            ]
          ]
        ]
      },
      "properties": {
        "originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
        "categoryId": "CTG10",
        "isOpenArea": false,
        "navigableBy": [
          "pedestrian"
        ],
        "isRoutable": false,
        "routeThroughBehavior": "allowed",
        "nonPublic": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "addressRoomNumber": "",
        "name": "21N13",
        "nameSubtitle": "",
        "nameAlt": ""
      },
      "id": "UNIT39",
      "featureType": ""
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
      "rel": "self"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
      "rel": "data"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
      "rel": "next"
    }
  ]
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ExtendedGeoJsonFeatureCollection	Type d’objet valide `GeoJSON FeatureCollection` étendu avec numberReturned et tableau de liens. Pour plus d’informations, consultez RFC 7946 .
GeoJsonFeature	Type d’objet valide `GeoJSON Feature` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometry	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometryCollection	Type d’objet valide `GeoJSON GeometryCollection` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonLineString	Type geometry valide `GeoJSON LineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiLineString	Type geometry valide `GeoJSON MultiLineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPoint	Type geometry valide `GeoJSON MultiPoint` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPolygon	Type d’objet valide `GeoJSON MultiPolygon` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonObjectType	Spécifie le `GeoJSON` type : FeatureCollection.
GeoJsonPoint	Type geometry valide `GeoJSON Point` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPolygon	Type geometry valide `GeoJSON Polygon` . Pour plus d’informations, consultez RFC 7946 .
WFSEndpointLink	Liens vers d’autres points de terminaison WFS

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

ExtendedGeoJsonFeatureCollection

Type d’objet valide GeoJSON FeatureCollection étendu avec numberReturned et tableau de liens. Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
features	GeoJsonFeature[]	Contient une liste d’objets valides `GeoJSON Feature` .
links	WFSEndpointLink[]	Liens vers d’autres points de terminaison WFS.
numberReturned	integer	Nombre de fonctionnalités retournées.
ontology	string	Version d’ontologie de ce jeu de données.
type	GeoJsonObjectType	Spécifie le `GeoJSON` type : FeatureCollection.

GeoJsonFeature

Type d’objet valide GeoJSON Feature . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
featureType	string	Type de la fonctionnalité. La valeur dépend du modèle de données dont fait partie la fonctionnalité actuelle. Certains modèles de données peuvent avoir une valeur vide.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
id	string	Identificateur de la fonctionnalité.
type	string: Feature	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometry

Objet geometry valide GeoJSON . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
type	GeoJsonObjectType	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometryCollection

Type d’objet valide GeoJSON GeometryCollection . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contient une liste d’objets géométriques valides `GeoJSON` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: GeometryCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonLineString

Type geometry valide GeoJSON LineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson LineString` géométrie.
type	string: LineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiLineString

Type geometry valide GeoJSON MultiLineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiLineString` géométrie.
type	string: MultiLineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPoint

Type geometry valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiPoint` géométrie.
type	string: MultiPoint	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPolygon

Type d’objet valide GeoJSON MultiPolygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Contient une liste d’objets valides `GeoJSON Polygon` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: MultiPolygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonObjectType

Spécifie le GeoJSON type : FeatureCollection.

Nom	Type	Description
FeatureCollection	string	Objet `GeoJSON FeatureCollection`.

GeoJsonPoint

Type geometry valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Un `Position` est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Elevation est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .
type	string: Point	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPolygon

Type geometry valide GeoJSON Polygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées du `GeoJson Polygon` type geometry.
type	string: Polygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

WFSEndpointLink

Liens vers d’autres points de terminaison WFS

Nom	Type	Description
href	string	Cible de lien.
hreflang	string	Indicateur indiquant la langue du résultat de la déréférencement du lien.
rel	string	Type de relation.
title	string	Permet d’étiqueter la destination d’un lien afin qu’il puisse être utilisé comme identificateur lisible par l’utilisateur (par exemple, une entrée de menu) dans la langue indiquée par le champ d’en-tête Content-Language (le cas échéant).
type	string	Indicateur indiquant le type de média du résultat de la déréférencement du lien.

Partager via