WFS - Get Collection

Referência

Service:: Maps Creator

API Version:: 2.0

Use para obter a descrição da coleção especificada.

A Get Collection API é uma solicitação HTTP GET que retorna a descrição da coleção especificada. Ele inclui links para as operações que podem ser executadas na coleção.

A API do WFS segue o padrão da API do Open Geospatial Consortium para recursos para consultar conjuntos de dados.

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

A API de Descrição da Coleção fornece a descrição de uma determinada coleção. Ele inclui os links para as operações que podem ser executadas na coleção.

Enviar Solicitação de Obtenção de Coleção

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

Parâmetros de URI

Nome	Em	Obrigató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 do qual consultar.
geography	path	True	string	Esse parâmetro especifica onde o recurso Azure Mapas Creator está localizado. Os valores válidos são nós e eu.
api-version	query	True	string	Número de versão da API de Mapas Azure.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	Collection	Ok
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

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

Scopes

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

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

GetCollection

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definições

Nome	Description
Collection
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
WFSEndpointLink	Links para outros pontos de extremidade do WFS

Collection

Nome	Tipo	Description
description	string	uma descrição dos recursos na coleção
links	WFSEndpointLink[]	Links para outros pontos de extremidade do WFS.
name	string	identificador da coleção usada, por exemplo, em URIs
ontology	string	A versão de ontologia desse conjunto de dados.
title	string	título legível humano da coleção

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

WFSEndpointLink

Links para outros pontos de extremidade do WFS

Nome	Tipo	Description
href	string	O destino do link.
hreflang	string	Uma dica que indica qual deve ser o idioma do resultado da desreferência do link.
rel	string	O tipo de relação.
title	string	Usado para rotular o destino de um link de modo que ele possa ser usado como um identificador legível por humanos (por exemplo, uma entrada de menu) no idioma indicado pelo campo de cabeçalho Content-Language (se presente).
type	string	Uma dica que indica qual deve ser o tipo de mídia do resultado da desreferência do link.