Features - Get Collection Definition

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2023-03-01-preview

A használatával lekérheti a megadott funkciógyűjtemény részletes adatmodelljét.

A Features API a Creator része, amely lehetővé teszi a privát beltéri térképadatokon alapuló alkalmazások fejlesztését Azure Maps API és SDK használatával. A features GET API-k az Open Geospatial Consortium API - Features – Part 1: Core corrigendum standard to query datasets (Open Geospatial Consortium API - Features – Part 1: Core corrigendum standard) alapján kérdezhetők le az adathalmazok. Az adathalmazok több funkciógyűjteményből állnak, amelyek egy közös séma által meghatározott funkciók csoportosítását képezik.

Gyűjteménydefiníciós kérelem kérésének elküldése

Az Get Collection Definition API egy HTTP-kérés GET , amely egy szolgáltatásgyűjtemény részletes adatmodelljét adja vissza a megadott collectionIdmódon.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
collectionId	path	True	string	Egy adott gyűjtemény azonosítója (neve).
datasetId	path	True	string	Annak az adatkészletnek 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 Létrehozó erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	A 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 használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name	Típus	Description
200 OK	CollectionDefinitionResult	Oké
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. 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, a REST API-khoz Azure Maps engedélyekkel rendelkező 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ások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés 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 egy alkalmazás konfigurációalapú beállítását több használati esetben.

Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.

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 van kiépítve, amikor Azure Maps erőforrást hoz létre 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 kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy használja a Azure Maps REST API-k kiszolgálóról kiszolgálóra való hozzáférését, ahol ez a kulcs biztonságosan tárolható.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre 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 jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

GetCollectionDefinition

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
    }
  ]
}

Definíciók

Name	Description
CollectionDefinitionResult	Válasz a gyűjtemény definíciójának olvasására irányuló sikeres kérés után.
DefinitionProperty	A gyűjtemény egyik tulajdonságának definíciója.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FeaturesEndpointLink	Más szolgáltatások végpontjaira mutató hivatkozások. A kapcsolati kapcsolatokról további információt az OGC API – Funkciók – 1. rész standard című témakörben talál.
GeoJsonGeometryType	A visszaadott geometria típusa.

CollectionDefinitionResult

Válasz a gyűjtemény definíciójának olvasására irányuló sikeres kérés után.

Name	Típus	Description
description	string	A gyűjtemény leírása.
geometryType	GeoJsonGeometryType	A visszaadott geometria típusa.
id	string	A gyűjtemény azonosítója, például az URI-kban.
itemType	string	A gyűjtemény elemeinek típusa.
links	FeaturesEndpointLink[]	Más szolgáltatások végpontjaira mutató hivatkozások.
ontology	string	Az adatkészlet ontológiai verziója.
properties	DefinitionProperty[]	A használt gyűjtemény attribútumai.
title	string	A gyűjtemény címe.

DefinitionProperty

A gyűjtemény egyik tulajdonságának definíciója.

Name	Típus	Description
name	string	Attribútum neve.
required	boolean	Attribútum szükséges.
type	object	Attribútum típusa.

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 információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FeaturesEndpointLink

Más szolgáltatások végpontjaira mutató hivatkozások. A kapcsolati kapcsolatokról további információt az OGC API – Funkciók – 1. rész standard című témakörben talál.

Name	Típus	Description
href	string	A hivatkozás célja.
rel	string	A relációs típus.
title	string	A hivatkozás célhelyének címkézésére szolgál, így 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).

GeoJsonGeometryType

A visszaadott geometria típusa.

Name	Típus	Description
GeometryCollection	string	`GeoJSON GeometryCollection` Geometria.
LineString	string	`GeoJSON LineString` Geometria.
MultiLineString	string	`GeoJSON MultiLineString` Geometria.
MultiPoint	string	`GeoJSON MultiPoint` Geometria.
MultiPolygon	string	`GeoJSON MultiPolygon` Geometria.
Point	string	`GeoJSON Point` Geometria.
Polygon	string	`GeoJSON Polygon` Geometria.

Megosztás a következőn keresztül: