Features - Get Collection Definition

Referência

Service:: Maps Creator

API Version:: 2023-03-01-preview

Utilize para obter um modelo de dados detalhado da coleção de funcionalidades especificada.

A API de Funcionalidades faz parte do Criador, o que possibilita o desenvolvimento de aplicações com base nos dados privados do mapa interior com Azure Maps API e O SDK. As APIs GET de funcionalidades seguem a API Open Geospatial Consortium – Funcionalidades – Parte 1: Core corrigendum standard para consultar Conjuntos de Dados. Os conjuntos de dados consistem em várias coleções de funcionalidades, que são um agrupamento de funcionalidades definidas por um esquema comum.

Submeter Pedido de Definição de Coleção Get

A Get Collection Definition API é um pedido HTTP GET que devolve um modelo de dados detalhado de uma coleção de funcionalidades, conforme definido pelo fornecido collectionId.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
collectionId	path	True	string	Identificador (nome) de uma coleção específica.
datasetId	path	True	string	O identificador do conjunto de dados a partir do qual consultar.
geography	path	True	string	Este parâmetro especifica onde está localizado o recurso Azure Maps Criador. Os valores válidos são nós e eu.
api-version	query	True	string	Número da versão da API Azure Maps.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	CollectionDefinitionResult	Ok
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta o Trabalho, a Escola e os Convidados, mas não suporta contas Pessoais.

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

Esta é uma chave partilhada que é aprovisionada ao criar um recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
CollectionDefinitionResult	Resposta após um pedido bem-sucedido para ler a definição de uma coleção.
DefinitionProperty	A definição de uma propriedade numa coleção.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
FeaturesEndpointLink	Ligações para outros pontos finais de Funcionalidades. Para obter mais detalhes sobre as relações de ligação, visite a norma OGC API - Features - Part 1 (API OGC – Funcionalidades – Parte 1 ).
GeoJsonGeometryType	Tipo de geometria devolvida.

CollectionDefinitionResult

Resposta após um pedido bem-sucedido para ler a definição de uma coleção.

Name	Tipo	Description
description	string	Descreve a coleção.
geometryType	GeoJsonGeometryType	Tipo de geometria devolvida.
id	string	Identificador da coleção utilizada, por exemplo, em URIs.
itemType	string	O tipo de itens na coleção.
links	FeaturesEndpointLink[]	Ligações para outros pontos finais de Funcionalidades.
ontology	string	A versão da onologia deste conjunto de dados.
properties	DefinitionProperty[]	Atributos da coleção utilizada.
title	string	Título da coleção.

DefinitionProperty

A definição de uma propriedade numa coleção.

Name	Tipo	Description
name	string	Nome do atributo .
required	boolean	É um atributo obrigatório.
type	object	Tipo de atributo.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FeaturesEndpointLink

Ligações para outros pontos finais de Funcionalidades. Para obter mais detalhes sobre as relações de ligação, visite a norma OGC API - Features - Part 1 (API OGC – Funcionalidades – Parte 1 ).

Name	Tipo	Description
href	string	O destino da ligação.
rel	string	O tipo de relação.
title	string	Utilizado para etiquetar o destino de uma ligação para que possa ser utilizado como um identificador legível por humanos (por exemplo, uma entrada de menu) no idioma indicado pelo campo de cabeçalho Idioma de Conteúdo (se estiver presente).

GeoJsonGeometryType

Tipo de geometria devolvida.

Name	Tipo	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.

Partilhar via