本檔案包含協助您使用的其他資訊 Catalog API。
部分 Catalog 物件可以與其他物件相互關聯 Catalog 物件。 前置詞為的任何欄位 @
回應中裝載表示相關物件。 這些欄位的值採用URI的形式,可用於單獨的GET請求中以擷取其表示的相關物件。
於傳回檔案中的範例資料集 查詢特定資料集 包含 files
具有下列URI值的欄位: "@/datasetFiles?datasetId={DATASET_ID}"
. 「 」的內容 files
欄位可藉由使用此URI作為新GET請求的路徑來檢視。
API格式
GET {OBJECT_URI}
參數 | 說明 |
---|---|
{OBJECT_URI} |
相互關聯的物件欄位提供的URI (不包括 @ 符號)。 |
要求
以下請求會使用URI,提供範例資料集的 files
屬性以擷取資料集的相關檔案清單。
curl -X GET \
'https://platform.adobe.io/data/foundation/catalog/dataSets/datasetFiles?datasetId={DATASET_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
成功的回應會傳回相關物件清單。 在此範例中,會傳回資料集檔案清單。
{
"7d501090-0280-11ea-a6bb-f18323b7005c-1": {
"id": "7d501090-0280-11ea-a6bb-f18323b7005c-1",
"batchId": "7d501090-0280-11ea-a6bb-f18323b7005c",
"dataSetViewId": "5ba9452f7de80400007fc52b",
"imsOrg": "{ORG_ID}",
"createdUser": "{USER_ID}",
"createdClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"version": "1.0.0",
"created": 1573256315368,
"updated": 1573256315368
},
"148ac690-0280-11ea-8d23-8571a35dce49-1": {
"id": "148ac690-0280-11ea-8d23-8571a35dce49-1",
"batchId": "148ac690-0280-11ea-8d23-8571a35dce49",
"dataSetViewId": "5ba9452f7de80400007fc52b",
"imsOrg": "{ORG_ID}",
"createdUser": "{USER_ID}",
"createdClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"version": "1.0.0",
"created": 1573255982433,
"updated": 1573255982433
},
"64dd5e19-8ea4-4ddd-acd1-f43cccd8eddb-1": {
"id": "64dd5e19-8ea4-4ddd-acd1-f43cccd8eddb-1",
"batchId": "64dd5e19-8ea4-4ddd-acd1-f43cccd8eddb",
"dataSetViewId": "5ba9452f7de80400007fc52b",
"imsOrg": "{ORG_ID}",
"createdUser": "{USER_ID}",
"createdClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"version": "1.0.0",
"created": 1569499425037,
"updated": 1569499425037
}
}
Catalog 提供數個標題慣例,協助您在更新期間維持資料的完整性。
使用物件版本設定是很好的做法,以防止當多個使用者幾乎同時儲存物件時會發生型別的資料損毀。
更新物件時的最佳實務涉及先進行API呼叫以檢視(GET)要更新的物件。 包含在回應中(以及回應包含單一物件的任何呼叫)是 E-Tag
包含物件版本的標頭。 將物件版本新增為名為的請求標頭 If-Match
只有在版本仍相同的情況下,更新(PUT或PATCH)呼叫才會導致更新成功,有助於防止資料衝突。
如果版本不符(物件自您擷取以來被其他處理序修改),您將會收到HTTP狀態412 (先決條件失敗),指出存取目標資源已遭拒。
有時您可能希望驗證物件而不儲存資訊。 使用 Pragma
值為「 」的標頭 validate-only
可讓您傳送POST或PUT請求,但僅供驗證之用,以防止儲存對資料所做的任何變更。
壓縮是 Experience Platform 此服務可將小型檔案中的資料合併成大型檔案,而不需變更任何資料。 基於效能考量,將一組小型檔案合併成大型檔案有時會有好處,以便在查詢時提供對資料的更快速存取。
當內嵌批次中的檔案已壓縮時,其相關聯的 Catalog 物件會更新以供監視之用。