WFS - Get Collection Definition

Referentie

Service:: Maps Creator

API-versie:: 2.0

Gebruik dit om een gedetailleerd gegevensmodel van een verzameling op te halen.

Notitie

Buitengebruikstelling van Azure Maps Creator

De indoor kaartservice van Azure Maps Creator is nu afgeschaft en wordt buiten gebruik gesteld op 30-9-25. Zie einde levensduuraankondiging van Azure Maps Creator voor meer informatie.

De Get Collection Definition-API is een HTTP-GET-aanvraag die een gedetailleerd gegevensmodel van de opgegeven verzameling biedt.

De WFS-API volgt de Open Georuimtelijke Consortium-API-standaard voor functies om een query uit te voeren op Gegevenssets.

Een gegevensset bestaat uit meerdere functieverzamelingen. Een functieverzameling is een verzameling functies van een vergelijkbaar type, op basis van een gemeenschappelijk schema.

###Submit Definitieaanvraag voor verzameling ophalen

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

URI-parameters

Name	In	Vereist	Type	Description
collectionId	path	True	string	Id (naam) van een specifieke verzameling
datasetId	path	True	string	De id van de gegevensset waaruit een query moet worden uitgevoerd.
geography	path	True	string	Deze parameter geeft aan waar de Azure Maps Creator-resource zich bevindt. Geldige waarden zijn ons en eu.
api-version	query	True	string	Versienummer van Azure Maps-API.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	CollectionDefinition	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Opmerkingen

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.

De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

GetCollectionDefinition

Voorbeeldaanvraag

HTTP

GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0

Voorbeeldrespons

Statuscode:: 200

{
  "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"
    }
  ]
}

Definities

Name	Description
CollectionDefinition	verzameling geoJSON-functies
DefinitionProperty
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeoJsonGeometryType	type geometrie geretourneerd
WFSEndpointLink	Koppelingen naar andere WFS-eindpunten

CollectionDefinition

Object

verzameling geoJSON-functies

Name	Type	Description
description	string	beschrijft de verzameling
featureTypes	string[]	type functies geretourneerd
geometryType	GeoJsonGeometryType	type geometrie geretourneerd
idPrefix	string	voorvoegsel van de gebruikte verzameling
links	WFSEndpointLink[]	Koppelingen naar andere WFS-eindpunten.
name	string	id van de verzameling die wordt gebruikt, bijvoorbeeld in URI's
ontology	string	De ontologieversie van deze gegevensset.
properties	DefinitionProperty[]	kenmerken van de gebruikte verzameling
title	string	titel van verzameling

DefinitionProperty

Object

Name	Type	Description
name	string	naam van kenmerk
required	boolean	is kenmerk vereist
type	object	type kenmerk

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeoJsonGeometryType

Inventarisatie

type geometrie geretourneerd

Waarde	Description
GeometryCollection	`GeoJSON GeometryCollection` geometrie.
LineString	`GeoJSON LineString` geometrie.
MultiLineString	`GeoJSON MultiLineString` geometrie.
MultiPoint	`GeoJSON MultiPoint` geometrie.
MultiPolygon	`GeoJSON MultiPolygon` geometrie.
Point	`GeoJSON Point` geometrie.
Polygon	`GeoJSON Polygon` geometrie.

WFSEndpointLink

Object

Koppelingen naar andere WFS-eindpunten

Name	Type	Description
href	string	Het koppelingsdoel.
hreflang	string	Een hint die aangeeft wat de taal is van het resultaat van het uitstellen van de koppeling.
rel	string	Het relatietype.
title	string	Wordt gebruikt om de bestemming van een koppeling te labelen, zodat deze kan worden gebruikt als een door mensen leesbare id (bijvoorbeeld een menu-item) in de taal die wordt aangegeven door het veld Inhoudstaal (indien aanwezig).
type	string	Een hint die aangeeft wat het mediatype is van het resultaat van het uitstellen van de koppeling.

Delen via

WFS - Get Collection Definition

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Opmerkingen

Bereiken

subscription-key

SAS Token

Voorbeelden

GetCollectionDefinition

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CollectionDefinition

DefinitionProperty

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometryType

WFSEndpointLink

Aanvullende resources