4.1.1 使用可能なデータセットのリスト表示

次のリクエストは、アクセス・トークン内に埋め込まれたユーザーが使用できるデータセットをすべてリストします:

HTTP GETリクエスト

curl -k https://localhost:4040/spatialstudio/oauth/v1/datasets \
 --header "Authorization: Bearer <MY_TOKEN>”

前述のリクエストは、トークン所有者が所有または作成したすべてのデータセットと、他のアプリケーション・ユーザーがアクセスできるパブリックと(所有者によって)マークされたデータセットが含まれるJSONドキュメントを返します。JSONレスポンスには、id、name、type、source表名(該当する場合)、列、他の多くのメタデータなど、データセットのあらゆる側面を記述するJSONオブジェクトが含まれます。

前述のリクエストで使用されるアクセス・トークンは、データセットのストリーミング専用トークンではなく、汎用トークン(具体的なユース・ケースに応じてread-onlyまたはread-write)である必要があります。これは、ストリーム専用アクセス・トークンを使用してSpatial Studioサーバーからメタデータを問い合せることができないためです。その結果、前述のリクエストでストリーム専用トークンを渡すと、必要なレスポンスが得られません。

あるいは、追加の問合せパラメータfieldsを指定して、各データセットに対して返されるデータをフィルタすることもできます。たとえば、レスポンスで使用可能なすべてのデータセットの一意のidおよびnameのみが必要な場合、リクエストは次のようになります:

問合せパラメータを指定したリクエスト:

curl -k https://localhost:4040/spatialstudio/oauth/v1/datasets?fields=id,name \
 --header "Authorization: Bearer <MY_TOKEN>”

レスポンス:

{"items":[
{
  "id" : "3ee71ae5ba84cc5afd0728643e878f29",
  "name" : "LANDSAT5_IMAGES"
},
{
  "id" : "d06d0b711e10997c1c886b731b1c45b8",
  "name" : "AIRPORT_POINT"
},
{
  "id" : "fd6f55d0773dcda639e07b00e5ba431a",
  "name" : "INTERSTATES"
},
{
  "id" : "5b68bd621ee6f58af0bd0cb20f600a38",
  "name" : "NY_INDIAN_TERRITORIES"
}]
}

前述のレスポンスでは、次のとおりです:

• 各データセットは、items配列内の要素として表されます。
• 各アイテム(データセット)には、データセットのidとnameの両方が含まれます。レスポンスで返されるidは、データセットの一意のIDです。Spatial Studioでは、データセット、プロジェクト、接続やデータ・ソース、さらにはデータセット内の列など、作成したすべてのオブジェクトに、グローバルに一意のidが割り当てられることに注意してください。ほとんどの場合、REST APIでは、データセットや接続などのユーザー作成オブジェクトを参照するときに、これらの一意のidのみを使用します。