Show Menu
トピック×

リストオブジェクト

1回のAPI呼び出しで、特定のタイプの使用可能なすべてのオブジェクトのリストを取得できます。ベストプラクティスは、応答のサイズを制限するフィルターを含めることです。
API形式
GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}

パラメーター
説明
{OBJECT_TYPE}
表示するカタログオブジェクトの種類です。 有効なオブジェクトは次のとおりです。
  • accounts
  • batches
  • connections
  • connectors
  • dataSets
  • dataSetFiles
  • dataSetViews
{FILTER}
応答で返される結果をフィルターするために使用するクエリパラメーター。 複数のパラメーターは、アンパサンド( & )で区切られます。 詳しくは、カタログデータの フィルタリングに関するガイド を参照してください。
リクエスト
以下のサンプルリクエストでは、データセットのリストを取得します。5つの結果に対する応答を減らす limit フィルターと、各データセットに対して表示されるプロパティを制限する properties フィルターが用意されています。
curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?limit=5&properties=name,description,files' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
正常な応答は、リクエストで提供されるクエリパラメーターでフィルタリングされた、キーと値のペアの形式のCatalogオブジェクトのリストを返します。 キーと値のペアごとに、キーは対象のCatalogオブジェクトの固有な識別子を表します。この識別子は、特定のオブジェクトを呼び出す別の呼び出しで使用して 表示を詳細にすることができます
返されたオブジェクトに、 properties クエリが示す要求されたプロパティが1つ以上含まれていない場合、以下の「Sample Dataset 3」と「Sample Dataset 4」に示すように、応答は、そのオブジェクトに含まれる要求されたプロパティのみを返します。
{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSets/5bb276b03a14440000971552/views/5bb276b01250b012f9acc75b/files"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSets/5bda3a4228babc0000126377/views/5bda3a4228babc0000126378/files"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSets/5bde21511dd27b0000d24e95/views/5bde21511dd27b0000d24e96/files"
    }
}