Sdílet prostřednictvím

WFS - Get Features

  • Reference
Služba:
Maps Creator
Verze rozhraní API:
2.0

Umožňuje získat podrobný seznam funkcí kolekce.

Rozhraní Get Features API je požadavek HTTP GET , který vrací podrobný seznam funkcí v zadané kolekci.

Rozhraní WFS API se řídí standardem open geoprostorového konsorcia API pro funkce pro dotazování datových sad.

Datová sada se skládá z několika kolekcí funkcí. Kolekce funkcí je kolekce funkcí podobného typu, která je založená na společném schématu.

Odeslat žádost o získání funkcí

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
S volitelnými parametry: 
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
collectionId
 path True

string

Identifikátor (název) konkrétní kolekce
datasetId
 path True

string

Identifikátor datové sady, ze které se má dotazovat.
geography
 path True

string

Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu.
api-version
 query True

string

Číslo verze rozhraní API Azure Maps.
bbox
 query

number[]

Jsou vybrány pouze prvky, které mají geometrii, která protíná zadaný ohraničující rámeček.

  • Levý dolní roh, souřadnicová osa 1 * Dolní levý roh, souřadnicová osa 2 * pravý horní roh, souřadnicová osa 1 * pravý horní roh, souřadnicová osa 2 Souřadnicový referenční systém hodnot je WGS84 zeměpisná délka/zeměpisná šířka (http://www.opengis.net/def/crs/OGC/1.3/CRS84), pokud není v parametru bbox-crszadán jiný referenční systém souřadnic . Pro WGS84 zeměpisná délka/zeměpisná šířka jsou hodnoty ve většině případů posloupností minimální délky, minimální zeměpisné šířky, maximální délky a maximální zeměpisné šířky. V případech, kdy pole překlenuje antimeridián, je však první hodnota (okraj rámečku nejvíce na západ) větší než třetí hodnota (okraj rámečku nejvíce východem).
filter
 query

string

Vyfiltrujte výraz pro vyhledání funkcí s konkrétními hodnotami vlastností v dané kolekci. Podporují se pouze vlastnosti funkcí skalárního typu a operátoru rovná se. Jedná se o speciální parametr, kde název parametru je název vlastnosti rozlišují se malá a velká písmena. Schéma pro tento parametr je {název vlastnosti}={hodnota vlastnosti}. Pokud není "filter" jedním z názvů vlastností v kolekci, neměl by se filtr používat jako název parametru. Pokud chcete vyhledat funkce s hodnotou vlastnosti "name" "21N13", použijte "name=21N13". Podporuje se více filtrů, které by měly být reprezentovány jako více parametrů dotazu. Například =&= Řetězcové hodnoty rozlišují malá a malá písmena.
limit
 query

integer

Volitelný parametr limit omezuje počet funkcí, které jsou uvedeny v dokumentu odpovědi. Počítají se pouze funkce, které jsou na první úrovni kolekce v dokumentu odpovědi. Vnořené objekty obsažené v explicitně požadovaných funkcích se nezapočítávají.

  • Minimum = 1 * Maximum = 500 * Výchozí = 10

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-id

string

Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name Typ Description
200 OK

ExtendedGeoJsonFeatureCollection

Ok
Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

GetFeatures

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
    }
  ]
}

Definice

Name Description
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Odpověď na chybu
ExtendedGeoJsonFeatureCollection

Platný GeoJSON FeatureCollection typ objektu rozšířený o pole numberReturned a links. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonFeature

Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiLineString

Platný GeoJSON MultiLineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonObjectType

Určuje GeoJSON typ: FeatureCollection.
GeoJsonPoint

Platný GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPolygon

Platný GeoJSON Polygon typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
WFSEndpointLink

Odkazy na jiné koncové body WFS

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě
code

string

Kód chyby
details

ErrorDetail[]

Podrobnosti o chybě
message

string

Chybová zpráva
target

string

Cíl chyby.

ErrorResponse

Odpověď na chybu

Name Typ Description
error

ErrorDetail

Objekt chyby.

ExtendedGeoJsonFeatureCollection

Platný GeoJSON FeatureCollection typ objektu rozšířený o pole numberReturned a links. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
features

GeoJsonFeature[]

Obsahuje seznam platných GeoJSON Feature objektů.
links

WFSEndpointLink[]

Odkazy na jiné koncové body WFS.
numberReturned

integer

Počet vrácených funkcí
ontology

string

Verze ontologie této datové sady.
type

GeoJsonObjectType

Určuje GeoJSON typ: FeatureCollection.

GeoJsonFeature

Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
featureType

string

Typ funkce. Hodnota závisí na datovém modelu, do který je aktuální funkce součástí. Některé datové modely můžou mít prázdnou hodnotu.
geometry GeoJsonGeometry:

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
id

string

Identifikátor funkce.
type string:

Feature

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
type

GeoJsonObjectType

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
geometries GeoJsonGeometry[]:

Obsahuje seznam platných GeoJSON objektů geometrie. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).
type string:

GeometryCollection

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

Souřadnice GeoJson LineString geometrie.
type string:

LineString

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiLineString

Platný GeoJSON MultiLineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

Souřadnice GeoJson MultiLineString geometrie.
type string:

MultiLineString

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

Souřadnice GeoJson MultiPoint geometrie.
type string:

MultiPoint

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

Obsahuje seznam platných GeoJSON Polygon objektů. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).
type string:

MultiPolygon

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonObjectType

Určuje GeoJSON typ: FeatureCollection.

Name Typ Description
FeatureCollection

string

GeoJSON FeatureCollection Objekt.

GeoJsonPoint

Platný GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

A Position je matice čísel se dvěma nebo více prvky. První dva prvky jsou zeměpisná délka a zeměpisná šířka, přesně v daném pořadí. Třetí volitelný prvek je nadmořská výška/nadmořská výška. Podrobnosti najdete v dokumentu RFC 7946 .
type string:

Point

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonPolygon

Platný GeoJSON Polygon typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name Typ Description
coordinates

number[]

Souřadnice typu GeoJson Polygon geometrie.
type string:

Polygon

Určuje GeoJSON typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

Odkazy na jiné koncové body WFS

Name Typ Description
href

string

Cíl odkazu.
hreflang

string

Nápověda označující jazyk výsledku dereferencování odkazu.
rel

string

Typ relace.
title

string

Slouží k označení cíle odkazu tak, aby mohl být použit jako identifikátor čitelný pro člověka (např. položka nabídky) v jazyce označeném polem hlavičky Content-Language (pokud je k dispozici).
type

string

Nápověda označující, jaký typ média by měl být výsledek dereferencování odkazu.