Conversion - List
Slouží k získání seznamu převodů dat.
Rozhraní List
API je požadavek HTTP GET
, který umožňuje volajícímu načíst seznam všech úspěšných převodů dat odeslaných dříve pomocí rozhraní API pro převod.
Odeslat žádost o seznam
Pokud chcete zobrazit seznam všech úspěšných převodů, odešlete požadavek bez GET
dalších parametrů.
Odpověď na výpis dat
Rozhraní API seznamu převodů vrátí úplný seznam všech podrobností převodu ve json
formátu .
Tady je ukázková odpověď vracející podrobnosti dvou úspěšných žádostí o převod:
{
"conversions":
[
{
"conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
"udid": "31838736-8b84-11ea-bc55-0242ac130003",
"created": "5/19/2020 9:00:00 AM +00:00",
"description": "User provided description.",
"featureCounts": {
"DIR": 1,
"LVL": 3,
"FCL": 1,
"UNIT": 150,
"CTG": 8,
"AEL": 0,
"OPN": 10
}
},
{
"conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",
"udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",
"created": "5/19/2020 9:00:00 AM +00:00",
"description": "User provided description.",
"featureCounts": {
"DIR": 1,
"LVL": 3,
"FCL": 1,
"UNIT": 150,
"CTG": 8,
"AEL": 0,
"OPN": 10
}
}
]
}
GET https://{geography}.atlas.microsoft.com/conversions?api-version=2.0
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
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. |
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 je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Žádost o výpis byla úspěšně dokončena. |
|
Other Status Codes |
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 složené 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 pro konkrétní rozhraní API a obory.
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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
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í.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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ůže každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.
U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Type:
apiKey
In:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku 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 autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečený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 účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
Returns a list of all the data processed by the Conversion Service for the account
Sample Request
GET https://us.atlas.microsoft.com/conversions?api-version=2.0
Sample Response
{
"conversions": [
{
"conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
"udid": "31838736-8b84-11ea-bc55-0242ac130003",
"created": "5/19/2020 9:00:00 AM +00:00",
"description": "User provided description.",
"ontology": "facility-2.0",
"featureCounts": {
"directoryInfo": 1,
"level": 3,
"facility": 1,
"unit": 150,
"category": 8,
"areaElement": 0,
"opening": 10
}
},
{
"conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",
"udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",
"created": "5/20/2020 11:30:00 AM +00:00",
"description": "User provided description.",
"ontology": "facility-2.0",
"featureCounts": {
"structure": 614,
"directoryInfo": 1,
"level": 2,
"facility": 1,
"unit": 461,
"category": 30,
"verticalPenetration": 8,
"opening": 270
}
}
]
}
Definice
Name | Description |
---|---|
Conversion |
Podrobné informace o žádostech o převod. |
Conversion |
Model odpovědí pro rozhraní API seznamu převodů. |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Conversion
Podrobné informace o žádostech o převod.
Name | Typ | Description |
---|---|---|
conversionId |
string |
Jedinečné ID, které představuje artefakt úspěšně dokončeného procesu převodu. |
created |
string |
Datum a čas tohoto převodu. |
description |
string |
Uživatel uvedl popis převáděného obsahu. |
featureCounts |
object |
Souhrn počtů funkcí v tomto převodu |
ontology |
string |
Verze ontologie této datové sady. |
udid |
string |
Jedinečné ID obsahu zadaného k vytvoření tohoto převodu. |
ConversionListResult
Model odpovědí pro rozhraní API seznamu převodů.
Name | Typ | Description |
---|---|---|
conversions |
Seznam všech dříve odeslaných žádostí o převod. |
|
nextLink |
string |
Pokud je k dispozici, umístění další stránky dat. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |