WFS - Get Collection Definition

Referência

Serviço:: Maps Creator

Versão da API:: 2.0

Utilizado para obter um modelo de dados detalhado de uma coleção.

A Get Collection Definition API é um pedido HTTP GET que fornece um modelo de dados detalhado da coleção especificada.

A API WFS segue a norma open Geospatial Consortium API for Features to query Datasets (Abrir a API de Consórcio Geoespacial para Funcionalidades para consultar Conjuntos de Dados).

Um conjunto de dados consiste em várias coleções de funcionalidades. Uma coleção de funcionalidades é uma coleção de funcionalidades de um tipo semelhante, com base num esquema comum.

###Submit Obter Pedido de Definição de Coleção

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

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 pode consultar.
geography	path	True	string	Este parâmetro especifica onde está localizado o recurso Azure Maps Creator. Os valores válidos somos 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 veja os seguintes artigos para obter orientações.

Respostas

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

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. 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 Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

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 de Microsoft Entra ID. * 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.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de 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.

Tipo: apiKey
Em: header

Exemplos

GetCollectionDefinition

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Definições

Name	Description
CollectionDefinition	coleção de funcionalidades GeoJSON
DefinitionProperty
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
GeoJsonGeometryType	tipo de geometria devolvida
WFSEndpointLink	Ligações para outros pontos finais do WFS

CollectionDefinition

coleção de funcionalidades GeoJSON

Name	Tipo	Description
description	string	descreve a coleção
featureTypes	string[]	tipo de funcionalidades devolvidas
geometryType	GeoJsonGeometryType	tipo de geometria devolvida
idPrefix	string	prefixo da coleção utilizada
links	WFSEndpointLink[]	Ligações para outros pontos finais do WFS.
name	string	identificador da coleção utilizada, por exemplo, em URIs
ontology	string	A versão de ontology deste conjunto de dados.
properties	DefinitionProperty[]	atributos da coleção utilizada
title	string	título da coleção

DefinitionProperty

Name	Tipo	Description
name	string	nome do atributo
required	boolean	é atributo necessá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ção adicional.

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.

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.

WFSEndpointLink

Ligações para outros pontos finais do WFS

Name	Tipo	Description
href	string	O destino da ligação.
hreflang	string	Uma sugestão que indica qual deve ser o idioma do resultado da descontinuação da ligação.
rel	string	O tipo de relação.
title	string	Utilizado para etiquetar o destino de uma ligação de modo a poder 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).
type	string	Uma sugestão que indica qual deve ser o tipo de suporte de dados do resultado da desferição da ligação.

Partilhar via