Features - Get Collection Definition

Ссылка

Service:: Maps Creator

API Version:: 2023-03-01-preview

Используйте для получения подробной модели данных указанной коллекции признаков.

API функций является частью Creator, которая позволяет разрабатывать приложения на основе частных данных карты помещений с помощью API Azure Maps и пакета SDK. Функции API GET соответствуют стандарту Open Geospatial Consortium API — Features — Part 1: Core corrigendum standard для запроса наборов данных. Наборы данных состоят из нескольких коллекций признаков, которые представляют собой группу признаков , определенных общей схемой.

Отправка запроса на получение определения коллекции

API Get Collection Definition — это HTTP-запрос GET , который возвращает подробную модель данных коллекции компонентов, определенную в предоставленном collectionId.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
collectionId	path	True	string	Идентификатор (имя) определенной коллекции.
datasetId	path	True	string	Идентификатор набора данных для запроса.
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
api-version	query	True	string	Номер версии API Azure Maps

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	CollectionDefinitionResult	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Другими словами, в настоящее время они могут рассматриваться как master ключи к учетной записи, для которой они выданы.

Для общедоступных приложений мы рекомендуем использовать доступ между серверами Azure Maps REST API, где этот ключ можно безопасно хранить.

Type: apiKey
In: query

SAS Token

Это маркер подписанного URL-адреса, созданный с помощью операции List SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов, используемых для конкретного маркера. Другими словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

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

Определения

Имя	Описание
CollectionDefinitionResult	Ответ после успешного запроса на чтение определения коллекции.
DefinitionProperty	Определение свойства в коллекции.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
FeaturesEndpointLink	Ссылки на другие конечные точки компонентов. Дополнительные сведения о связях см. в стандарте API OGC — функции— часть 1 .
GeoJsonGeometryType	Тип возвращаемой геометрии.

CollectionDefinitionResult

Ответ после успешного запроса на чтение определения коллекции.

Имя	Тип	Описание
description	string	Описывает коллекцию.
geometryType	GeoJsonGeometryType	Тип возвращаемой геометрии.
id	string	Идентификатор коллекции, используемой, например, в URI.
itemType	string	Тип элементов коллекции.
links	FeaturesEndpointLink[]	Ссылки на другие конечные точки компонентов.
ontology	string	Онтологическая версия этого набора данных.
properties	DefinitionProperty[]	Атрибуты используемой коллекции.
title	string	Название коллекции.

DefinitionProperty

Определение свойства в коллекции.

Имя	Тип	Описание
name	string	Имя атрибута.
required	boolean	Требуется атрибут .
type	object	Тип атрибута.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

FeaturesEndpointLink

Ссылки на другие конечные точки компонентов. Дополнительные сведения о связях см. в стандарте API OGC — функции— часть 1 .

Имя	Тип	Описание
href	string	Целевой объект ссылки.
rel	string	Тип отношения.
title	string	Используется для пометки назначения ссылки таким образом, чтобы ее можно было использовать в качестве удобочитаемого идентификатора (например, записи меню) на языке, указанном полем заголовка Content-Language (при наличии).

GeoJsonGeometryType

Тип возвращаемой геометрии.

Имя	Тип	Описание
GeometryCollection	string	`GeoJSON GeometryCollection` Геометрии.
LineString	string	`GeoJSON LineString` Геометрии.
MultiLineString	string	`GeoJSON MultiLineString` Геометрии.
MultiPoint	string	`GeoJSON MultiPoint` Геометрии.
MultiPolygon	string	`GeoJSON MultiPolygon` Геометрии.
Point	string	`GeoJSON Point` Геометрии.
Polygon	string	`GeoJSON Polygon` Геометрии.

Share via