Features - Get Collection Definition

Referentie

Service:: Maps Creator

API Version:: 2023-03-01-preview

Gebruik om een gedetailleerd gegevensmodel van de opgegeven functieverzameling op te halen.

De Functies-API maakt deel uit van Creator, waarmee u toepassingen kunt ontwikkelen op basis van uw persoonlijke indoorkaartgegevens met behulp van Azure Maps API en SDK. Functies GET API's volgen de Open Georuimtelijke Consortium-API - Functies - Deel 1: Kern corrigendum-standaard om query's uit te voeren op gegevenssets. Gegevenssets bestaan uit meerdere functieverzamelingen. Dit zijn een groep functies die zijn gedefinieerd door een gemeenschappelijk schema.

Aanvraag voor get-verzamelingsdefinitie indienen

De Get Collection Definition API is een HTTP-aanvraag GET die een gedetailleerd gegevensmodel retourneert van een functieverzameling zoals gedefinieerd door de opgegeven collectionId.

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/definition?api-version=2023-03-01-preview

URI-parameters

Name	In	Vereist	Type	Description
collectionId	path	True	string	Id (naam) van een specifieke verzameling.
datasetId	path	True	string	De id voor de gegevensset waaruit een query moet worden uitgevoerd.
geography	path	True	string	Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij 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 Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

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

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . In combinatie met 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 tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. 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.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

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 via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd 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 configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

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

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's waar deze 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 SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

GetCollectionDefinition

Sample Request

HTTP

GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2023-03-01-preview

Sample Response

Status code:: 200

{
  "id": "unit",
  "title": "Unit",
  "description": "The unit feature class defines a physical and non-overlapping area that can be occupied and traversed by a navigating agent. A unit can be a hallway, a room, a courtyard, and so on.",
  "ontology": "Facility-2.0",
  "geometryType": "Polygon",
  "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": "isRoutable",
      "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/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition",
      "rel": "self",
      "title": "Metadata catalogue for unit"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items",
      "rel": "items",
      "title": "Unit"
    }
  ]
}

Definities

Name	Description
CollectionDefinitionResult	Antwoord na een geslaagde aanvraag om de definitie van een verzameling te lezen.
DefinitionProperty	De definitie van een eigenschap in een verzameling.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FeaturesEndpointLink	Koppelingen naar andere eindpunten voor functies. Ga voor meer informatie over koppelingsrelaties naar de OGC API - Functies - Deel 1-standaard .
GeoJsonGeometryType	Het geretourneerde type geometrie.

CollectionDefinitionResult

Antwoord na een geslaagde aanvraag om de definitie van een verzameling te lezen.

Name	Type	Description
description	string	Beschrijft de verzameling.
geometryType	GeoJsonGeometryType	Het geretourneerde type geometrie.
id	string	Id van de verzameling die wordt gebruikt, bijvoorbeeld in URI's.
itemType	string	Het type van de items in de verzameling.
links	FeaturesEndpointLink[]	Koppelingen naar andere eindpunten voor functies.
ontology	string	De ontologieversie van deze gegevensset.
properties	DefinitionProperty[]	Kenmerken van de gebruikte verzameling.
title	string	Titel van verzameling.

DefinitionProperty

De definitie van een eigenschap in een verzameling.

Name	Type	Description
name	string	Naam van kenmerk.
required	boolean	Is kenmerk vereist.
type	object	Type kenmerk.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

De foutdetails.

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

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FeaturesEndpointLink

Koppelingen naar andere eindpunten voor functies. Ga voor meer informatie over koppelingsrelaties naar de OGC API - Functies - Deel 1-standaard .

Name	Type	Description
href	string	Het koppelingsdoel.
rel	string	Het relatietype.
title	string	Wordt gebruikt om de bestemming van een koppeling zodanig te labelen dat deze kan worden gebruikt als een door mensen leesbare id (bijvoorbeeld een menu-item) in de taal die wordt aangegeven door het veld Content-Language-header (indien aanwezig).

GeoJsonGeometryType

Het geretourneerde type geometrie.

Name	Type	Description
GeometryCollection	string	`GeoJSON GeometryCollection` Geometrie.
LineString	string	`GeoJSON LineString` Geometrie.
MultiLineString	string	`GeoJSON MultiLineString` Geometrie.
MultiPoint	string	`GeoJSON MultiPoint` Geometrie.
MultiPolygon	string	`GeoJSON MultiPolygon` Geometrie.
Point	string	`GeoJSON Point` Geometrie.
Polygon	string	`GeoJSON Polygon` Geometrie.

Delen via