Postman Collection for Ingestion API
- Last UpdatedMay 16, 2025
- 2 minute read
Note: The following imported collection is presented as a sample and you may need to adapt it to the API client of your choice.
{
"info": {
"_postman_id": "599d1357-8e31-499a-9f1d-07d025f543fb",
"name": "Ingestion API Calls",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Init API",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{token}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"assetId\": \"{AIM-A Connect Folder Name}\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{Ingestion-API-Base-URL}/api/load/init",
"protocol": "https",
"host": [
"{Ingestion-API-Base-URL}"
],
"path": [
"api",
"load",
"init"
]
}
},
"response": []
},
{
"name": "Upload API",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{token}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "transactionId",
"value": "{Transaction-Id-From-Init-API-Call}",
"type": "text"
},
{
"key": "X-Account",
"value": "{Connect Account Id if you are setting up a service to service call}",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "[\r\n{\r\n\"target\": \"DE\",\r\n\"publishOriginal\": true,\r\n\"publishRendition\": false,\r\n\"publishReference\": true,\r\n\"documentIdentifier\": \"{Unique-Doc-Id}\",\r\n\"context\": \"{Sub-Context}\",\r\n\"fileName\": \"document1.pdf\",\r\n\"registerIdentifier\": \"System1/TagRefs\",\r\n\"fileRevisionKey\": \"xxxxxx\"\r\n}\r\n]",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{Ingestion-API-Base-URL}/api/load/uploadurl",
"protocol": "https",
"host": [
"{Ingestion-API-Base-URL}"
],
"path": [
"api",
"load",
"uploadurl"
]
}
},
"response": []
},
{
"name": "Put File",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "file",
"file": {
"src": "/C:/Users/ritik.kumar/Desktop/Ext Pen Testing/document1.pdf"
}
},
"url": {
"raw": "{Url-Returned-By-Upload-Url-API-call}",
"host": [
"{Url-Returned-By-Upload-Url-API-call}"
]
}
},
"response": []
},
{
"name": "Complete API",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{token}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "transactionId",
"value": "{Transaction-Id-From-Init-API-Call}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"status\": \"completed\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{Ingestion-API-Base-URL}/api/load/complete",
"protocol": "https",
"host": [
"{Ingestion-API-Base-URL}"
],
"path": [
"api",
"load",
"complete"
]
}
},
"response": []
}
]
}