WFS - Get Collections
A használatával lekérheti az adathalmaz összes gyűjteményének leírását.
Az Get Collections
API egy HTTP-kérés GET
, amely a megadott adathalmaz összes gyűjteményének leírását tartalmazza.
A WFS API az Open Geospatial Consortium API szabványt követi azadathalmazok lekérdezéséhez szükséges funkciókhoz.
Egy adatkészlet több funkciógyűjteményből áll. A szolgáltatásgyűjtemények hasonló típusú szolgáltatások gyűjteményei, amelyek egy közös sémán alapulnak.
A Gyűjtemények leírása API egy adott adathalmaz összes gyűjteményének leírását tartalmazza. További információ: Webszolgáltatás-szolgáltatás API
Gyűjtemények lekérésére vonatkozó kérelem elküldése
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections?api-version=2.0
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
dataset
|
path | True |
string |
Annak az adathalmaznak az azonosítója, amelyből lekérdezhető. |
geography
|
path | True |
string |
Ez a paraméter határozza meg, hogy hol található a Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu. |
api-version
|
query | True |
string |
Azure Maps API verziószáma. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Oké |
|
Other Status Codes |
Váratlan hiba történt. |
Biztonság
AADToken
Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.
A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.
Jegyzetek
- Ez a biztonsági definíció megköveteli a fejléc használatát annak
x-ms-client-id
jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.
A Authorization URL
az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek.
* Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
* A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.
- A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.
Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.
Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.
Típus:
apiKey
In:
query
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.
Típus:
apiKey
In:
header
Példák
GetCollections
Mintakérelem
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0
Mintaválasz
{
"ontology": "Facility-2.0",
"collections": [
{
"name": "unit",
"description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for unit"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0",
"rel": "data",
"title": "unit"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for unit"
}
]
},
{
"name": "zone",
"description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for zone"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0",
"rel": "data",
"title": "zone"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for zone"
}
]
},
{
"name": "level",
"description": "An indication of the extent and vertical position of a set of features.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for level"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0",
"rel": "data",
"title": "level"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for level"
}
]
},
{
"name": "facility",
"description": "Area of the site, building footprint etc.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for facility"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0",
"rel": "data",
"title": "facility"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for facility"
}
]
},
{
"name": "verticalPenetration",
"description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for verticalPenetration"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0",
"rel": "data",
"title": "verticalPenetration"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for verticalPenetration"
}
]
},
{
"name": "opening",
"description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for opening"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0",
"rel": "data",
"title": "opening"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for opening"
}
]
},
{
"name": "directoryInfo",
"description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for directoryInfo"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0",
"rel": "data",
"title": "directoryInfo"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for directoryInfo"
}
]
},
{
"name": "pointElement",
"description": "A point feature in a unit, such as a first aid kit or a sprinkler head.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for pointElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0",
"rel": "data",
"title": "pointElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for pointElement"
}
]
},
{
"name": "lineElement",
"description": "A line feature in a unit, such as a dividing wall, window.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for lineElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0",
"rel": "data",
"title": "lineElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for lineElement"
}
]
},
{
"name": "areaElement",
"description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for areaElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0",
"rel": "data",
"title": "areaElement"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for areaElement"
}
]
},
{
"name": "category",
"description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0",
"rel": "describedBy",
"title": "Metadata catalogue for category"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0",
"rel": "data",
"title": "category"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for category"
}
]
}
],
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0",
"rel": "self"
}
]
}
Definíciók
Name | Description |
---|---|
Collection | |
Collections |
|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
WFSEndpoint |
Hivatkozások más WFS-végpontokra |
Collection
Name | Típus | Description |
---|---|---|
description |
string |
a gyűjtemény funkcióinak leírása |
links |
Más WFS-végpontokra mutató hivatkozások. |
|
name |
string |
például az URI-kban használt gyűjtemény azonosítója |
ontology |
string |
Az adathalmaz ontológiai verziója. |
title |
string |
a gyűjtemény emberi olvasásra alkalmas címe |
CollectionsResponse
Name | Típus | Description |
---|---|---|
collections |
Egy adott adathalmaz összes gyűjteménye. |
|
links |
Más WFS-végpontokra mutató hivatkozások. |
|
ontology |
string |
Az adathalmaz ontológiai verziója. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
WFSEndpointLink
Hivatkozások más WFS-végpontokra
Name | Típus | Description |
---|---|---|
href |
string |
A hivatkozás célja. |
hreflang |
string |
Egy tipp, amely azt jelzi, hogy a hivatkozás elhalasztásának eredménye milyen nyelven jelenik meg. |
rel |
string |
A relációs típus. |
title |
string |
Egy hivatkozás céljának címkézésére szolgál, hogy az emberi olvasásra alkalmas azonosítóként (például menübejegyzésként) használható a Content-Language fejlécmező által jelzett nyelven (ha van ilyen). |
type |
string |
Egy tipp, amely jelzi, hogy a hivatkozás elhalasztásának eredménye milyen médiatípusúnak kell lennie. |