Esporta endpoint
Tutte le risorse all'interno di Schema Library sono contenute in una sandbox specifica in Adobe Experience Platform. In alcuni casi, potrebbe essere utile condividere risorse Experience Data Model (XDM) tra sandbox e organizzazioni. Il /rpc/export endpoint nella Schema Registry API consente di generare un payload di esportazione per qualsiasi schema, gruppo di campi di schema o tipo di dati in Schema Library, quindi utilizzare il payload per importare tale risorsa (e tutte le risorse dipendenti) in una sandbox e in un’organizzazione di destinazione tramite /rpc/import endpoint.
Introduzione
Il /rpc/export l'endpoint fa parte del Schema Registry API. Prima di continuare, controlla guida introduttiva per i collegamenti alla documentazione correlata, una guida per la lettura delle chiamate API di esempio di questo documento e informazioni importanti sulle intestazioni richieste necessarie per effettuare correttamente le chiamate a qualsiasi API di Experience Platform.
Il /rpc/export l'endpoint fa parte delle chiamate di procedura remota (RPC) supportate dalla Schema Registry. A differenza di altri endpoint nel Schema Registry API, gli endpoint RPC non richiedono intestazioni aggiuntive come Accept o Content-Type, e non utilizzare un CONTAINER_ID. Devono invece utilizzare il /rpc dello spazio dei nomi, come dimostrato nelle chiamate API di seguito.
Generare un payload di esportazione per una risorsa export
Per qualsiasi schema, gruppo di campi o tipo di dati esistente in Schema Library, puoi generare un payload di esportazione effettuando una richiesta GET al /export endpoint, fornendo l’ID della risorsa nel percorso.
Formato API
GET /rpc/export/{RESOURCE_ID}
{RESOURCE_ID}meta:altId o con codifica URL $id della risorsa XDM da esportare.Richiesta
La richiesta seguente recupera un payload di esportazione per un Restaurant gruppo di campi.
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'
Risposta
In caso di esito positivo, la risposta restituisce un array di oggetti, che rappresentano la risorsa XDM di destinazione e tutte le relative risorse dipendenti. In questo esempio, il primo oggetto nell’array è un tenant-created Property tipo di dati che Restaurant il gruppo di campi impiega, mentre il secondo oggetto è Restaurant stesso gruppo di campi. Questo payload può quindi essere utilizzato per importa la risorsa in un’altra sandbox o organizzazione.
Tutte le istanze dell’ID tenant della risorsa vengono sostituite con <XDM_TENANTID_PLACEHOLDER>. Questo consente al registro dello schema di applicare automaticamente l’ID tenant corretto alle risorse in base alla posizione in cui vengono inviate nella chiamata di importazione successiva.
[
{
"$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"
}
]
Importa la risorsa import
Dopo aver generato il payload di esportazione dal file CSV, puoi inviarlo al /rpc/import per generare lo schema.
Consulta la importa guida dell’endpoint per informazioni dettagliate su come generare schemi dai payload di esportazione.