{ "info": { "_postman_id": "22fa8ce1-a2b7-5878-9e4a-0ae65e8868dd", "name": "Catalog Service API", "description": "Catalog is the system of record for data location and lineage within Adobe Experience Platform. Catalog Service does not contain the actual files or directories that contain the data. Instead, it holds the metadata and description of those files and directories.\n\nCatalog acts as a metadata store or \"catalog\" where you can find information about your data within Experience Platform.\n\nYou can use Catalog to answer the following questions: Where is my data located? At what stage of processing is this data? What systems or processes have acted on my data? What errors occurred during processing? If successful, how much data was processed?\n\n- Related documentation:\n - [Catalog Service documentation](http://www.adobe.com/go/data-catalog-service-overview-en)\n\n- Visualize API calls with Postman (a free, third-party software):\n - [Catalog Service API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Catalog%20Service%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.postman.com/docs/getting-started/importing-and-exporting-data/)\n\n- API paths:\n - PLATFORM Gateway URL: https://platform.adobe.io/\n - Base path for this API: /data/foundation/catalog\n - Example of a complete path: https://platform.adobe.io/data/foundation/catalog/batches\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 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": "Batches", "item": [ { "name": "Retrieve a list of batches", "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": "4204c742-5d04-5c1a-bfae-ebbba8ea9c9c", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches?status={{status}}&recordCount={{recordCount}}&failedRecordCount={{failedRecordCount}}&size={{size}}&started={{started}}&completed={{completed}}&startAfter={{startAfter}}&startBefore={{startBefore}}&endAfter={{endAfter}}&endBefore={{endBefore}}&batch={{batch}}&externalId={{externalId}}&connection={{connection}}&connector={{connector}}&dataSet={{dataSet}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches" ], "query": [ { "key": "status", "value": "{{status}}" }, { "key": "recordCount", "value": "{{recordCount}}" }, { "key": "failedRecordCount", "value": "{{failedRecordCount}}" }, { "key": "size", "value": "{{size}}" }, { "key": "started", "value": "{{started}}" }, { "key": "completed", "value": "{{completed}}" }, { "key": "startAfter", "value": "{{startAfter}}" }, { "key": "startBefore", "value": "{{startBefore}}" }, { "key": "endAfter", "value": "{{endAfter}}" }, { "key": "endBefore", "value": "{{endBefore}}" }, { "key": "batch", "value": "{{batch}}" }, { "key": "externalId", "value": "{{externalId}}" }, { "key": "connection", "value": "{{connection}}" }, { "key": "connector", "value": "{{connector}}" }, { "key": "dataSet", "value": "{{dataSet}}" } ] } }, "response": [] }, { "name": "Create a new batch", "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": "e292cea7-2daa-593e-b89d-7cfdcf52bf1a", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{batch}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches" ] } }, "response": [] }, { "name": "Look up the unique values stored in a field", "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": "9997c614-97d1-5ab9-b66e-a2c445a8508f", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches/uniques/:FIELD?status={{status}}&recordCount={{recordCount}}&failedRecordCount={{failedRecordCount}}&size={{size}}&started={{started}}&completed={{completed}}&startAfter={{startAfter}}&startBefore={{startBefore}}&endAfter={{endAfter}}&endBefore={{endBefore}}&batch={{batch}}&externalId={{externalId}}&connection={{connection}}&connector={{connector}}&dataSet={{dataSet}}&transform={{transform}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches", "uniques", ":FIELD" ], "query": [ { "key": "status", "value": "{{status}}" }, { "key": "recordCount", "value": "{{recordCount}}" }, { "key": "failedRecordCount", "value": "{{failedRecordCount}}" }, { "key": "size", "value": "{{size}}" }, { "key": "started", "value": "{{started}}" }, { "key": "completed", "value": "{{completed}}" }, { "key": "startAfter", "value": "{{startAfter}}" }, { "key": "startBefore", "value": "{{startBefore}}" }, { "key": "endAfter", "value": "{{endAfter}}" }, { "key": "endBefore", "value": "{{endBefore}}" }, { "key": "batch", "value": "{{batch}}" }, { "key": "externalId", "value": "{{externalId}}" }, { "key": "connection", "value": "{{connection}}" }, { "key": "connector", "value": "{{connector}}" }, { "key": "dataSet", "value": "{{dataSet}}" }, { "key": "transform", "value": "{{transform}}" } ], "variable": [ { "value": "{{FIELD}}", "id": "FIELD" } ] }, "description": "This endpoint retrieves the unique values stored in a field, as specified by the ID." }, "response": [] }, { "name": "Look up a batch", "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": "699d7514-8b5b-5451-bb39-9482bed991b1", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches/:BATCH_ID?aggregate={{aggregate}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches", ":BATCH_ID" ], "query": [ { "key": "aggregate", "value": "{{aggregate}}" } ], "variable": [ { "value": "{{BATCH_ID}}", "id": "BATCH_ID" } ] } }, "response": [] }, { "name": "Update a batch", "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": "4f6a5fd2-be12-57b6-94ee-5b56ef3f46ec", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{batch}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches/:BATCH_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches", ":BATCH_ID" ], "variable": [ { "value": "{{BATCH_ID}}", "id": "BATCH_ID" } ] } }, "response": [] }, { "name": "Create a new batch", "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": "928b65e2-e1af-5c2b-81db-783b46f5743b", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{batch}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches/:BATCH_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches", ":BATCH_ID" ], "variable": [ { "value": "{{BATCH_ID}}", "id": "BATCH_ID" } ] } }, "response": [] }, { "name": "Update one or more batch 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": "ac3ad716-6384-5051-9825-6f32e1ca6131", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{batch}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches/:BATCH_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches", ":BATCH_ID" ], "variable": [ { "value": "{{BATCH_ID}}", "id": "BATCH_ID" } ] } }, "response": [] }, { "name": "Delete a batch", "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": "96746db4-aebe-5fbb-b997-faaeb8a33e9b", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/batches/:BATCH_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "batches", ":BATCH_ID" ], "variable": [ { "value": "{{BATCH_ID}}", "id": "BATCH_ID" } ] }, "description": "**Note:** This endpoint has been deprecated. Please use the [delete a batch endpoint](https://experienceleague.adobe.com/docs/experience-platform/ingestion/batch/api-overview.html?lang=en#delete-a-batch) within the batch ingestion API." }, "response": [] } ], "_postman_id": "0fbdfdca-0140-5ceb-bd71-5dc6783a9437", "description": "Batches allow users to understand which operations and applications have been performed on objects tracked by the system." }, { "name": "Datasets", "item": [ { "name": "Retrieve a list of datasets", "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": "709e7e6a-0eab-5f18-ab33-bb6fd44c9f73", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets?connectorId={{connectorId}}&connectionId={{connectionId}}&name={{name}}&description={{description}}&enableErrorDiagnostics={{enableErrorDiagnostics}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets" ], "query": [ { "key": "connectorId", "value": "{{connectorId}}" }, { "key": "connectionId", "value": "{{connectionId}}" }, { "key": "name", "value": "{{name}}" }, { "key": "description", "value": "{{description}}" }, { "key": "enableErrorDiagnostics", "value": "{{enableErrorDiagnostics}}" } ] } }, "response": [] }, { "name": "Create a new dataset", "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": "672e74ea-be1e-5425-864c-d344a9b4be05", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{dataSet}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets" ] } }, "response": [] }, { "name": "Look up a dataset", "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": "48abd3e8-7b17-5465-b884-ef55241e4171", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets/:DATASET_ID?properties={{properties}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets", ":DATASET_ID" ], "query": [ { "key": "properties", "value": "{{properties}}" } ], "variable": [ { "value": "{{DATASET_ID}}", "id": "DATASET_ID" } ] } }, "response": [] }, { "name": "Update a dataset", "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": "35a6226c-2d09-576e-a457-2608ed640f0b", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{dataSet}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets/:DATASET_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets", ":DATASET_ID" ], "variable": [ { "value": "{{DATASET_ID}}", "id": "DATASET_ID" } ] } }, "response": [] }, { "name": "Update a dataset'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": "1da78009-59c6-50c6-a4c0-463ad7a38b12", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{dataSet}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets/:DATASET_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets", ":DATASET_ID" ], "variable": [ { "value": "{{DATASET_ID}}", "id": "DATASET_ID" } ] } }, "response": [] }, { "name": "Delete a dataset", "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": "218d80e8-9754-5acb-b9f2-769bdcec217e", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets/:DATASET_ID", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets", ":DATASET_ID" ], "variable": [ { "value": "{{DATASET_ID}}", "id": "DATASET_ID" } ] } }, "response": [] }, { "name": "Retrieve a dataset's credentials", "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": "69b48767-ae2a-5817-9deb-48b646226773", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "x-user-token", "value": "{{x-user-token}}", "description": "For calls which are proxied by catalog, the access token for the user on whose behalf this call is made.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/dataSets/:id/credentials?batchId={{batchId}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "dataSets", ":id", "credentials" ], "query": [ { "key": "batchId", "value": "{{batchId}}" } ], "variable": [ { "value": "{{id}}", "id": "id" } ] } }, "response": [] } ], "_postman_id": "17400542-ee74-547c-aab8-18d6bc9dd2b8", "description": "Datasets are the building blocks for data transformation and tracking in Catalog Service." }, { "name": "Batched requests", "item": [ { "name": "Retrieve a list of batched requests", "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": "e77c9d20-02b4-5edf-bc7a-c1f3514b2a8d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "Identifies the Adobe Experience Platform sandbox to use. Default sandbox is 'prod'", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/?orderBy={{orderBy}}&limit={{limit}}&start={{start}}&property={{property}}&properties={{properties}}", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "" ], "query": [ { "key": "orderBy", "value": "{{orderBy}}" }, { "key": "limit", "value": "{{limit}}" }, { "key": "start", "value": "{{start}}" }, { "key": "property", "value": "{{property}}" }, { "key": "properties", "value": "{{properties}}" } ] } }, "response": [] }, { "name": "Create a new batched request", "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": "534b074e-37b2-515f-8c3f-0eae25c269a2", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "x-sandbox-name", "value": "{{SANDBOX_NAME}}", "description": "Identifies the Adobe Experience Platform sandbox to use. Default sandbox is 'prod'", "type": "string", "enabled": true } ], "body": { "mode": "raw", "raw": "{{resources}}" }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "" ] } }, "response": [] } ], "_postman_id": "95a4f0e8-92b9-59f9-ac20-053718e4f5dd", "description": "Batched requests allow users to supply an array of objects in the request payload, representing what would normally be individual requests." }, { "name": "Tags", "item": [ { "name": "Retrieve a list of aggregated values", "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": "02482406-3c0e-5ed0-9ccd-7dae8c77c080", "request": { "method": "GET", "header": [ { "key": "Accept", "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 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 documentation](https://adobe.com/go/sandbox-overview-en) for more information.", "type": "string", "enabled": true }, { "key": "accept-encoding", "value": "{{accept-encoding}}", "description": "Used to signal the intent to consume compressed response bodies. Supported encodings: gzip.", "type": "string", "enabled": true } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "https://platform.adobe.io/data/foundation/catalog/tags/:tagNamespace", "protocol": "https", "host": [ "platform", "adobe", "io" ], "path": [ "data", "foundation", "catalog", "tags", ":tagNamespace" ], "variable": [ { "value": "{{tagNamespace}}", "id": "tagNamespace" } ] }, "description": "This endpoint retrieves a list of aggregated values for all tags within an IMS Organization, specified by namespace." }, "response": [] } ], "_postman_id": "f0d7af3c-491b-5e1c-bff9-faed846a2056", "description": "Tags are used to attach information to an object and then be used later to retrieve the object." } ] }