Conversion - List

Utilisez pour obtenir la liste des conversions de données.

L’API List est une requête HTTP GET qui permet à l’appelant d’extraire une liste de toutes les conversions de données réussies envoyées précédemment à l’aide de l’API de conversion.

Envoyer une demande de liste

Pour répertorier toutes les conversions réussies, vous allez émettre une GET requête sans paramètres supplémentaires.

Réponse aux données de liste

L’API Liste de conversion retourne la liste complète de tous les détails de conversion au json format.

Voici un exemple de réponse qui retourne les détails de deux demandes de conversion réussies :

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

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

• Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps.

est Authorization URL spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

• Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et à la ou les régions d’utilisation du jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

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

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

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

Définitions

Conversion

Informations détaillées pour les demandes de conversion.

ConversionListResult

Modèle de réponse pour l’API Liste de conversion.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur