匯出端點
Schema Library內的所有資源都包含在Adobe Experience Platform內的特定沙箱中。 在某些情況下,您可能會想要在沙箱和組織之間共用Experience Data Model (XDM)資源。 Schema Registry API中的/rpc/export
端點可讓您為Schema Library中的任何結構描述、結構描述欄位群組或資料型別產生匯出裝載,然後使用該裝載,透過/rpc/import
端點將該資源(以及所有相依資源)匯入目標沙箱和組織。
快速入門
/rpc/export
端點是Schema Registry API的一部分。 繼續之前,請先檢閱快速入門手冊,以取得相關檔案的連結、閱讀本檔案中範例API呼叫的手冊,以及有關成功呼叫任何Experience PlatformAPI所需必要標題的重要資訊。
/rpc/export
端點是Schema Registry支援的遠端程式呼叫(RPC)的一部分。 與Schema Registry API中的其他端點不同,RPC端點不需要Accept
或Content-Type
等其他標頭,也不使用CONTAINER_ID
。 相反地,他們必須使用/rpc
名稱空間,如下面的API呼叫所示。
產生資源的匯出裝載 export
對於Schema Library中的任何現有結構描述、欄位群組或資料型別,您可以透過向/export
端點發出GET要求來產生匯出裝載,並在路徑中提供資源的識別碼。
API格式
GET /rpc/export/{RESOURCE_ID}
{RESOURCE_ID}
meta:altId
或URL編碼的$id
。要求
下列要求會擷取Restaurant
欄位群組的匯出裝載。
curl -X GET \
https://platform.adobe.io/data/foundation/schemaregistry/rpc/export/_{TENANT_ID}.mixins.922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9 \
-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}' \
-H 'Accept: application/vnd.adobe.xdm-link+json'
回應
成功的回應會傳回物件陣列,代表目標XDM資源及其所有相依資源。 在此範例中,陣列中的第一個物件是Restaurant
欄位群組採用之租使用者建立的Property
資料型別,而第二個物件是Restaurant
欄位群組本身。 然後,此承載可用於將資源匯入不同的沙箱或組織。
請注意,資源租使用者ID的所有執行個體都會取代為<XDM_TENANTID_PLACEHOLDER>
。 這可讓結構描述登入根據資源在後續匯入呼叫中的傳送位置,自動將正確的租使用者ID套用至資源。
[
{
"$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/datatypes/fc07162ee7ca8d18e074a3bb50c3938c76160bf6040e8495",
"meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.datatypes.fc07162ee7ca8d18e074a3bb50c3938c76160bf6040e8495",
"meta:resourceType": "datatypes",
"version": "1.0",
"title": "Property",
"type": "object",
"description": "",
"definitions": {
"customFields": {
"properties": {
"propertyId": {
"title": "Property ID",
"description": "ID for a company-owned property.",
"type": "string",
"isRequired": false,
"meta:ui": {
"ref": [
"schema://5fbc29ec292534000055dd55",
"#/definitions/customFields"
],
"path": "{}._<XDM_TENANTID_PLACEHOLDER>{}.property{}.propertyId",
"editable": true,
"generateDate": 1606168175975
},
"meta:xdmType": "string"
},
"jurisdiction": {
"title": "Jurisdiction",
"description": "",
"type": "string",
"isRequired": false,
"enum": [
"NA",
"UK",
"EU"
],
"meta:enum": {
"NA": "North America",
"UK": "United Kingdom",
"EU": "European Union"
},
"meta:ui": {
"ref": [
"schema://5fbc29ec292534000055dd55",
"#/definitions/customFields"
],
"path": "{}._<XDM_TENANTID_PLACEHOLDER>{}.property{}.jurisdiction",
"editable": true,
"generateDate": 1606168175975
},
"meta:xdmType": "string"
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:xdmType": "object",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
},
{
"$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9",
"meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.mixins.922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9",
"meta:resourceType": "mixins",
"version": "1.0",
"title": "Restaurant",
"type": "object",
"description": "",
"definitions": {
"customFields": {
"type": "object",
"properties": {
"_<XDM_TENANTID_PLACEHOLDER>": {
"type": "object",
"properties": {
"capacity": {
"title": "Capacity",
"description": "Restaurant capacity",
"type": "string",
"isRequired": false,
"meta:xdmType": "string"
},
"kitchen": {
"title": "Kitchen Style",
"description": "Style of kitchen",
"type": "string",
"isRequired": false,
"meta:xdmType": "string"
},
"rating": {
"title": "Rating",
"description": "",
"type": "integer",
"isRequired": false,
"meta:xdmType": "int"
},
"property": {
"title": "Property",
"description": "",
"$ref": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/datatypes/fc07162ee7ca8d18e074a3bb50c3938c76160bf6040e8495",
"type": "object",
"meta:xdmType": "object"
}
},
"meta:xdmType": "object"
}
},
"meta:xdmType": "object"
}
},
"allOf": [
{
"$ref": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [],
"meta:xdmType": "object",
"meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
"meta:sandboxType": "production"
}
]
匯入資源 import
從CSV檔案產生匯出裝載後,您可以將該裝載傳送至/rpc/import
端點以產生結構描述。
請參閱匯入端點指南,以取得有關如何從匯出裝載產生結構描述的詳細資訊。