WFS - Get Collections
Gunakan untuk mendapatkan deskripsi semua koleksi dalam himpunan data.
API adalah permintaan HTTP GET
yang menyediakan deskripsi semua koleksi dalam himpunan Get Collections
data yang ditentukan.
API WFS mengikuti standar Open Geospatial Consortium API untuk Fitur untuk mengkueriHimpunan Data.
Himpunan data terdiri dari beberapa koleksi fitur. Koleksi fitur adalah kumpulan fitur dengan jenis yang sama, berdasarkan skema umum.
API Deskripsi Koleksi menyediakan deskripsi semua koleksi dalam himpunan data tertentu. Untuk informasi selengkapnya, lihat API layanan Fitur Web
Kirim Permintaan Dapatkan Koleksi
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections?api-version=2.0
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
dataset
|
path | True |
string |
Pengidentifikasi untuk himpunan data yang akan dikueri. |
geography
|
path | True |
string |
Parameter ini menentukan lokasi sumber daya Azure Maps Creator. Nilai yang valid adalah kita dan Uni Eropa. |
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-client-id |
string |
Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
Terjadi kesalahan tak terduga. |
Keamanan
AADToken
Ini adalah alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.
Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.
Catatan
- Definisi keamanan ini memerlukan penggunaan
x-ms-client-id
header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.
Authorization URL
khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID.
* Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
* Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
- Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.
Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut diterbitkan.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.
Type:
apiKey
In:
query
SAS Token
Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol fine-grain ke kedaluwarsa, tarif, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.
Type:
apiKey
In:
header
Contoh
GetCollections
Sample Request
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0
Sample Response
{
"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"
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Collection | |
Collections |
|
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
WFSEndpoint |
Tautan ke titik akhir WFS lainnya |
Collection
Nama | Jenis | Deskripsi |
---|---|---|
description |
string |
deskripsi fitur dalam koleksi |
links |
Tautan ke titik akhir WFS lainnya. |
|
name |
string |
pengidentifikasi koleksi yang digunakan, misalnya, dalam URI |
ontology |
string |
Versi ontologi himpunan data ini. |
title |
string |
judul koleksi yang dapat dibaca manusia |
CollectionsResponse
Nama | Jenis | Deskripsi |
---|---|---|
collections |
Semua koleksi dalam himpunan data tertentu. |
|
links |
Tautan ke titik akhir WFS lainnya. |
|
ontology |
string |
Versi ontologi himpunan data ini. |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorDetail
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
WFSEndpointLink
Tautan ke titik akhir WFS lainnya
Nama | Jenis | Deskripsi |
---|---|---|
href |
string |
Target tautan. |
hreflang |
string |
Petunjuk yang menunjukkan apa bahasa hasil dereferensi tautan. |
rel |
string |
Jenis relasi. |
title |
string |
Digunakan untuk memberi label tujuan tautan sehingga dapat digunakan sebagai pengidentifikasi yang dapat dibaca manusia (misalnya, entri menu) dalam bahasa yang ditunjukkan oleh bidang header Content-Language (jika ada). |
type |
string |
Petunjuk yang menunjukkan jenis media dari hasil dereferensi tautan. |