WFS - Get Features

Referens

Tjänst:: Maps Creator

API-version:: 2.0

Använd för att hämta en detaljerad lista över funktioner i en samling.

API:et Get Features är en HTTP-begäran GET som returnerar en detaljerad lista över funktioner i den angivna samlingen.

WFS-API:et följer API-standarden Open Geospatial Consortium för funktioner för att köra frågor mot datauppsättningar.

En datauppsättning består av flera funktionssamlingar. En funktionssamling är en samling funktioner av liknande typ, baserat på ett gemensamt schema.

Skicka begäran om att hämta funktioner

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
collectionId	path	True	string	Identifierare (namn) för en specifik samling
datasetId	path	True	string	Identifieraren för datauppsättningen att fråga från.
geography	path	True	string	Den här parametern anger var resursen Azure Maps Creator finns. Giltiga värden är oss och EU.
api-version	query	True	string	Versionsnummer för Azure Maps API.
bbox	query		number[]	Endast funktioner som har en geometri som korsar den angivna avgränsningsrutan är markerade. Nedre vänstra hörnet, koordinataxel 1 * Nedre vänstra hörnet, koordinataxel 2 * Övre högra hörnet, koordinataxel 1 * Övre högra hörnet, koordinataxel 2 Koordinatreferenssystemet för värdena är WGS84 longitud/latitud (http://www.opengis.net/def/crs/OGC/1.3/CRS84) om inte ett annat koordinatreferenssystem anges i parametern `bbox-crs`. För WGS84-longitud/latitud är värdena i de flesta fall sekvensen med minsta longitud, minsta latitud, maximal longitud och maximal latitud. Men i fall där rutan sträcker sig över antimeridianen är det första värdet (den västligaste lådkanten) större än det tredje värdet (öst-mest box edge).
filter	query		string	Filtrera uttryck för att söka efter funktioner med specifika egenskapsvärden i en viss samling. Endast funktionsegenskaper av skalär typ och operatorn lika med stöds. Det här är en särskild parameter där parameternamnet är ett skiftlägeskänsligt egenskapsnamn. Schemat för den här parametern är {egenskapsnamn}={egenskapsvärde}. Om inte "filter" är ett av egenskapsnamnen i samlingen ska "filter" inte användas som ett parameternamn. Om du vill söka efter funktioner med egenskapsvärdet "namn" "21N13" använder du "name=21N13". Flera filter stöds och bör representeras som flera frågeparametrar. Till exempel =&= Strängvärden är skiftlägeskänsliga.
limit	query		integer	Den valfria gränsparametern begränsar antalet funktioner som visas i svarsdokumentet. Endast funktioner som finns på den första nivån i samlingen i svarsdokumentet räknas. Kapslade objekt som finns i de uttryckligen begärda funktionerna ska inte räknas. Minimum = 1 * Maximum = 500 * Standard = 10

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name	Typ	Description
200 OK	ExtendedGeoJsonFeatureCollection	Okej
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

GetFeatures

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
    }
  ]
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ExtendedGeoJsonFeatureCollection	En giltig `GeoJSON FeatureCollection` objekttyp utökad med matrisen numberReturned och links. Mer information finns i RFC 7946 .
GeoJsonFeature	En giltig `GeoJSON Feature` objekttyp. Mer information finns i RFC 7946 .
GeoJsonGeometry	Ett giltigt `GeoJSON` geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
GeoJsonGeometryCollection	En giltig `GeoJSON GeometryCollection` objekttyp. Mer information finns i RFC 7946 .
GeoJsonLineString	En giltig `GeoJSON LineString` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiLineString	En giltig `GeoJSON MultiLineString` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPoint	En giltig `GeoJSON MultiPoint` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPolygon	En giltig `GeoJSON MultiPolygon` objekttyp. Mer information finns i RFC 7946 .
GeoJsonObjectType	Anger `GeoJSON` typen: FeatureCollection.
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
GeoJsonPolygon	En giltig `GeoJSON Polygon` geometrityp. Mer information finns i RFC 7946 .
WFSEndpointLink	Länkar till andra WFS-slutpunkter

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ExtendedGeoJsonFeatureCollection

En giltig GeoJSON FeatureCollection objekttyp utökad med matrisen numberReturned och links. Mer information finns i RFC 7946 .

Name	Typ	Description
features	GeoJsonFeature[]	Innehåller en lista över giltiga `GeoJSON Feature` objekt.
links	WFSEndpointLink[]	Länkar till andra WFS-slutpunkter.
numberReturned	integer	Antal returnerade funktioner.
ontology	string	Ontologiversionen av den här datauppsättningen.
type	GeoJsonObjectType	Anger `GeoJSON` typen: FeatureCollection.

GeoJsonFeature

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
featureType	string	Funktionens typ. Värdet beror på vilken datamodell den aktuella funktionen är en del av. Vissa datamodeller kan ha ett tomt värde.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Ett giltigt `GeoJSON` geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
id	string	Identifierare för funktionen.
type	string: Feature	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometry

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .

Name	Typ	Description
type	GeoJsonObjectType	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometryCollection

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Innehåller en lista över giltiga `GeoJSON` geometriobjekt. Observera att koordinaterna i GeoJSON är i x- och y-ordning (longitud, latitud).
type	string: GeometryCollection	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för geometrin `GeoJson LineString` .
type	string: LineString	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiLineString

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för geometrin `GeoJson MultiLineString` .
type	string: MultiLineString	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för geometrin `GeoJson MultiPoint` .
type	string: MultiPoint	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPolygon

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Innehåller en lista över giltiga `GeoJSON Polygon` objekt. Observera att koordinaterna i GeoJSON är i x- och y-ordning (longitud, latitud).
type	string: MultiPolygon	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonObjectType

Anger GeoJSON typen: FeatureCollection.

Name	Typ	Description
FeatureCollection	string	`GeoJSON FeatureCollection` Objekt.

GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	A `Position` är en matris med tal med två eller flera element. De två första elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946 .
type	string: Point	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPolygon

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson Polygon` geometritypen.
type	string: Polygon	Anger `GeoJSON` typen. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

WFSEndpointLink

Länkar till andra WFS-slutpunkter

Name	Typ	Description
href	string	Länkmålet.
hreflang	string	En ledtråd som anger vad språket i resultatet av avreferencing länken ska vara.
rel	string	Relationstypen.
title	string	Används för att märka målet för en länk så att den kan användas som en identifierare som kan läsas av människor (t.ex. en menypost) på det språk som anges av fältet Innehållsspråkhuvud (om det finns).
type	string	En ledtråd som anger vilken medietyp av resultatet av avreferencing länken ska vara.

Dela via