Share via

WFS - Get Collections

  • Ссылка
Service:
Maps Creator
API Version:
2.0

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

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

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

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

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

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

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

Параметры URI

Имя В Обязательно Тип Описание
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

CollectionsResponse

ОК
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 позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

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

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 или с помощью PowerShell, CLI, пакетов AZURE SDK или 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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

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

Type: apiKey
In: header

Примеры

GetCollections

Sample Request

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

Sample Response

Status code:
200 
{
  "ontology": "Facility-2.0",
  "collections": [
    {
      "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.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
          "rel": "describedBy",
          "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"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for unit"
        }
      ]
    },
    {
      "name": "zone",
      "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for zone"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0",
          "rel": "data",
          "title": "zone"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for zone"
        }
      ]
    },
    {
      "name": "level",
      "description": "An indication of the extent and vertical position of a set of features.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for level"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0",
          "rel": "data",
          "title": "level"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for level"
        }
      ]
    },
    {
      "name": "facility",
      "description": "Area of the site, building footprint etc.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for facility"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0",
          "rel": "data",
          "title": "facility"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for facility"
        }
      ]
    },
    {
      "name": "verticalPenetration",
      "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for verticalPenetration"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0",
          "rel": "data",
          "title": "verticalPenetration"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for verticalPenetration"
        }
      ]
    },
    {
      "name": "opening",
      "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for opening"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0",
          "rel": "data",
          "title": "opening"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for opening"
        }
      ]
    },
    {
      "name": "directoryInfo",
      "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for directoryInfo"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0",
          "rel": "data",
          "title": "directoryInfo"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for directoryInfo"
        }
      ]
    },
    {
      "name": "pointElement",
      "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for pointElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0",
          "rel": "data",
          "title": "pointElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for pointElement"
        }
      ]
    },
    {
      "name": "lineElement",
      "description": "A line feature in a unit, such as a dividing wall, window.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for lineElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0",
          "rel": "data",
          "title": "lineElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for lineElement"
        }
      ]
    },
    {
      "name": "areaElement",
      "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for areaElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0",
          "rel": "data",
          "title": "areaElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for areaElement"
        }
      ]
    },
    {
      "name": "category",
      "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for category"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0",
          "rel": "data",
          "title": "category"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for category"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0",
      "rel": "self"
    }
  ]
}

Определения

Имя Описание
Collection
CollectionsResponse
ErrorAdditionalInfo

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

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

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

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

Collection

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

string

описание функций в коллекции;
links

WFSEndpointLink[]

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

string

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

string

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

string

Удобочитаемый заголовок коллекции

CollectionsResponse

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

Collection[]

Все коллекции в заданном наборе данных.
links

WFSEndpointLink[]

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

string

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

ErrorAdditionalInfo

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

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

object

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

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

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

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

ErrorDetail

Объект error.

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

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

string

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

string

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

string

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

string

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

string

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