Bagikan melalui

WFS - Get Features

  • Referensi
Layanan:
Maps Creator
Versi API:
2.0

Gunakan untuk mendapatkan daftar detail fitur koleksi.

Get Features API adalah permintaan HTTP GET yang mengembalikan daftar fitur terperinci dalam koleksi 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.

Kirim Permintaan Dapatkan Fitur

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
Dengan parameter opsional: 
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
collectionId
 path True

string

Pengidentifikasi (nama) koleksi tertentu
datasetId
 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.
bbox
 query

number[]

Hanya fitur yang memiliki geometri yang bersinggungan dengan kotak pembatas yang disediakan yang dipilih.

  • Sudut kiri bawah, sumbu koordinat 1 * Sudut kiri bawah, sumbu koordinat 2 * Sudut kanan atas, sumbu koordinat 1 * Sudut kanan atas, sumbu koordinat 2 Sistem referensi koordinat nilai adalah bujur/lintang WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84) kecuali sistem referensi koordinat yang berbeda ditentukan dalam parameter bbox-crs. Untuk bujur/lintang WGS84, nilainya dalam banyak kasus urutan bujur minimum, lintang minimum, bujur maksimum, dan lintang maksimum. Namun, dalam kasus di mana kotak mencakup antimeridian, nilai pertama (tepi kotak paling barat) lebih besar dari nilai ketiga (tepi kotak paling timur).
filter
 query

string

Filter ekspresi untuk mencari fitur dengan nilai properti tertentu dalam koleksi tertentu. Hanya properti fitur jenis skalar dan operator yang sama yang didukung. Ini adalah parameter khusus di mana nama parameter adalah nama properti peka huruf besar/kecil. Skema untuk parameter ini adalah {property name}={property value}. Kecuali "filter" adalah salah satu nama properti dalam koleksi, "filter" tidak boleh digunakan sebagai nama parameter. Untuk mencari fitur dengan nilai properti "nama" "21N13", gunakan "name=21N13". Beberapa filter didukung dan harus direpresentasikan sebagai beberapa parameter kueri. Misalnya, =&= Nilai string peka huruf besar/kecil.
limit
 query

integer

Parameter batas opsional membatasi jumlah fitur yang disajikan dalam dokumen respons. Hanya fitur yang berada pada tingkat pertama koleksi dalam dokumen respons yang dihitung. Objek berlapis yang terkandung dalam fitur yang diminta secara eksplisit tidak akan dihitung.

  • Minimum = 1 * Maksimum = 500 * Default = 10

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

ExtendedGeoJsonFeatureCollection

Ok
Other Status Codes

ErrorResponse

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.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

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 dikeluarkan.

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.

Jenis: apiKey
Dalam: 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 halus ke kedaluwarsa, laju, 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 asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

GetFeatures

Permintaan sampel

GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46

Respon sampel

Kode status:
200 
{
  "type": "FeatureCollection",
  "ontology": "Facility-2.0",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              139.6330405782921,
              35.45768668610856
            ],
            [
              139.63296283234274,
              35.45778390425868
            ],
            [
              139.63308672404617,
              35.45785022906202
            ],
            [
              139.6331451691671,
              35.45777714569986
            ],
            [
              139.6331274703629,
              35.45776767074717
            ],
            [
              139.63314677109963,
              35.45774353588138
            ],
            [
              139.6330405782921,
              35.45768668610856
            ]
          ]
        ]
      },
      "properties": {
        "originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
        "categoryId": "CTG10",
        "isOpenArea": false,
        "navigableBy": [
          "pedestrian"
        ],
        "isRoutable": false,
        "routeThroughBehavior": "allowed",
        "nonPublic": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "addressRoomNumber": "",
        "name": "21N13",
        "nameSubtitle": "",
        "nameAlt": ""
      },
      "id": "UNIT39",
      "featureType": ""
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
      "rel": "self"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
      "rel": "data"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
      "rel": "next"
    }
  ]
}

Definisi

Nama Deskripsi
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan
ExtendedGeoJsonFeatureCollection

Jenis objek yang valid GeoJSON FeatureCollection diperluas dengan numberReturned dan array tautan. Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonFeature

Jenis objek yang valid GeoJSON Feature . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometry

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometryCollection

Jenis objek yang valid GeoJSON GeometryCollection . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonLineString

Jenis geometri yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiLineString

Jenis geometri yang valid GeoJSON MultiLineString . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPoint

Jenis geometri yang valid GeoJSON MultiPoint . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPolygon

Jenis objek yang valid GeoJSON MultiPolygon . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonObjectType

GeoJSON Menentukan jenis: FeatureCollection.
GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPolygon

Jenis geometri yang valid GeoJSON Polygon . Silakan merujuk ke RFC 7946 untuk detailnya.
WFSEndpointLink

Tautan ke titik akhir WFS lainnya

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

ErrorAdditionalInfo[]

Info tambahan kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Detail kesalahan.
message

string

Pesan kesalahan.
target

string

Target kesalahan.

ErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

ExtendedGeoJsonFeatureCollection

Jenis objek yang valid GeoJSON FeatureCollection diperluas dengan numberReturned dan array tautan. Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
features

GeoJsonFeature[]

Berisi daftar objek yang valid GeoJSON Feature .
links

WFSEndpointLink[]

Tautan ke titik akhir WFS lainnya.
numberReturned

integer

Jumlah fitur yang dikembalikan.
ontology

string

Versi ontologi himpunan data ini.
type

GeoJsonObjectType

GeoJSON Menentukan jenis: FeatureCollection.

GeoJsonFeature

Jenis objek yang valid GeoJSON Feature . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
featureType

string

Jenis fitur. Nilai tergantung pada model data yang menjadi bagian dari fitur saat ini. Beberapa model data mungkin memiliki nilai kosong.
geometry GeoJsonGeometry:

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
id

string

Pengidentifikasi untuk fitur tersebut.
type string:

Feature

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometry

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
type

GeoJsonObjectType

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometryCollection

Jenis objek yang valid GeoJSON GeometryCollection . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
geometries GeoJsonGeometry[]:

Berisi daftar objek geometri yang valid GeoJSON . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type string:

GeometryCollection

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonLineString

Jenis geometri yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson LineString untuk geometri.
type string:

LineString

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiLineString

Jenis geometri yang valid GeoJSON MultiLineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson MultiLineString untuk geometri.
type string:

MultiLineString

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPoint

Jenis geometri yang valid GeoJSON MultiPoint . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson MultiPoint untuk geometri.
type string:

MultiPoint

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPolygon

Jenis objek yang valid GeoJSON MultiPolygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Berisi daftar objek yang valid GeoJSON Polygon . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type string:

MultiPolygon

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonObjectType

GeoJSON Menentukan jenis: FeatureCollection.

Nama Jenis Deskripsi
FeatureCollection

string

GeoJSON FeatureCollection Objek.

GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Position adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah garis bujur dan lintang, tepatnya dalam urutan tersebut. Ketinggian/Elevasi adalah elemen ketiga opsional. Silakan merujuk ke RFC 7946 untuk detailnya.
type string:

Point

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPolygon

Jenis geometri yang valid GeoJSON Polygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson Polygon untuk jenis geometri.
type string:

Polygon

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

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.