Dataset - Get

適用対象: 価格 レベルを参照してください。

Creator では、Azure Maps API と SDK を使用して、プライベート 屋内マップ データに基づいてアプリケーションを開発できます。 この記事では、Azure Maps Creator に適用される概念とツールについて説明します。

この API を使用すると、呼び出し元は、以前に正常に作成されたデータセットをフェッチできます。

詳細の取得要求を送信する

以前に作成したデータセットの詳細を取得するには、パスに要求をdatasetId発行GETします。

詳細の応答を取得する

Get Details API は、データセットの詳細を形式で json 返します。 応答には、次のフィールドが含まれます (null または空でない場合)。

created - データセットが作成されたタイムスタンプ。 datasetId - データセットの ID。 description - データセットの説明。 datasetSources - 作成要求が発行されたときに使用されたソース データ。 ontology - 入力データの変換サービスで使用されたソース オントロジ

作成 datasetSources 要求が発行されたときに使用されたソース データについて説明し、次の要素 (null または空でない場合) が含まれています。

conversionIds - (指定されていない場合は null) の conversionId 一覧。 appendDatasetId - datasetId 追加操作に使用された値 (使用されなかった場合は null)。 featureCounts - データセット内の各フィーチャ タイプの数。

データセット リソースの 、、datasetSourcesdatasetIddescriptionontology返すtimestamp応答の例を次に示します。

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ],
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }
GET https://{geography}.atlas.microsoft.com/datasets/{datasetId}?api-version=2.0

URI パラメーター

Name In Required Type Description
datasetId
path True
  • string

クエリの対象となるデータセットの識別子。

geography
path True
  • string

このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は us と eu です。

api-version
query True
  • string

Azure Maps API のバージョン番号。

要求ヘッダー

Name Required Type Description
x-ms-client-id
  • string

Azure AD セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは、Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure Mapsで Azure AD セキュリティを使用するには、次の記事でガイダンスを参照してください。

応答

Name Type Description
200 OK

データセットの取得要求が正常に完了しました。

Other Status Codes

予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Maps リソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 ユーザー、グループ、またはサービス プリンシパルには、組み込みロールまたは REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成されたカスタム ロールを使用してアクセス権を付与できます。

シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデリングするためのソリューションを提供します。

Notes

  • このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Mapsを示す必要があります。 これは、 Maps 管理 API から取得できます。

これは Authorization URL 、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。

  • 現在、Azure Active Directory v1.0 または v2.0 は 職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

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

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。

公開されているアプリケーションの場合は、機密クライアント アプリケーション アプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、アプリケーションは Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用する有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。 言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

Get details for a previously created dataset

Sample Request

GET https://us.atlas.microsoft.com/datasets/[datasetId]?api-version=2.0

Sample Response

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location
{
  "created": "2021-05-21T01:02:03.456Z",
  "datasetId": "[datasetId]",
  "description": "Some description or comment about the dataset",
  "datasetSources": {
    "conversionIds": [
      "15d21452-c9bb-27b6-5e79-743ca5c3205d",
      "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d"
    ],
    "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

定義

Dataset

データセットの詳細情報。

DatasetSources

データセットの作成要求の詳細に関する情報。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

Dataset

データセットの詳細情報。

Name Type Description
created
  • string

データセットの作成されたタイムスタンプ。

datasetId
  • string

データセットの ID。

datasetSources

データセットの作成要求の詳細に関する情報。

description
  • string

データセットの説明。

featureCounts
  • object

データセットの特徴数。

ontology
  • string

このデータセットのオントロジ バージョン。

DatasetSources

データセットの作成要求の詳細に関する情報。

Name Type Description
appendDatasetId
  • string

現在のデータセットを作成するために追加されたデータセット。

conversionIds
  • string[]

データセットの conversionId 作成に使用されたリスト。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ErrorResponse

エラー応答

Name Type Description
error

エラー オブジェクト。