{ "info": { "_postman_id": "bb777741-9a36-5b13-a644-ce2fbe94421c", "name": "Schema Registry API", "description": "The Schema Registry API is used to access the Schema Library within Adobe Experience Platform. The registry provides a user interface and RESTful API from which all available library resources are accessible.\n\n* Related documentation:\n * [XDM documentation](http://www.adobe.com/go/xdm-home-en)\n\n* Visualize API calls with Postman (a free, third-party software):\n * [Schema Registry API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Schema%20Registry%20API.postman_collection.json)\n * [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n * [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)\n\n* API paths:\n * PLATFORM Gateway URL: https://platform.adobe.io\n * Base path for this API: /data/foundation/schemaregistry\n * Example of a complete path for making a call to \"/stats\": https://platform.adobe.io/data/foundation/schemaregistry/stats\n\n* Required headers:\n * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n * All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, \"prod\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.\n * All GET requests to the Schema Registry require an `Accept` header to determine what data is returned by the system. See the [section on `Accept` headers](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/getting-started.html?lang=en#accept) in the Schema Registry developer guide for more information.\n * All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Stats", "item": [ { "name": "Retrieve your tenant ID and other usage information related to the Schema Registry.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "f6e4b669-2c98-5b97-b87d-a198cc34020c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/stats", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "stats" ] } }, "response": [] } ], "_postman_id": "c87161d8-7e10-5e6b-a0ab-3f9bd2e834b9", "description": "Returns {TENANT_ID} along with information regarding IMS Org usage of the Schema Registry such as resource counts, recently created resources, and class usage." }, { "name": "Field groups", "item": [ { "name": "List field groups", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "e635cb92-a4c3-58ce-85db-1eca8369021e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/fieldgroups?property={{property}}&orderby={{orderby}}&start={{start}}&limit={{limit}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "fieldgroups" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "start", "value": "{{start}}" }, { "key": "limit", "value": "{{limit}}" } ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" } ] }, "description": "Retrieve a list of field groups within the specified container." }, "response": [] }, { "name": "Retrieve a field group", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "a5fcaddc-86b7-5621-8f9b-602172ceadba", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/fieldgroups/:FIELD_GROUP_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "fieldgroups", ":FIELD_GROUP_ID" ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" }, { "value": "{{FIELD_GROUP_ID}}", "id": "FIELD_GROUP_ID" } ] } }, "response": [] }, { "name": "Create a custom field group", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "ca04fbec-498a-5785-a401-f2cb96dfaf40", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "fieldgroups" ] } }, "response": [] }, { "name": "Update a custom field group", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "5134a8ff-30cb-5409-81b7-0d859e2fd8a3", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups/:FIELD_GROUP_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "fieldgroups", ":FIELD_GROUP_ID" ], "variable": [ { "value": "{{FIELD_GROUP_ID}}", "id": "FIELD_GROUP_ID" } ] }, "description": "A PUT request is essentially re-writing the field group, therefore the request body must include all fields required to create (POST) a field group. This is especially useful when updating a lot of information in the field group at once." }, "response": [] }, { "name": "Update a custom field group", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "859413fc-6938-5fc6-ad3e-a1ced5de0767", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups/:FIELD_GROUP_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "fieldgroups", ":FIELD_GROUP_ID" ], "variable": [ { "value": "{{FIELD_GROUP_ID}}", "id": "FIELD_GROUP_ID" } ] }, "description": "You can use this endpoint to update one or more attributes of your custom field group.\nThe Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow you to modify or update resources you have defined.\n\nFor more information on JSON Patch, including all available operations, read [the official JSON Patch documentation](http://jsonpatch.com)." }, "response": [] }, { "name": "Delete a custom field group", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "70bdb200-68c4-50fe-9f24-fef41196fd04", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups/:FIELD_GROUP_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "fieldgroups", ":FIELD_GROUP_ID" ], "variable": [ { "value": "{{FIELD_GROUP_ID}}", "id": "FIELD_GROUP_ID" } ] }, "description": "Remove an existing field group through a DELETE request to the `$id` of the field group being removed.\n\nA successful deletion returns an empty response body and HTTP status 204 (No Content)." }, "response": [] } ], "_postman_id": "eb59efb7-1cfb-5ec5-b706-a9168572294a", "description": "A field group is a reusable component that defines one or more fields to implement certain functions within a schema based on a compatible class." }, { "name": "Schemas", "item": [ { "name": "List schemas", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "3d444603-4ccf-50eb-aea6-f5f6ac515b58", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/schemas?property={{property}}&orderby={{orderby}}&start={{start}}&limit={{limit}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "schemas" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "start", "value": "{{start}}" }, { "key": "limit", "value": "{{limit}}" } ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" } ] }, "description": "You are able to view a list of all schemas within a container by performing a single GET request. To help filter results, the Schema Registry supports the use of query parameters when listing resources.\n\nThe response format depends on the `Accept` header sent in the request. The following `Accept` headers are available for this request:" }, "response": [] }, { "name": "Retrieve a schema", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "f3d467cd-47f7-5947-ab35-020266b627dd", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/schemas/:SCHEMA_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "schemas", ":SCHEMA_ID" ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" }, { "value": "{{SCHEMA_ID}}", "id": "SCHEMA_ID" } ] }, "description": "The response format depends on the `Accept` header sent in the request. The following `Accept` headers are available for this request:\n\nA lookup request requires the resource's major version be included in the `Accept` header. When supplying the major version, the registry returns the latest minor version automatically." }, "response": [] }, { "name": "Create a custom schema", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "4f7c3d10-2132-588d-94ca-4b29055d65df", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "schemas" ] } }, "response": [] }, { "name": "Update a custom schema", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "9c1262f5-ef8b-56f2-9fe7-e8ca57a7a265", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/:SCHEMA_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "schemas", ":SCHEMA_ID" ], "variable": [ { "value": "{{SCHEMA_ID}}", "id": "SCHEMA_ID" } ] }, "description": "A PUT request essentially re-writes the schema, therefore the request body must include all fields required to create (POST) a schema. This is especially useful when updating a lot of information in the schema at once." }, "response": [] }, { "name": "Update custom schema", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "688a7b65-8e13-5cb4-a3b4-5afa71f86a76", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/:SCHEMA_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "schemas", ":SCHEMA_ID" ], "variable": [ { "value": "{{SCHEMA_ID}}", "id": "SCHEMA_ID" } ] }, "description": "You can use this endpoint to update one or more attributes of the custom schema.\nThe Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow users to modify or update schemas they have defined.\n\nFor more information on JSON Patch, including all available operations, read [the official JSON Patch documentation](http://jsonpatch.com)." }, "response": [] }, { "name": "Delete a custom schema", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "b9c58ef1-abcf-5442-b9a3-fd9d2d4bdcfa", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/:SCHEMA_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "schemas", ":SCHEMA_ID" ], "variable": [ { "value": "{{SCHEMA_ID}}", "id": "SCHEMA_ID" } ] }, "description": "Remove an existing schema by performing a DELETE request to the `$id` of the schema being removed.\n\nA successful deletion returns an empty response body and HTTP status 204 (No Content)." }, "response": [] } ], "_postman_id": "fcf65445-ad3c-5e7e-a396-4c377bf65377", "description": "Schemas provide an abstract definition of a real-world object along with constraints and expectations that can be applied and used to validate data." }, { "name": "Behaviors", "item": [ { "name": "List behaviors", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "1423f5a6-32e9-5a16-9157-22c29871dd12", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "global", "behaviors" ] } }, "response": [] }, { "name": "Retrieve a behavior", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "99615abc-c84c-59af-a396-90eff085760b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors/:BEHAVIOR_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "global", "behaviors", ":BEHAVIOR_ID" ], "variable": [ { "value": "{{BEHAVIOR_ID}}", "id": "BEHAVIOR_ID" } ] } }, "response": [] } ], "_postman_id": "aa21a945-0e6a-5006-a3fa-25589e7ae90d", "description": "Behaviors define the nature of data that a schema describes. Each XDM class must reference a specific behavior, which all schemas that employ that class will inherit. Schemas that inherit the \"record\" behavior provide information about the attributes of a subject, while those that inherit the \"time-series\" behavior provide a snapshot of the system at the time an action was taken by a record subject." }, { "name": "Mixins (deprecated)", "item": [ { "name": "List all mixins", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "970cd30f-7dcd-5af8-a5ac-ee936d4dcec8", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/mixins?property={{property}}&orderby={{orderby}}&start={{start}}&limit={{limit}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "mixins" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "start", "value": "{{start}}" }, { "key": "limit", "value": "{{limit}}" } ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" } ] } }, "response": [] }, { "name": "Retrieve a mixin", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "99d24098-0970-54fb-b25e-3868cf74304e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/mixins/:MIXIN_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "mixins", ":MIXIN_ID" ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" }, { "value": "{{MIXIN_ID}}", "id": "MIXIN_ID" } ] } }, "response": [] }, { "name": "Create a new custom mixin", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "43809f4b-058f-5fdc-b8e2-156dfc533e80", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/mixins", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "mixins" ] } }, "response": [] }, { "name": "Update a custom mixin", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "826e177f-07f4-558f-8700-468aebb2f7a5", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/mixins/:MIXIN_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "mixins", ":MIXIN_ID" ], "variable": [ { "value": "{{MIXIN_ID}}", "id": "MIXIN_ID" } ] }, "description": "A PUT request is essentially re-writing the mixin, therefore the request body must include all fields required to create (POST) a mixin. This is especially useful when updating a lot of information in the mixin at once." }, "response": [] }, { "name": "Update custom mixin", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "7d064369-e696-5ae8-8ad6-b47f87438904", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/mixins/:MIXIN_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "mixins", ":MIXIN_ID" ], "variable": [ { "value": "{{MIXIN_ID}}", "id": "MIXIN_ID" } ] }, "description": "You can use this endpoint to update one or more attributes of a custom mixin.\nThe Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow users to modify or update mixins they have defined.\n\nFor more information on JSON Patch, including all available operations, read [the official JSON Patch documentation](http://jsonpatch.com)." }, "response": [] }, { "name": "Delete a custom mixin", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "cf20bc91-ac52-54c2-ba1d-7e3b491ff51c", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/mixins/:MIXIN_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "mixins", ":MIXIN_ID" ], "variable": [ { "value": "{{MIXIN_ID}}", "id": "MIXIN_ID" } ] }, "description": "Remove an existing mixin through a DELETE request to the `$id` of the mixin being removed.\n\nA successful deletion returns an empty response body and HTTP status 204 (No Content)." }, "response": [] } ], "_postman_id": "bde8ae30-15c3-5794-9ea0-0324b120d848", "description": "\"Mixin\" is the former term for a field group. The /mixins endpoints are deprecated and only maintained as legacy endpoints. For new implementations, please use the /fieldgroups endpoint instead." }, { "name": "Classes", "item": [ { "name": "List classes", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "0a0cf82a-892c-5dca-9be3-f355358b47b1", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/classes?property={{property}}&orderby={{orderby}}&start={{start}}&limit={{limit}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "classes" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "start", "value": "{{start}}" }, { "key": "limit", "value": "{{limit}}" } ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" } ] } }, "response": [] }, { "name": "Retrieve a class", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "3f2e9cb9-0b53-5d20-b519-7c72211799fc", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/classes/:CLASS_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "classes", ":CLASS_ID" ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" }, { "value": "{{CLASS_ID}}", "id": "CLASS_ID" } ] } }, "response": [] }, { "name": "Create a custom class", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "e7cc6eef-68b1-5823-a6e5-6a942a41fcba", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "classes" ] } }, "response": [] }, { "name": "Update a custom class", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "68fbfed0-d8fa-593f-98ba-558baeb40e03", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/:CLASS_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "classes", ":CLASS_ID" ], "variable": [ { "value": "{{CLASS_ID}}", "id": "CLASS_ID" } ] }, "description": "A PUT request is essentially re-writing the class, therefore the request body must include all fields required to create (POST) a class. This is especially useful when updating a lot of information in the class at once." }, "response": [] }, { "name": "Update a custom class' attributes", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "619c3622-78ce-546d-bc46-1271533190e4", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/:CLASS_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "classes", ":CLASS_ID" ], "variable": [ { "value": "{{CLASS_ID}}", "id": "CLASS_ID" } ] }, "description": "You can use this endpoint to update one or more attributes for a custom class.\nThe Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow users to modify or update classes they have defined.\n\nFor more information on JSON Patch, including all available operations, read [the official JSON Patch documentation](http://jsonpatch.com)." }, "response": [] }, { "name": "Delete a custom class", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "2db74f81-978d-5a82-8bb0-5c862a7da39c", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/:CLASS_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "classes", ":CLASS_ID" ], "variable": [ { "value": "{{CLASS_ID}}", "id": "CLASS_ID" } ] }, "description": "Remove a class by performing a DELETE request to the `$id` of the class being removed.\n\nA successful deletion returns an empty response body and HTTP status 204 (No Content)." }, "response": [] } ], "_postman_id": "90c13482-6550-5bac-8ee6-49c35a219923", "description": "Classes define behavioral aspects of the data within the schema and describe the smallest number of common properties contained in all schemas that implement the same class." }, { "name": "Data types", "item": [ { "name": "List data types", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "b56068aa-17c2-52e9-ac01-93a01b749ade", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/datatypes?property={{property}}&orderby={{orderby}}&start={{start}}&limit={{limit}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "datatypes" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "start", "value": "{{start}}" }, { "key": "limit", "value": "{{limit}}" } ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" } ] } }, "response": [] }, { "name": "Retrieve a data type", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "caeae922-940d-5710-b03c-ae642137202b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/datatypes/:DATA_TYPE_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "datatypes", ":DATA_TYPE_ID" ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" }, { "value": "{{DATA_TYPE_ID}}", "id": "DATA_TYPE_ID" } ] } }, "response": [] }, { "name": "Create a custom data type", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "e3a97970-27ec-5106-a65e-b86259d77d6b", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "Accept", "value": "{{Accept}}", "description": "The desired response format (eg. application/vnd.adobe.xed-full+json; version=1). \"Version\" is required.", "type": "string", "enabled": true }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/datatypes", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "datatypes" ] } }, "response": [] }, { "name": "Update a custom data type", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "ee2c1e48-9dbf-5cab-8ec4-1e463b6072c3", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/datatypes/:DATA_TYPE_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "datatypes", ":DATA_TYPE_ID" ], "variable": [ { "value": "{{DATA_TYPE_ID}}", "id": "DATA_TYPE_ID" } ] }, "description": "A PUT request is essentially re-writing the data type, therefore the request body must include all fields required to create (POST) a data type. This is especially useful when updating a lot of information in the data type at once." }, "response": [] }, { "name": "Update a custom data type's attributes", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "3859a9cb-eb2b-591e-9612-dd5c00714fed", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{payload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/datatypes/:DATA_TYPE_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "datatypes", ":DATA_TYPE_ID" ], "variable": [ { "value": "{{DATA_TYPE_ID}}", "id": "DATA_TYPE_ID" } ] }, "description": "You can use this endpoint to update one or more attributes of a custom data type.\nThe Schema Registry supports all standard JSON Patch operations, including add, remove, and replace, to allow users to modify or update data types they have defined.\n\nFor more information on JSON Patch, including all available operations, read [the official JSON Patch documentation](http://jsonpatch.com)." }, "response": [] }, { "name": "Delete a custom class", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "a648242d-3064-56d3-8478-2e5bcb6eb1ae", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/datatypes/:DATA_TYPE_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "datatypes", ":DATA_TYPE_ID" ], "variable": [ { "value": "{{DATA_TYPE_ID}}", "id": "DATA_TYPE_ID" } ] }, "description": "Removing a data type is done through a DELETE request to the `$id` of the data type being removed.\n\nA successful deletion returns an empty response body and HTTP status 204 (No Content)." }, "response": [] } ], "_postman_id": "f653b79f-a5df-5a4d-bccb-0ac42ffee1bf", "description": "Data types are used as reference field types in classes or schemas to define complex types. Data types may define multiple sub-fields providing a consistent multi-field structure." }, { "name": "Descriptors", "item": [ { "name": "List descriptors", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "ed72b507-b0fc-53d4-a6b5-6d138d3e809e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/descriptors?property={{property}}&orderby={{orderby}}&limit={{limit}}&start={{start}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "descriptors" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "limit", "value": "{{limit}}" }, { "key": "start", "value": "{{start}}" } ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" } ] }, "description": "Schemas define a static view of data entities, but do not provide specific details on how data based on these schemas (datasets) may relate to one another. Adobe Experience Platform allows you to describe these relationships and other interpretive metadata about a schema through the use of descriptors.\n\nDescriptors are tenant-level metadata for schemas, meaning they are unique to your IMS Organization and all descriptor operations take place in the `tenant` container.\n\nEach schema can have one or more schema descriptor entities applied to it. Each schema descriptor entity includes a descriptor '@type' and the 'sourceSchema' to which it applies. Once applied, these descriptors will apply to all datasets created using the schema.\n\nIn order to help filter returned data, the Schema Registry supports the use of query parameters when listing descriptors.\n\n`Accept` headers for descriptors include:\n\n
`Accept`Description
`application/vnd.adobe.xdm-id+json`Returns a list of descriptor IDs, grouped by their `@type`.
`application/vnd.adobe.xdm-link+json`Returns a list of descriptor API paths, grouped by their `@type`.
`application/vnd.adobe.xdm+json`Returns a list of descriptor objects, grouped by their `@type`.
`application/vnd.adobe.xdm-v2{-id/-link}+json`Including the `-v2` option in any of the above `Accept` headers permits paging functionality, returning a results array with a `_page` attribute that can be used to request the next page if needed.
" }, "response": [] }, { "name": "Retrieve a descriptor", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "b5e6c117-6758-5e96-9fae-5ec18a8c770b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/:CONTAINER_ID/descriptors/:DESCRIPTOR_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", ":CONTAINER_ID", "descriptors", ":DESCRIPTOR_ID" ], "variable": [ { "value": "{{CONTAINER_ID}}", "id": "CONTAINER_ID" }, { "value": "{{DESCRIPTOR_ID}}", "id": "DESCRIPTOR_ID" } ] }, "description": "View the details of a specific descriptor by performing a lookup (GET) request using the `@id` of the descriptor. Descriptors are not versioned, therefore no `Accept` header is required in the lookup request." }, "response": [] }, { "name": "Create a descriptor", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "ab808243-0919-5c3e-adb8-e0f6498a8b26", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{descriptorPayload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "descriptors" ] }, "description": "Required fields for defining a descriptor vary based on the `@type` of the descriptor." }, "response": [] }, { "name": "Update a descriptor", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "e4e62035-4ed5-58bd-8349-87f1a0a4e2b6", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{descriptorPayload}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors/:DESCRIPTOR_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "descriptors", ":DESCRIPTOR_ID" ], "variable": [ { "value": "{{DESCRIPTOR_ID}}", "id": "DESCRIPTOR_ID" } ] }, "description": "\nUpdate a descriptor by issuing a PUT request to the `@id` of the descriptor being updated.\n\nThis action is **re-writing** the existing descriptor, therefore the payload must include all descriptor fields that were required when the descriptor was defined." }, "response": [] }, { "name": "Delete a descriptor", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "866841ae-fbb8-55fe-bbec-35e56799f6ab", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors/:DESCRIPTOR_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "descriptors", ":DESCRIPTOR_ID" ], "variable": [ { "value": "{{DESCRIPTOR_ID}}", "id": "DESCRIPTOR_ID" } ] }, "description": "Remove a descriptor from the registry by issuing a DELETE request to the `@id` of the descriptor being removed." }, "response": [] } ], "_postman_id": "e093ab1f-167c-52ed-94d5-05426e519d73", "description": "Schema descriptors are tenant-level metadata used to provide interpretive details on how data based on certain schemas may relate or interact with one another." }, { "name": "Unions", "item": [ { "name": "List union schemas", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "fb3bae55-76e7-5aba-81b3-f1bd55b1eee3", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions?property={{property}}&orderby={{orderby}}&start={{start}}&limit={{limit}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "unions" ], "query": [ { "key": "property", "value": "{{property}}" }, { "key": "orderby", "value": "{{orderby}}" }, { "key": "start", "value": "{{start}}" }, { "key": "limit", "value": "{{limit}}" } ] } }, "response": [] }, { "name": "Retrieve a union schema", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "c44077c4-7e90-5f1d-929e-8765bf55d837", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions/:UNION_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "tenant", "unions", ":UNION_ID" ], "variable": [ { "value": "{{UNION_ID}}", "id": "UNION_ID" } ] } }, "response": [] } ], "_postman_id": "48e01f4a-b888-5153-9e4b-dbb81c750f14", "description": "Union schemas aggregate the fields of all schemas that implement the same class (such as ExperienceEvent or Profile) into a single schema. They are used by Real-time Customer Profile to merge data together to form a \"single source of truth\" for an individual." }, { "name": "Export/Import", "item": [ { "name": "Retrieve an export payload", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "ddbd90a2-1f43-506e-8b73-44c296dbe933", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/rpc/export/:RESOURCE_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "rpc", "export", ":RESOURCE_ID" ], "variable": [ { "value": "{{RESOURCE_ID}}", "id": "RESOURCE_ID" } ] }, "description": "You can use this endpoint to retrieve an export payload for a specific resource in order to transfer it into a different sandbox or IMS Organization." }, "response": [] }, { "name": "Import a resource", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "506ef071-70f3-54eb-b392-4b9510b3e48b", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The unique ID ({IMS_ORG}) of the IMS Organization that you want to import the resource into.", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox that you want to import the resource into. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{body}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/rpc/import", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "rpc", "import" ] }, "description": "Use an export payload to import a resource into a different sandbox or IMS Organization." }, "response": [] } ], "_postman_id": "b581a3c8-be59-5554-8b7e-5343e5271510", "description": "The Schema Registry API allows you to transfer and share XDM resources between sandboxes and IMS Organizations. For any schema, field group, or data type, you can generate an export payload containing the structure of the resource and any dependent resources. This payload can then be used to import the resource into a destination sandbox and IMS Org." }, { "name": "Sample data", "item": [ { "name": "Retrieve sample data", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "d2b89f2c-371b-501d-822a-3f243919434d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.adobe.xed-id+json", "description": "The desired response format (application/vnd.adobe.xed-full+json).", "type": "string", "enabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/rpc/sampledata/:SCHEMA_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "rpc", "sampledata", ":SCHEMA_ID" ], "variable": [ { "value": "{{SCHEMA_ID}}", "id": "SCHEMA_ID" } ] }, "description": "Retrieve sample data for a schema." }, "response": [] } ], "_postman_id": "ada2f8a4-6b16-5b68-8e7b-c4d3a2e07306", "description": "You can generate sample data for any specified schema within the Schema Library. The response object returned can then be used as the source of dataset ingestion." }, { "name": "Audit log", "item": [ { "name": "Retrieve a resource's audit log", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "/** Begin Adobe-provided Pre-Request Scripts **/", "// Do not send HTTP Headers with empty variables, as Postman will send the literal variable name", "pm.request.forEachHeader(header => {", " if (header.value.startsWith(\"{{\") && header.value.endsWith(\"}}\")) {", " if (!pm.variables.get(header.value.substring(2, header.value.length - 2))) { pm.request.headers.remove(header.key); }", " }", "});", "", "// Do not send HTTP URL Query Parameters with empty variables, as Postman will send the literal variable name", "pm.request.url.query.remove(q => { ", " if (q.value.startsWith(\"{{\") && q.value.endsWith(\"}}\")) {", " return !pm.variables.get(q.value.substring(2, q.value.length - 2));", " } ", "});", "/** End Adobe-provided Pre-Request Scripts **/" ] } } ], "_postman_id": "e5069b00-8146-5b79-b413-054817b4b7c1", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "description": "The access token which can be copied from your Experience Platform integration, prefixed with \"Bearer \". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-api-key", "value": "{{API_KEY}}", "description": "The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-gw-ims-org-id", "value": "{{IMS_ORG}}", "description": "The IMS Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).", "type": "string", "enabled": true }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "The name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/schemaregistry/rpc/auditlog/:RESOURCE_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "schemaregistry", "rpc", "auditlog", ":RESOURCE_ID" ], "variable": [ { "value": "{{RESOURCE_ID}}", "id": "RESOURCE_ID" } ] }, "description": "This endpoint retrieves a resource's audit log, which shows a list of all the changes made to the resource." }, "response": [] } ], "_postman_id": "64917cff-b0fb-5b6c-a02e-80466ecfb3f6", "description": "The Schema Registry maintains a log of all the changes that have occurred to a resource (class, field group, data type, or schema) between different updates." } ] }