WFS - Get Collection Definition
Använd för att hämta en detaljerad datamodell för en samling.
API:et Get Collection Definition
är en HTTP-begäran GET
som tillhandahåller en detaljerad datamodell för 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.
###Submit Hämta begäran om samlingsdefinition
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/definition?api-version=2.0
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 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. |
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. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. 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 |
Okej |
|
Other Status Codes |
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 en 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 få åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
krä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 Management-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.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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.
Type:
apiKey
In:
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.
Type:
apiKey
In:
header
Exempel
GetCollectionDefinition
Sample Request
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0
Sample Response
{
"idPrefix": "UNIT",
"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.",
"ontology": "Facility-2.0",
"geometryType": "Polygon",
"featureTypes": [],
"properties": [
{
"name": "externalId",
"required": false,
"type": "text"
},
{
"name": "originalId",
"required": false,
"type": "text"
},
{
"name": "categoryId",
"required": true,
"type": {
"featureId": "category"
}
},
{
"name": "isOpenArea",
"required": false,
"type": "boolean"
},
{
"name": "navigableBy",
"required": false,
"type": {
"array": {
"enum": [
"pedestrian",
"wheelchair",
"machine",
"bicycle",
"automobile",
"hiredAuto",
"bus",
"railcar",
"emergency",
"ferry",
"boat"
]
}
}
},
{
"name": "isRoutable",
"required": false,
"type": "boolean"
},
{
"name": "routeThroughBehavior",
"required": false,
"type": {
"enum": [
"disallowed",
"allowed",
"preferred"
]
}
},
{
"name": "nonPublic",
"required": false,
"type": "boolean"
},
{
"name": "levelId",
"required": true,
"type": {
"featureId": "level"
}
},
{
"name": "occupants",
"required": false,
"type": {
"array": {
"featureId": "directoryInfo"
}
}
},
{
"name": "addressId",
"required": false,
"type": {
"featureId": "directoryInfo"
}
},
{
"name": "addressRoomNumber",
"required": false,
"type": "text"
},
{
"name": "name",
"required": false,
"type": "text"
},
{
"name": "nameSubtitle",
"required": false,
"type": "text"
},
{
"name": "nameAlt",
"required": false,
"type": "text"
},
{
"name": "anchorPoint",
"required": false,
"type": {
"geometry": [
"Point"
],
"isFragmented": false,
"srid": 4326
}
}
],
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
"rel": "self",
"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"
}
]
}
Definitioner
Name | Description |
---|---|
Collection |
samling GeoJSON-funktioner |
Definition |
|
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Geo |
typ av geometri som returneras |
WFSEndpoint |
Länkar till andra WFS-slutpunkter |
CollectionDefinition
samling GeoJSON-funktioner
Name | Typ | Description |
---|---|---|
description |
string |
beskriver samlingen |
featureTypes |
string[] |
typ av funktioner som returneras |
geometryType |
typ av geometri som returneras |
|
idPrefix |
string |
prefix för den samling som används |
links |
Länkar till andra WFS-slutpunkter. |
|
name |
string |
identifierare för den samling som används, till exempel i URI:er |
ontology |
string |
Ontologiversionen av den här datauppsättningen. |
properties |
attribut för den samling som används |
|
title |
string |
samlingsrubrik |
DefinitionProperty
Name | Typ | Description |
---|---|---|
name |
string |
attributets namn |
required |
boolean |
är ett attribut som krävs |
type |
object |
typ av attribut |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
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. |
GeoJsonGeometryType
typ av geometri som returneras
Name | Typ | Description |
---|---|---|
GeometryCollection |
string |
|
LineString |
string |
|
MultiLineString |
string |
|
MultiPoint |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
|
WFSEndpointLink
Länkar till andra WFS-slutpunkter
Name | Typ | Description |
---|---|---|
href |
string |
Länkmålet. |
hreflang |
string |
Ett tips 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 rubrikfältet Content-Language (om det finns). |
type |
string |
Ett tips som anger vilken medietyp av resultatet av avreferencing länken ska vara. |