WFS - Get Features
Använd för att hämta en detaljerad lista över funktioner i en samling.
Anmärkning
Azure Maps Creator-tillbakadragning
Inomhuskartetjänsten för Azure Maps Creator är nu inaktuell och kommer att dras tillbaka den 25-09-30. Mer information finns i Meddelande om slut på livslängd för Azure Maps Creator.
Get Features
-API:et är en HTTP-GET
begäran som returnerar en detaljerad lista över funktioner i den angivna samlingen.
WFS-API:et följer Open Geospatial Consortium API-standarden för funktioner för att fråga 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 hämta funktioner
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
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 |
---|---|---|---|---|
collection
|
path | True |
string |
Identifierare (namn) för en specifik samling |
dataset
|
path | True |
string |
Identifieraren för datauppsättningen som ska frågas från. |
geography
|
path | True |
string |
Den här parametern anger var Azure Maps Creator-resursen finns. Giltiga värden är vi 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.
|
|
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 lika med operator 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 "21N13" använder du "name=21N13". Flera filter stöds och bör representeras som flera frågeparametrar. T.ex. =&= Strängvärden är skiftlägeskänsliga. |
|
limit
|
query |
integer minimum: 1maximum: 500 |
Den valfria gränsparametern begränsar antalet funktioner som visas i svarsdokumentet. Endast funktioner som är 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.
|
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äkerhetsmodellen. 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 för vägledning. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Okej |
|
Other Status Codes |
Ett oväntat fel uppstod. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll 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-resurskonton 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 till 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 få åtkomstkontroll för specifika API:er och omfång.
Noteringar
- Den här säkerhetsdefinitionen kräver användningen av
x-ms-client-id
-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.
Authorization URL
är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
* Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, 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 Översikt över Microsofts identitetsplattform.
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 Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till 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 sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 till 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 återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
GetFeatures
Exempelbegäran
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
{
"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 |
---|---|
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Extended |
En giltig |
Geo |
En giltig |
Geo |
Ett giltigt |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
En giltig |
Geo |
Anger |
Geo |
En giltig |
Geo |
En giltig |
WFSEndpoint |
Länkar till andra WFS-slutpunkter |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
ExtendedGeoJsonFeatureCollection
En giltig GeoJSON FeatureCollection
objekttyp utökad med matrisen numberReturned och links. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
features |
Innehåller en lista över giltiga |
|
links |
Länkar till andra WFS-slutpunkter. |
|
numberReturned |
integer |
Antal returnerade funktioner. |
ontology |
string |
Ontologiversionen av den här datamängden. |
type |
Anger |
GeoJsonFeature
En giltig GeoJSON Feature
objekttyp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
featureType |
string |
Typ av funktion. Värdet beror på datamodellen som den aktuella funktionen ingår i. Vissa datamodeller kan ha ett tomt värde. |
geometry | GeoJsonGeometry: |
Ett giltigt |
id |
string |
Identifierare för funktionen. |
type |
string:
Feature |
Anger |
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 |
Anger |
GeoJsonGeometryCollection
En giltig GeoJSON GeometryCollection
objekttyp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Innehåller en lista över giltiga |
type |
string:
Geometry |
Anger |
GeoJsonLineString
En giltig GeoJSON LineString
geometrityp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
coordinates |
number[] (double) |
Koordinater för |
type |
string:
Line |
Anger |
GeoJsonMultiLineString
En giltig GeoJSON MultiLineString
geometrityp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
coordinates |
number[] (double) |
Koordinater för |
type |
string:
Multi |
Anger |
GeoJsonMultiPoint
En giltig GeoJSON MultiPoint
geometrityp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
coordinates |
number[] (double) |
Koordinater för |
type |
string:
Multi |
Anger |
GeoJsonMultiPolygon
En giltig GeoJSON MultiPolygon
objekttyp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
coordinates |
number[] (double) |
Innehåller en lista över giltiga |
type |
string:
Multi |
Anger |
GeoJsonObjectType
Anger GeoJSON
typ: FeatureCollection.
Värde | Description |
---|---|
FeatureCollection |
|
GeoJsonPoint
En giltig GeoJSON Point
geometrityp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
coordinates |
number[] (double) |
En |
type |
string:
Point |
Anger |
GeoJsonPolygon
En giltig GeoJSON Polygon
geometrityp. Mer information finns i RFC 7946.
Name | Typ | Description |
---|---|---|
coordinates |
number[] (double) |
Koordinater för |
type |
string:
Polygon |
Anger |
WFSEndpointLink
Länkar till andra WFS-slutpunkter
Name | Typ | Description |
---|---|---|
href |
string |
Länkmålet. |
hreflang |
string |
Ett tips som anger vilket språk som resultatet av dereferencing 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 läsbar identifierare (t.ex. en menypost) på det språk som anges i rubrikfältet Content-Language (om det finns). |
type |
string |
Ett tips som anger vilken medietyp av resultatet av dereferencing länken ska vara. |