Catalog Service API指南附錄
本檔案包含協助您使用Catalog API的其他資訊。
檢視相互關聯的物件 view-interrelated-objects
某些Catalog物件可以與其他Catalog物件相互關聯。 任何在回應裝載中以@為前置詞的欄位都表示相關物件。 這些欄位的值採用URI的形式，可用於單獨的GET請求中以擷取其表示的相關物件。
在上查詢特定資料集的檔案中傳回的範例資料集包含具有下列URI值的files欄位： "@/datasetFiles?datasetId={DATASET_ID}"。 使用此URI作為新GET要求的路徑，可以檢視files欄位的內容。
API格式
GET {OBJECT_URI}
{OBJECT_URI}@符號）。要求
以下請求使用提供範例資料集的files屬性的URI來擷取資料集關聯檔案的清單。
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提供數個標題慣例，協助您在更新期間維持資料的完整性。
If-Match
使用物件版本設定是很好的做法，以防止當多個使用者幾乎同時儲存物件時會發生型別的資料損毀。
更新物件時的最佳實務涉及先進行API呼叫以檢視(GET)要更新的物件。 包含在回應（以及任何包含單一物件的呼叫）中的E-Tag標頭是包含物件版本的。 將物件版本新增為更新(PUT或PATCH)呼叫中名為If-Match的請求標頭，只有在版本仍相同的情況下才會導致更新成功，有助於防止資料衝突。
如果版本不符（物件自您擷取以來被其他處理序修改），您將會收到HTTP狀態412 （先決條件失敗），指出存取目標資源已遭拒。
Pragma
有時您可能希望驗證物件而不儲存資訊。 使用值為validate-only的Pragma標頭可讓您傳送POST或PUT要求僅供驗證之用，以防止資料的任何變更持續存在。
資料壓縮
壓縮是一項Experience Platform服務，可將小型檔案中的資料合併到大型檔案中，而不會變更任何資料。 基於效能考量，將一組小型檔案合併成大型檔案有時會有好處，以便在查詢時提供對資料的更快速存取。
當內嵌批次中的檔案已壓縮後，其相關聯的Catalog物件會更新以進行監視。