WFS - Get Collections

リファレンス

サービス:: Maps Creator

API バージョン:: 2.0

データセット内のすべてのコレクションの説明を取得するには、を使用します。

Get Collections API は、指定されたデータセット内のすべてのコレクションの説明を提供する HTTP GET 要求です。

WFS API は、Open Geospatial Consortium API standard for Features に従ってデータセットにクエリを実行します。

データセットは、複数の特徴コレクションで構成されます。フィーチャーコレクションは、共通スキーマに基づく、同様の型の特徴のコレクションです。

Collections Description API は、特定のデータセット内のすべてのコレクションの説明を提供します。詳細については、「Web Feature Service 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	Azure Maps API のバージョン番号。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前	型	説明
200 OK	CollectionsResponse	[OK]
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、ユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

は Authorization URL 、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用してプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションですべての REST API にアクセスできます。つまり、このキーは、発行先のアカウントのマスターキーとして使用できます。

公開されているアプリケーションの場合は、機密クライアントアプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

型: apiKey
/: header

例

GetCollections

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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 オブジェクト。

WFSEndpointLink

他の WFS エンドポイントへのリンク

名前	型	説明
href	string	リンク先。
hreflang	string	リンクを逆参照した結果の言語を示すヒント。
rel	string	関係の種類。
title	string	リンクの宛先にラベルを付けるために使用され、Content-Language ヘッダーフィールド (存在する場合) によって示される言語で人間が判読できる識別子 (メニューエントリなど) として使用できます。
type	string	リンクを逆参照した結果のメディアの種類を示すヒント。

次の方法で共有