Conversion - List

Odwołanie

Usługa:: Maps Creator

Wersja interfejsu API:: 2.0

Użyj polecenia , aby uzyskać listę konwersji danych.

Interfejs List API to żądanie HTTP GET , które umożliwia wywołującym pobranie listy wszystkich pomyślnych konwersji danych przesłanych wcześniej przy użyciu interfejsu API konwersji.

Prześlij żądanie listy

Aby wyświetlić listę wszystkich pomyślnych konwersji, należy wysłać GET żądanie bez dodatkowych parametrów.

Odpowiedź na dane listy

Interfejs API listy konwersji zwraca pełną listę wszystkich szczegółów konwersji w json formacie.

Oto przykładowa odpowiedź zwracająca szczegóły dwóch pomyślnych żądań konwersji:

{
    "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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
geography	path	True	string	Ten parametr określa, gdzie znajduje się zasób Azure Maps Creator. Prawidłowe wartości to my i eu.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ConversionListResult	Żądanie listy zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Returns a list of all the data processed by the Conversion Service for the account

Przykładowe żądanie

HTTP

GET https://us.atlas.microsoft.com/conversions?api-version=2.0

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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
      }
    }
  ]
}

Definicje

Nazwa	Opis
Conversion	Szczegółowe informacje dotyczące żądań konwersji.
ConversionListResult	Model odpowiedzi interfejsu API listy konwersji.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

Conversion

Szczegółowe informacje dotyczące żądań konwersji.

Nazwa	Typ	Opis
conversionId	string	Unikatowy identyfikator reprezentujący artefakt pomyślnie ukończonego procesu konwersji.
created	string	Data i godzina tej konwersji.
description	string	Użytkownik podał opis konwertowanej zawartości.
featureCounts	object	Podsumowanie liczby funkcji w tej konwersji.
ontology	string	Wersja ontologii tego zestawu danych.
udid	string	Unikatowy identyfikator zawartości udostępnionej do utworzenia tej konwersji.

ConversionListResult

Model odpowiedzi interfejsu API listy konwersji.

Nazwa	Typ	Opis
conversions	Conversion[]	Lista wszystkich wcześniej przesłanych żądań konwersji.
nextLink	string	Jeśli jest obecny, lokalizacja następnej strony danych.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Udostępnij za pośrednictwem