Поделиться через

WFS - Get Collection Definition

  • Ссылка
Служба:
Maps Creator
Версия API:
2.0

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

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

API WFS соответствует стандарту API Открытого геопространственного консорциума для функций для запроса наборов данных.

Набор данных состоит из нескольких коллекций компонентов. Коллекция признаков — это коллекция признаков аналогичного типа, основанная на общей схеме.

###Submit Получение запроса определения коллекции

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

Параметры 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

CollectionDefinition

ОК
Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечания

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

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

  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

GetCollectionDefinition

Образец запроса

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

Пример ответа

Код состояния:
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"
    }
  ]
}

Определения

Имя Описание
CollectionDefinition

коллекция функций GeoJSON
DefinitionProperty
ErrorAdditionalInfo

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

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

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

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

Ссылки на другие конечные точки WFS

CollectionDefinition

коллекция функций GeoJSON

Имя Тип Описание
description

string

описывает коллекцию
featureTypes

string[]

тип возвращаемых признаков
geometryType

GeoJsonGeometryType

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

string

префикс используемой коллекции
links

WFSEndpointLink[]

Ссылки на другие конечные точки WFS.
name

string

идентификатор коллекции, используемой, например, в URI
ontology

string

Онтологическая версия этого набора данных.
properties

DefinitionProperty[]

атрибуты используемой коллекции
title

string

название коллекции

DefinitionProperty

Имя Тип Описание
name

string

имя атрибута
required

boolean

требуется атрибут is
type

object

тип атрибута

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

Целевой объект ошибки.

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

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 Геометрии.

Ссылки на другие конечные точки WFS

Имя Тип Описание
href

string

Целевой объект ссылки.
hreflang

string

Указание, указывающее, каким должен быть язык результата разыменовки ссылки.
rel

string

Тип отношения.
title

string

Используется для пометки назначения ссылки таким образом, чтобы ее можно было использовать в качестве удобочитаемого идентификатора (например, записи меню) на языке, указанном полем заголовка Content-Language (при наличии).
type

string

Указание, указывающее тип носителя в результате разыменовки ссылки.