{ "info": { "_postman_id": "7f96de9a-39e6-4b38-af1f-1d9e56f0e02c", "name": "Simflofy", "description": "![](https://media.cmsmax.com/ekxhivb7yddcfkoy3x88l/simflofy-logo.png)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Records Management", "item": [ { "name": "Auditing", "item": [ { "name": "RM Get All Audited Actions", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"holdId\":12010219320302,\r\n \"docs\":[\"1611856878511_742251575613\",\"1611857922477_742251179075\"]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/audit/actions", "host": [ "{{base_url}}" ], "path": [ "rm", "audit", "actions" ] } }, "response": [] }, { "name": "RM Export Record Audits", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\"fields\": {}, \"start\": 0, \"max\": 100, \"facets\": {}}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/audit/export?asPdf=true&deleteAudits=false&repName=July Audits&reportToRecord=false&scheduleId=120241202412024", "host": [ "{{base_url}}" ], "path": [ "rm", "audit", "export" ], "query": [ { "key": "asPdf", "value": "true" }, { "key": "deleteAudits", "value": "false" }, { "key": "repName", "value": "July Audits" }, { "key": "reportToRecord", "value": "false" }, { "key": "scheduleId", "value": "120241202412024" } ] } }, "response": [] }, { "name": "RM Search Record Audits", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\"fields\": {}, \"start\": 0, \"max\": 100, \"facets\": {}}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/audit/search", "host": [ "{{base_url}}" ], "path": [ "rm", "audit", "search" ] } }, "response": [] } ] }, { "name": "Custom Events", "item": [ { "name": "RM Get Custom Event", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/event/custom?id=ccevent1", "host": [ "{{base_url}}" ], "path": [ "rm", "event", "custom" ], "query": [ { "key": "id", "value": "ccevent1" } ] } }, "response": [] }, { "name": "RM Create a Custom Event", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"displayName\": \"Custom Event\",\r\n \"description\": \"A custom event\",\r\n \"id\": \"ccevent1\",\r\n \"customFieldKey\": \"newfield1\"\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/event/custom", "host": [ "{{base_url}}" ], "path": [ "rm", "event", "custom" ] } }, "response": [] }, { "name": "RM Update a Custom Event", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"displayName\": \"Custom Event\",\r\n \"description\": \"A custom event\",\r\n \"id\": \"ccevent1\",\r\n \"customFieldKey\": \"newfield1\"\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/event/custom", "host": [ "{{base_url}}" ], "path": [ "rm", "event", "custom" ] } }, "response": [] }, { "name": "RM Delete a Custom Event", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "DELETE", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/event/custom?id=ccevent1", "host": [ "{{base_url}}" ], "path": [ "rm", "event", "custom" ], "query": [ { "key": "id", "value": "ccevent1" } ] } }, "response": [] }, { "name": "RM Get All Custom Events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/events/custom", "host": [ "{{base_url}}" ], "path": [ "rm", "events", "custom" ] } }, "response": [] }, { "name": "RM Complete an Event on a Record", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/event?recordId=1611859354612_635846060210&eventKey=stc", "host": [ "{{base_url}}" ], "path": [ "rm", "event" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" }, { "key": "eventKey", "value": "stc" } ] } }, "response": [] }, { "name": "RM Complete Multiple Events on a Record", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\"events\" : [\"ceevent1222\",\"ceevent123232\"]}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/events?recordId=1611859354612_635846060210", "host": [ "{{base_url}}" ], "path": [ "rm", "events" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" } ] } }, "response": [] } ] }, { "name": "Custom Fields", "item": [ { "name": "RM Get Custom Field", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/field/custom?id=newfield1", "host": [ "{{base_url}}" ], "path": [ "rm", "field", "custom" ], "query": [ { "key": "id", "value": "newfield1" } ] } }, "response": [] }, { "name": "RM Create Custom Field", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"displayName\": \"Field1\",\r\n \"description\": \"A custom field\",\r\n \"id\": \"newfield1\",\r\n \"type\": \"date\"\r\n }" }, "url": { "raw": "{{base_url}}/simflofy-admin/api/rm/field/custom", "host": [ "{{base_url}}" ], "path": [ "simflofy-admin", "api", "rm", "field", "custom" ] } }, "response": [] }, { "name": "RM Update Custom Field", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"displayName\": \"Field1\",\r\n \"description\": \"A custom field\",\r\n \"id\": \"newfield1\",\r\n \"type\": \"date\"\r\n }" }, "url": { "raw": "{{base_url}}/rm/field/custom", "host": [ "{{base_url}}" ], "path": [ "rm", "field", "custom" ] } }, "response": [] }, { "name": "RM Delete Custom Field", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/field/custom?id=newfield1", "host": [ "{{base_url}}" ], "path": [ "rm", "field", "custom" ], "query": [ { "key": "id", "value": "newfield1" } ] } }, "response": [] }, { "name": "RM Get All Custom Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/fields/custom", "host": [ "{{base_url}}" ], "path": [ "rm", "fields", "custom" ] } }, "response": [] } ] }, { "name": "Holds", "item": [ { "name": "RM Get Hold", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/hold?holdId=1609874298721", "host": [ "{{base_url}}" ], "path": [ "rm", "hold" ], "query": [ { "key": "holdId", "value": "1609874298721" } ] } }, "response": [] }, { "name": "RM Update Hold", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"id\":1609874298721,\r\n \"length\":\"1y\",\r\n \"description\":\"A 1 Year Hold\",\r\n \"displayName\":\"Document Hold\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/hold", "host": [ "{{base_url}}" ], "path": [ "rm", "hold" ] } }, "response": [] }, { "name": "RM Create Hold", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"length\":\"1y\",\r\n \"description\":\"A 1 Year Hold\",\r\n \"displayName\":\"Document Hold\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/hold", "host": [ "{{base_url}}" ], "path": [ "rm", "hold" ] } }, "response": [] }, { "name": "RM Delete Hold", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/hold?id=1609874298721", "host": [ "{{base_url}}" ], "path": [ "rm", "hold" ], "query": [ { "key": "id", "value": "1609874298721" } ] } }, "response": [] }, { "name": "RM List Holds", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/holds", "host": [ "{{base_url}}" ], "path": [ "rm", "holds" ] } }, "response": [] } ] }, { "name": "Index Intervals", "item": [ { "name": "RM Get Index Interval", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/index/interval", "host": [ "{{base_url}}" ], "path": [ "rm", "index", "interval" ] } }, "response": [] }, { "name": "RM Set Index Interval", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\"hour\":0,\"interval\":\"1d\"}" }, "url": { "raw": "{{base_url}}/rm/index/interval", "host": [ "{{base_url}}" ], "path": [ "rm", "index", "interval" ] } }, "response": [] }, { "name": "RM Get Next Index", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "{\"hour\":0,\"interval\":\"1d\"}" }, "url": { "raw": "{{base_url}}/rm/index/interval/delay", "host": [ "{{base_url}}" ], "path": [ "rm", "index", "interval", "delay" ] } }, "response": [] } ] }, { "name": "Record Actions", "item": [ { "name": "RM Bulk Actions", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"holdId\":12010219320302,\r\n \"docs\":[\"1611856878511_742251575613\",\"1611857922477_742251179075\"]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/addhold/bulk", "host": [ "{{base_url}}" ], "path": [ "rm", "addhold", "bulk" ] } }, "response": [] }, { "name": "RM Destroy Record", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/destroy?recordId=1611859354612_635846060210", "host": [ "{{base_url}}" ], "path": [ "rm", "destroy" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" } ] } }, "response": [] }, { "name": "RM Declare As Record", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/declare?recordId=1611859354612_635846060210", "host": [ "{{base_url}}" ], "path": [ "rm", "declare" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" } ] }, "description": "Declares an already scheduled document as a record." }, "response": [] }, { "name": "RM Cut Off Record", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/cutoff?recordId=1611859354612_635846060210", "host": [ "{{base_url}}" ], "path": [ "rm", "cutoff" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" } ] } }, "response": [] }, { "name": "RM Administrative Delete", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/delete?recordId=1611859354612_635846060210", "host": [ "{{base_url}}" ], "path": [ "rm", "delete" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" } ] } }, "response": [] }, { "name": "RM Get Record", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/record?recordId=1635961431985_cb39529d-6223-43a4-a748-8a7a7b1a370e", "host": [ "{{base_url}}" ], "path": [ "rm", "record" ], "query": [ { "key": "recordId", "value": "1635961431985_cb39529d-6223-43a4-a748-8a7a7b1a370e" } ] } }, "response": [] }, { "name": "RM Create Record", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"docName\": \"Social Security - Susan Smith.docx\",\r\n \"docId\": \"cb39529d-6223-43a4-a748-8a7a7b1a370e\",\r\n \"csId\": \"rmSourceSharePoint-sharePointREST\",\r\n \"makerec\": true,\r\n \"createdDate\": 1631189400000,\r\n \"collection\": \"rm\",\r\n \"connectorId\": \"rmElasticSearchOutput-elasticSearch\",\r\n \"secMarks\": [\r\n 1634851209793\r\n ],\r\n \"contentType\": \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\",\r\n \"tag\": \"1634761202564\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record", "host": [ "{{base_url}}" ], "path": [ "rm", "record" ] } }, "response": [] }, { "name": "RM Undeclare", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/rm/undeclare?recordId=1634568669178_cba7c78a-4bcb-4738-8972-3d67deff363d", "host": [ "{{base_url}}" ], "path": [ "rm", "undeclare" ], "query": [ { "key": "recordId", "value": "1634568669178_cba7c78a-4bcb-4738-8972-3d67deff363d" } ] } }, "response": [] }, { "name": "RM Create Bulk Records", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"tag\": \"102410241024\",\r\n \"declareRecord\":true,\r\n \"docs\": [\r\n {\r\n \"name\": \"Document1.pdf\",\r\n \"docId\": \"635846060210\",\r\n \"createdDate\": 1611947146,\r\n \"connectorId\": \"box\",\r\n \"contentType\":\"application/pdf\"\r\n },\r\n {\r\n \"name\": \"Document2.xml\",\r\n \"docId\": \"635846140111\",\r\n \"createdDate\": 1611947126,\r\n \"connectorId\": \"box\",\r\n \"contentType\":\"application/xml\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/bulk", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "bulk" ] } }, "response": [] }, { "name": "Cut Off Record", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\"name\": \"United States\", \"groupId\":1624631944}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/transfer?recordId=1611859354612_635846060210", "host": [ "{{base_url}}" ], "path": [ "rm", "transfer" ], "query": [ { "key": "recordId", "value": "1611859354612_635846060210" } ] } }, "response": [] } ] }, { "name": "Record Custom Fields", "item": [ { "name": "RM Update Custom Record Field", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"recordId\": \"1611856878511_742251575613\",\r\n \"fieldKey\": \"customField1\",\r\n \"value\": 10\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/field", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "field" ] } }, "response": [] } ] }, { "name": "Reporting", "item": [ { "name": "RM Get Record Count", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/record/count", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "count" ] } }, "response": [] }, { "name": "RM Export Record MetaData", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\"fields\": {}, \"start\": 0, \"max\": 100, \"facets\": {}}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/export?asPdf=true&repName=July Audits", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "export" ], "query": [ { "key": "asPdf", "value": "true" }, { "key": "repName", "value": "July Audits" } ] } }, "response": [] }, { "name": "Get Searched Records As a Tree", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"fields\": {},\r\n \"start\": 0,\r\n \"max\": 100,\r\n \"facets\": {}\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/tree", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "tree" ] } }, "response": [] }, { "name": "Search Records", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\"fields\": {}, \"start\": 0, \"max\": 100, \"facets\": {}}" }, "url": { "raw": "{{base_url}}/rm/search", "host": [ "{{base_url}}" ], "path": [ "rm", "search" ] } }, "response": [] } ] }, { "name": "Security Groups", "item": [ { "name": "Delete Security Group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/security/group?id=1628086140195", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "group" ], "query": [ { "key": "id", "value": "1628086140195" } ] } }, "response": [] }, { "name": "Get All Security Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/security/groups", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "groups" ] } }, "response": [] }, { "name": "Get Security Group", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/security/group?id=100001", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "group" ], "query": [ { "key": "id", "value": "100001" } ] } }, "response": [] }, { "name": "Create a Security Group", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"classifiedBy\": \"\",\r\n \"classifiedAgency\": \"\",\r\n \"created\": 1635865959419,\r\n \"name\": \"Classified-Test\",\r\n \"modified\": 0,\r\n \"classifiedReason\": \"Security Sensitive\",\r\n \"classified\": true,\r\n \"id\": 100010,\r\n \"marks\": [\r\n 100002,\r\n 100003,\r\n 100004\r\n ],\r\n \"type\": \"HIERARCHICAL\",\r\n \"colorHex\": \"#0a6aa1\"\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/security/group", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "group" ] } }, "response": [] }, { "name": "Update a Security Group", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"classifiedBy\": \"\",\r\n \"classifiedAgency\": \"\",\r\n \"created\": 1635865959419,\r\n \"name\": \"Classified-Test\",\r\n \"modified\": 0,\r\n \"classifiedReason\": \"Security Sensitive\",\r\n \"classified\": true,\r\n \"id\": 100010,\r\n \"marks\": [\r\n 100002,\r\n 100003,\r\n 100004\r\n ],\r\n \"type\": \"HIERARCHICAL\",\r\n \"colorHex\": \"#0a6aa1\"\r\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/security/group", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "group" ] } }, "response": [] }, { "name": "Delete a Security Group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/security/group?id=100010", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "group" ], "query": [ { "key": "id", "value": "100010" } ] } }, "response": [] } ] }, { "name": "Security Marks", "item": [ { "name": "RM Get Security Mark By Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/security/mark?id=1634851209793", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "mark" ], "query": [ { "key": "id", "value": "1634851209793" } ] } }, "response": [] }, { "name": "RM Get All Security Marks", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/security/marks", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "marks" ] } }, "response": [] }, { "name": "RM Delete Security Mark", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/security/mark?id=1636044374707", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "mark" ], "query": [ { "key": "id", "value": "1636044374707" } ] } }, "response": [] }, { "name": "Edit Security Marks and Declassify Records", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"recordIds\": [\"1624631944_760342825400\",\"1624631930_760342791027\"], \r\n \"marks\":[\"Top Secret\"] \r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/security", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "security" ] } }, "response": [] }, { "name": "Update Security Marks and Declassify Records", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"docs\": [\r\n {\r\n \"recordId\": \"1624631944_760342825400\",\r\n \"secMarks\": [\r\n 1624379650102\r\n ],\r\n \"declassify\": true\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/security", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "security" ] } }, "response": [] }, { "name": "Update Security Mark", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/rm/security/mark", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "mark" ] } }, "response": [] }, { "name": "Create Security Mark", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\"name\": \"United States\", \"groupId\":1624631944}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/security/mark", "host": [ "{{base_url}}" ], "path": [ "rm", "security", "mark" ] } }, "response": [] }, { "name": "Update Principal Security with List of Marks", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "[1624379650102,1623944499603]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/user/security?principal=test&type=user", "host": [ "{{base_url}}" ], "path": [ "rm", "user", "security" ], "query": [ { "key": "principal", "value": "test" }, { "key": "type", "value": "user" } ] } }, "response": [] } ] }, { "name": "Schedules", "item": [ { "name": "RM Content By Schedule", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "url": { "raw": "{{base_url}}/rm/content", "host": [ "{{base_url}}" ], "path": [ "rm", "content" ] } }, "response": [] }, { "name": "RM Export Content By Schedule", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Content", "value": "", "type": "text" }, { "key": "Content-Type", "value": "application/json;", "type": "text", "disabled": true } ], "url": { "raw": "{{base_url}}/rm/content/export?tagName=Permanent Schedule", "host": [ "{{base_url}}" ], "path": [ "rm", "content", "export" ], "query": [ { "key": "tagName", "value": "Permanent Schedule" } ] } }, "response": [] }, { "name": "Get Schedules", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/schedules", "host": [ "{{base_url}}" ], "path": [ "rm", "schedules" ] } }, "response": [] }, { "name": "Update Record Schedule", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/record/schedule?oldSchedule=Unfiled&recordId=123&scheduleId=120241202412024", "host": [ "{{base_url}}" ], "path": [ "rm", "record", "schedule" ], "query": [ { "key": "oldSchedule", "value": "Unfiled" }, { "key": "recordId", "value": "123" }, { "key": "scheduleId", "value": "120241202412024" } ] } }, "response": [] }, { "name": "Get Retention Schedule By Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/schedule?id=1634761202564", "host": [ "{{base_url}}" ], "path": [ "rm", "schedule" ], "query": [ { "key": "id", "value": "1634761202564" } ] } }, "response": [] }, { "name": "Create or Update Schedule", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"scheduleDescription\": \"Structural schedule\",\r\n \"createdBy\": \"admin\",\r\n \"customEvents\": \"[]\",\r\n \"authorityDescription\": \"Authority\",\r\n \"created\": \"1607525834014\",\r\n \"customFields\": \"[]\",\r\n \"modified\": \"1610551509640\",\r\n \"modifiedBy\": \"admin\",\r\n \"id\": \"1607525834014\",\r\n \"tagName\": \"No Steps\",\r\n \"steps\": [],\r\n \"parentId\": 0\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/schedule", "host": [ "{{base_url}}" ], "path": [ "rm", "schedule" ] } }, "response": [] }, { "name": "Delete Schedule", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/schedule?id=1607525834014", "host": [ "{{base_url}}" ], "path": [ "rm", "schedule" ], "query": [ { "key": "id", "value": "1607525834014" } ] } }, "response": [] }, { "name": "Get Schedule By Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rm/schedule/name?tag=Permanant Schedule", "host": [ "{{base_url}}" ], "path": [ "rm", "schedule", "name" ], "query": [ { "key": "tag", "value": "Permanant Schedule" } ] } }, "response": [] }, { "name": "Rename a Schedule", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/rm/schedule/name?id=120241202412024&name=New Schedule Name", "host": [ "{{base_url}}" ], "path": [ "rm", "schedule", "name" ], "query": [ { "key": "id", "value": "120241202412024" }, { "key": "name", "value": "New Schedule Name" } ] } }, "response": [] }, { "name": "Re-Index Scheduled Documents", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/rm/schedule/reindex?id=120241202412024", "host": [ "{{base_url}}" ], "path": [ "rm", "schedule", "reindex" ], "query": [ { "key": "id", "value": "120241202412024" } ] } }, "response": [] } ] }, { "name": "Transfers", "item": [ { "name": "Get A Transfer Destination", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/transfer/destination?id=1636045077045", "host": [ "{{base_url}}" ], "path": [ "rm", "transfer", "destination" ], "query": [ { "key": "id", "value": "1636045077045", "description": "Transfer Destination Id" } ] } }, "response": [] }, { "name": "Edit A Transfer Destination", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"address\": \"742 Evergreen Terrace\",\r\n \"displayName\": \"Office\",\r\n \"description\": \"A Sample Location\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/transfer/destination", "host": [ "{{base_url}}" ], "path": [ "rm", "transfer", "destination" ] } }, "response": [] }, { "name": "Delete A Transfer Destination", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/rm/transfer/destination?id=1636044807241", "host": [ "{{base_url}}" ], "path": [ "rm", "transfer", "destination" ], "query": [ { "key": "id", "value": "1636044807241" } ] } }, "response": [] }, { "name": "Create a Transfer Destination", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"address\": \"742 Evergreen Terrace\",\r\n \"displayName\": \"Office\",\r\n \"description\": \"A Sample Location\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/transfer/destination", "host": [ "{{base_url}}" ], "path": [ "rm", "transfer", "destination" ] } }, "response": [] }, { "name": "Get All Transfer Destinations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/rm/transfer/destinations", "host": [ "{{base_url}}" ], "path": [ "rm", "transfer", "destinations" ] } }, "response": [] } ] } ] }, { "name": "Content Services", "item": [ { "name": "ACLs", "item": [ { "name": "Get ACLS", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/acls?id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "acls" ], "query": [ { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" } ] } }, "response": [] }, { "name": "Set ACLS", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/acls?id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8&acls=%7B%22newuser%40alfresco.com%22%3A%22cmis%3Aread%2Ccmis%3Awrite%22%2C%22newuser2%40alfresco.com%22%3A%22cmis%3Aread%22%7D", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "acls" ], "query": [ { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" }, { "key": "acls", "value": "%7B%22newuser%40alfresco.com%22%3A%22cmis%3Aread%2Ccmis%3Awrite%22%2C%22newuser2%40alfresco.com%22%3A%22cmis%3Aread%22%7D" } ] } }, "response": [] }, { "name": "Delete ACLS", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/acls?id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8&aclId=%7B%22newuser%40alfresco.com%22%3A%22cmis%3Aread%2Ccmis%3Awrite%22%2C%22newuser2%40alfresco.com%22%3A%22cmis%3Aread%22%7D", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "acls" ], "query": [ { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" }, { "key": "aclId", "value": "%7B%22newuser%40alfresco.com%22%3A%22cmis%3Aread%2Ccmis%3Awrite%22%2C%22newuser2%40alfresco.com%22%3A%22cmis%3Aread%22%7D" } ] } }, "response": [] } ] }, { "name": "File", "item": [ { "name": "Check In File", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/checkin?comment=Changes%20property_a&discard=true&id=172fc7a4-5797-4731-9c42-62e5a6c8c8d862e5a6c8c8d8&acls=%7B%22newuser%40alfresco.com%22%3A%22cmis%3Aread%2Ccmis%3Awrite%22%2C%22newuser2%40alfresco.com%22%3A%22cmis%3Aread%22%7D", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "checkin" ], "query": [ { "key": "comment", "value": "Changes%20property_a" }, { "key": "discard", "value": "true" }, { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d862e5a6c8c8d8" }, { "key": "acls", "value": "%7B%22newuser%40alfresco.com%22%3A%22cmis%3Aread%2Ccmis%3Awrite%22%2C%22newuser2%40alfresco.com%22%3A%22cmis%3Aread%22%7D" } ] } }, "response": [] }, { "name": "Check Out File", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/checkout?id=172fc7a4-5797-4731-9c42-62e5a6c8c8d862e5a6c8c8d8", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "checkout" ], "query": [ { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d862e5a6c8c8d8" } ] } }, "response": [] }, { "name": "Get Content Stream", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/contentStream?id=987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "contentStream" ], "query": [ { "key": "id", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt" } ] } }, "response": [] }, { "name": "Head Content Stream", "request": { "method": "HEAD", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/contentStream?id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "contentStream" ], "query": [ { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" } ] } }, "response": [] }, { "name": "Delete File or Folder", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/delete?allversions=false&id=987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt&path=", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "delete" ], "query": [ { "key": "allversions", "value": "false" }, { "key": "id", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt" }, { "key": "path", "value": "" } ] } }, "response": [] }, { "name": "Get File Contents", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/file?id=987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "file" ], "query": [ { "key": "id", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt" } ] } }, "response": [] }, { "name": "Create File", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/C:/Temp/test.txt" } ] }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/file?fileName=ExampleDocument.txt&folderId=987d9445-999e-49a4-a8be-ed48f0b05f33&id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8&mimeType=text%2Fplain&type=document", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "file" ], "query": [ { "key": "fileName", "value": "ExampleDocument.txt" }, { "key": "folderId", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33" }, { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" }, { "key": "mimeType", "value": "text%2Fplain" }, { "key": "type", "value": "document" } ] } }, "response": [] }, { "name": "Get File Item", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/fileitem?id=987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "fileitem" ], "query": [ { "key": "id", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt" } ] } }, "response": [] }, { "name": "Get File Items", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/fileitems?id=987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt&searchQuery", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "fileitems" ], "query": [ { "key": "id", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33/ExampleDocument.txt" }, { "key": "searchQuery", "value": null } ] } }, "response": [] }, { "name": "Get Inline File", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/inlinefile?id=c%3A%5Ctemp%5C987d9445-999e-49a4-a8be-ed48f0b05f33%5CExampleDocument.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "inlinefile" ], "query": [ { "key": "id", "value": "c%3A%5Ctemp%5C987d9445-999e-49a4-a8be-ed48f0b05f33%5CExampleDocument.txt" } ] } }, "response": [] }, { "name": "Update File", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/C:/Temp/test.txt" } ] }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/update?fileName=ExampleDocument.txt&folderId=987d9445-999e-49a4-a8be-ed48f0b05f33&id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8&mimeType=text%2Fplain&type=document", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "update" ], "query": [ { "key": "fileName", "value": "ExampleDocument.txt" }, { "key": "folderId", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33" }, { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" }, { "key": "mimeType", "value": "text%2Fplain" }, { "key": "type", "value": "document" } ] } }, "response": [] }, { "name": "Update File Content", "request": { "method": "PUT", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/update?fileName=ExampleDocument.txt&folderId=987d9445-999e-49a4-a8be-ed48f0b05f33&id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8&mimeType=text%2Fplain&type=document", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "update" ], "query": [ { "key": "fileName", "value": "ExampleDocument.txt" }, { "key": "folderId", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33" }, { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" }, { "key": "mimeType", "value": "text%2Fplain" }, { "key": "type", "value": "document" } ] } }, "response": [] }, { "name": "Update File Properties", "request": { "method": "PUT", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/updateProperties?fileName=ExampleDocument.txt&folderId=987d9445-999e-49a4-a8be-ed48f0b05f33&id=172fc7a4-5797-4731-9c42-62e5a6c8c8d8&mimeType=text%2Fplain&type=document", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "updateProperties" ], "query": [ { "key": "fileName", "value": "ExampleDocument.txt" }, { "key": "folderId", "value": "987d9445-999e-49a4-a8be-ed48f0b05f33" }, { "key": "id", "value": "172fc7a4-5797-4731-9c42-62e5a6c8c8d8" }, { "key": "mimeType", "value": "text%2Fplain" }, { "key": "type", "value": "document" } ] } }, "response": [] } ] }, { "name": "Folder", "item": [ { "name": "Create Folder", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/C:/Temp/test.txt" } ] }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/folder?path=/RepositoryFolder1/ASubFolder/ChildFolder", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "folder" ], "query": [ { "key": "path", "value": "/RepositoryFolder1/ASubFolder/ChildFolder" } ] } }, "response": [] }, { "name": "Get Folder Items", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/folderitems?id=C:/Temp", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "folderitems" ], "query": [ { "key": "id", "value": "C:/Temp" } ] } }, "response": [] }, { "name": "Get File Batch", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/batch?Id0=C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "batch" ], "query": [ { "key": "Id0", "value": "C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } ] } }, "response": [] }, { "name": "Get Root Folder ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/rootfolderid", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "rootfolderid" ] } }, "response": [] } ] }, { "name": "Version", "item": [ { "name": "Create Version", "request": { "method": "PUT", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version?docId=C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version" ], "query": [ { "key": "docId", "value": "C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } ] } }, "response": [] }, { "name": "List Versions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/listversions?id=c:/temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "listversions" ], "query": [ { "key": "id", "value": "c:/temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } ] } }, "response": [] }, { "name": "Delete Version", "request": { "method": "DELETE", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version?docId=C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt&versionSeriesId=1&versionId=1", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version" ], "query": [ { "key": "docId", "value": "C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" }, { "key": "versionSeriesId", "value": "1" }, { "key": "versionId", "value": "1" } ] } }, "response": [] }, { "name": "Get Version Contents", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version/content?docId=C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt&versionSeriesId=1&versionId=1", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version", "content" ], "query": [ { "key": "docId", "value": "C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" }, { "key": "versionSeriesId", "value": "1" }, { "key": "versionId", "value": "1" } ] } }, "response": [] }, { "name": "Get Version Properties", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version/properties?docId=C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt&versionSeriesId=1&versionId=1", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version", "properties" ], "query": [ { "key": "docId", "value": "C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" }, { "key": "versionSeriesId", "value": "1" }, { "key": "versionId", "value": "1" } ] } }, "response": [] }, { "name": "Revert Version", "request": { "method": "POST", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version/revert?docId=C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt&versionSeriesId=1&versionId=1", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version", "revert" ], "query": [ { "key": "docId", "value": "C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" }, { "key": "versionSeriesId", "value": "1" }, { "key": "versionId", "value": "1" } ] } }, "response": [] } ] }, { "name": "Information", "item": [ { "name": "Get ID By Path", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/idbypath?fileName=Test.txt&folderPath=/RepositoryFolder1/ASubFolder/ChildFolder", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "idbypath" ], "query": [ { "key": "fileName", "value": "Test.txt" }, { "key": "folderPath", "value": "/RepositoryFolder1/ASubFolder/ChildFolder" } ] } }, "response": [] }, { "name": "Get Object Properties", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/properties?id=c:/temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "properties" ], "query": [ { "key": "id", "value": "c:/temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } ] } }, "response": [] }, { "name": "Get Repository Info", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/repositoryInfo", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "repositoryInfo" ] } }, "response": [] }, { "name": "Get Type Definition", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/typeDef?typeId={{document_type}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "typeDef" ], "query": [ { "key": "typeId", "value": "{{document_type}}" } ] } }, "response": [] }, { "name": "Get Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/types", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "types" ] } }, "response": [] }, { "name": "Get Capabilities", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/capabilities", "host": [ "{{base_url}}" ], "path": [ "repo", "capabilities" ] } }, "response": [] }, { "name": "Get Connections", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Connections Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/connections", "host": [ "{{base_url}}" ], "path": [ "repo", "connections" ] } }, "response": [] } ] }, { "name": "Tests", "item": [ { "name": "File Functionality", "item": [ { "name": "Get Capabilities", "event": [ { "listen": "test", "script": { "exec": [ "//connector_id_list - json array of connectors to test\r", "//connector_id_index - The index of the connector in the json array of connectors (connectorIdList below, stored in this variable connector_id_list)\r", "//connector_id_type - current type of connector (e.g. filesystemContentServiceConnector)\r", "//connector_id_caps - the capabilities of the current connector\r", "//connector_id - id of the current connector\r", "//file_id - id of file for getting file, checkout, checkin, etc, retrieved after successful create file call\r", "//folder_id - id of the folder for creating a file, etc. stored in json array connector_id_list\r", "//acl_id - id of the ACL to set or delete, stored in json array connector_id_list\r", "\r", "//Variable are stored at the collection level\r", "//make sure connector_id_index starts with 0\r", "//make sure you have a json list in connector_id_list that looks like this\r", "/*\r", "[\r", " {\r", "\t\"connector_id\": \"fs-connector\",\r", "\t\"connector_id_type\": \"filesystemContentServiceConnector\".\r", " \"folder_id\":\"SourceDocuments\",\r", " \"acl_id\": \"\"\r", " }\r", "]\r", "*/\r", "\r", "pm.test(\"Capabilities Check\", function() {\r", " pm.response.to.have.status(200);\r", "});\r", "\r", "if ( pm.response.code == 200 )\r", "{\r", " //List of connector Ids to test\r", " var connectorIdList = JSON.parse(utils.getConnectorIdList());\r", " var connectorIndex = pm.collectionVariables.get('connector_id_index');\r", " if (connectorIdList.length > connectorIndex) //more connectors to process\r", " {\r", " var currentConnector = connectorIdList[connectorIndex];\r", " pm.collectionVariables.set(\"connector_id_type\",currentConnector.connector_id_type);\r", " pm.collectionVariables.set(\"connector_id\",currentConnector.connector_id);\r", " pm.collectionVariables.set(\"folder_path\",currentConnector.folder_path);\r", " pm.collectionVariables.set(\"acl_id\", currentConnector.acl_id);\r", "\r", " var caps = JSON.parse(responseBody);\r", " var results = caps.results;\r", " var connlist = JSON.parse(results);\r", " Object.keys(connlist).forEach(function(key) {\r", " var value = connlist[key];\r", " if ( key == pm.collectionVariables.get('connector_id_type')) {\r", " pm.collectionVariables.set('connector_id_caps', value);\r", " }\r", " });\r", " \r", " pm.collectionVariables.set(\"connector_id_index\",++connectorIndex);\r", " }\r", " else { //no more connectors to process\r", " pm.collectionVariables.set(\"connector_id_index\",0); //reset the index\r", " postman.setNextRequest(null); //don't process any more requests\r", " }\r", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/capabilities", "host": [ "{{base_url}}" ], "path": [ "repo", "capabilities" ] } }, "response": [] }, { "name": "Get Repository Info", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Repository Info Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/repositoryInfo", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "repositoryInfo" ] } }, "response": [] }, { "name": "Get Connections", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/connections", "host": [ "{{base_url}}" ], "path": [ "repo", "connections" ] } }, "response": [] }, { "name": "Get Root Folder ID", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Root Folder ID Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/rootfolderid", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "rootfolderid" ] } }, "response": [] }, { "name": "Get Types", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getTypes') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Types Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/types", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "types" ] } }, "response": [] }, { "name": "Get Type Definition", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getTypes') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Types Definition Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/typeDef?typeId={{document_type}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "typeDef" ], "query": [ { "key": "typeId", "value": "{{document_type}}" } ] } }, "response": [] }, { "name": "Create Folder", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('createFolder') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Create Folder Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})\r", "\r", "if ( pm.response.code == 200) {\r", " //set the file id\r", " var json = JSON.parse(responseBody);\r", "\r", " //todo: if windows, then replace / with \\ \r", " var id = json.results.id;\r", " if ( connectortype != \"ftpContentServiceConnector\")\r", " id = id.replace(\"/\",\"\\\\\");\r", " pm.collectionVariables.set(\"folder_id\",encodeURIComponent(id)); \r", " \r", "}\r", "else {\r", " pm.collectionVariables.set(\"folder_id\",encodeURIComponent(pm.collectionVariables.get(\"folder_path\"))); \r", "}\r", "\r", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/folder?path={{folder_path}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "folder" ], "query": [ { "key": "path", "value": "{{folder_path}}" } ] } }, "response": [] }, { "name": "Create File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('createFile') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Create File Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})\r", "\r", "if ( pm.response.code == 200) {\r", " //set the file id\r", " var json = JSON.parse(responseBody);\r", "\r", " //if windows, then replace / with \\ \r", " var id = json.results.id;\r", " if(connectortype != \"s3ContentServiceConnector\" && connectortype != \"ftpContentServiceConnector\" )\r", " id = id.replace(\"/\",\"\\\\\");\r", " pm.collectionVariables.set(\"file_id\",encodeURIComponent(id)); \r", " \r", "}\r", "\r", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "ExampleDocument.txt" } ] }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/file?fileName=ExampleDocument.txt&folderId={{folder_id}}&id=&mimeType=text%2Fplain&type={{document_type}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "file" ], "query": [ { "key": "fileName", "value": "ExampleDocument.txt" }, { "key": "folderId", "value": "{{folder_id}}" }, { "key": "id", "value": "" }, { "key": "mimeType", "value": "text%2Fplain" }, { "key": "type", "value": "{{document_type}}" } ] } }, "response": [] }, { "name": "Get ID By Path", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getObjectIDByPath') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get ID By Path Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/idbypath?folderPath={{folder_path}}&fileName=ExampleDocument", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "idbypath" ], "query": [ { "key": "folderPath", "value": "{{folder_path}}" }, { "key": "fileName", "value": "ExampleDocument" } ] } }, "response": [] }, { "name": "Get Object Properties", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getObjectProperties') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Object Properties Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/properties?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "properties" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Get File Batch", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getFileContent') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get File Batch Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/batch?id0={{file_id}}&fname0=ExampleDocument.txt&conn0={{connector_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "batch" ], "query": [ { "key": "id0", "value": "{{file_id}}" }, { "key": "fname0", "value": "ExampleDocument.txt" }, { "key": "conn0", "value": "{{connector_id}}" } ] } }, "response": [] }, { "name": "Get Folder Items", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('listFolderItems') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"List Folder Items Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/folderitems?id={{folder_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "folderitems" ], "query": [ { "key": "id", "value": "{{folder_id}}" } ] } }, "response": [] }, { "name": "Get Inline File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getFileContent') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Inline Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/inlinefile?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "inlinefile" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Get Content Stream", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getFileContent') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Content Stream Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/contentStream?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "contentStream" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Get File Item", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getFileItem') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get File Item Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/fileitem?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "fileitem" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Get File Contents", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getFileContent') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get File Contents Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/file?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "file" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Head Content Stream", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 204;\r", "\r", "if ( !utils.supportsCap('getFileContent') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Head Content Stream Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "HEAD", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/contentStream?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "contentStream" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Update File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('updateFile') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "\r", "pm.test(\"Update File Status Check - \" + connectortype , function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})\r", "\r", "if ( pm.response.code == 200) {\r", " //set the file id\r", " var json = JSON.parse(responseBody);\r", "\r", " //if windows, then replace / with \\ \r", " var id = json.results.id;\r", " if(connectortype != \"s3ContentServiceConnector\")\r", " id = id.replace(\"/\",\"\\\\\");\r", " pm.collectionVariables.set(\"file_id\",encodeURIComponent(id)); \r", " \r", "}" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [], "body": { "mode": "file", "file": { "src": "Updated/ExampleDocument.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/update?fileName=ExampleDocument.txt&folderId={{folder_id}}&fileId={{file_id}}&mimetype=text%2Fplain&type={{document_type}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "update" ], "query": [ { "key": "fileName", "value": "ExampleDocument.txt" }, { "key": "folderId", "value": "{{folder_id}}" }, { "key": "fileId", "value": "{{file_id}}" }, { "key": "mimetype", "value": "text%2Fplain" }, { "key": "type", "value": "{{document_type}}" } ] } }, "response": [] }, { "name": "Check Out File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('checkOut') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Check Out Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/checkout?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "checkout" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Update File Properties", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('updateProperties') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "\r", "pm.test(\"Update Properties Status Check - \" + connectortype , function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/updateProperties?fileId={{file_id}}&Document.keywords=TestKeyword1", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "updateProperties" ], "query": [ { "key": "fileId", "value": "{{file_id}}" }, { "key": "Document.keywords", "value": "TestKeyword1" } ] } }, "response": [] }, { "name": "Cancel Check Out File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('checkIn') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Cancel Check Out Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/checkin?comment=Changes%20property_a&discard=true&id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "checkin" ], "query": [ { "key": "comment", "value": "Changes%20property_a" }, { "key": "discard", "value": "true" }, { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Check In File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('checkIn') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Check In Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "});\r", "\r", "if ( pm.response.code == 200) {\r", " //set the file id\r", " var json = JSON.parse(responseBody);\r", "\r", " //if windows, then replace / with \\ \r", " var id = json.results.id;\r", " if(connectortype != \"s3ContentServiceConnector\" && connectortype != \"ftpContentServiceConnector\" )\r", " id = id.replace(\"/\",\"\\\\\");\r", " pm.collectionVariables.set(\"file_id\",encodeURIComponent(id)); \r", " \r", "}\r", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/checkin?comment=Changes%20property_a&discard=false&id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "checkin" ], "query": [ { "key": "comment", "value": "Changes%20property_a" }, { "key": "discard", "value": "false" }, { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Get ACLS", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getACLs') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get ACLs Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "});\r", "\r", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/acls?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "acls" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Set ACLS", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('setACLs') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Set ACL Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": " {\"testuser@box.com\":\"reader\",\"rs199483@gmail.com\":\"reader\"}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/acls?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "acls" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Delete ACLS", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('deleteACL') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Delete ACL Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/acls?id={{file_id}}&aclId={{acl_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "acls" ], "query": [ { "key": "id", "value": "{{file_id}}" }, { "key": "aclId", "value": "{{acl_id}}" } ] } }, "response": [] }, { "name": "Create Version", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('createVersion') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Create Version Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})\r", "\r", "if ( pm.response.code == 200) {\r", "\r", " //set the version/series id\r", " var json = JSON.parse(responseBody);\r", " \r", " var versionid = json.results.versionId;\r", " versionid = versionid.replace(\"/\",\"\\\\\");\r", "\r", " var versionSeriesId = json.results.versionSeriesId;\r", " versionSeriesId = versionSeriesId.replace(\"/\",\"\\\\\");\r", "\r", " pm.collectionVariables.set(\"version_id\",encodeURIComponent(versionid)); \r", " pm.collectionVariables.set(\"version_series_id\",encodeURIComponent(versionSeriesId)); \r", " \r", "}\r", "else if (pm.response.code == expectedStatus) {\r", " //doesn't support create version so put the file_id in version id and version series id\r", " var file_id = pm.collectionVariables.get(\"file_id\");\r", " pm.collectionVariables.set(\"version_id\",encodeURIComponent(file_id)); \r", " pm.collectionVariables.set(\"version_series_id\",encodeURIComponent(file_id)); \r", "}" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [], "body": { "mode": "file", "file": { "src": "v2/ExampleDocument.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version?docId={{file_id}}&fileName=ExampleDocument.txt", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version" ], "query": [ { "key": "docId", "value": "{{file_id}}" }, { "key": "fileName", "value": "ExampleDocument.txt" } ] } }, "response": [] }, { "name": "Get Version Contents", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getVersionContent') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Version Content Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version/content?docId={{file_id}}&versionSeriesId={{version_series_id}}&versionId={{version_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version", "content" ], "query": [ { "key": "docId", "value": "{{file_id}}" }, { "key": "versionSeriesId", "value": "{{version_series_id}}" }, { "key": "versionId", "value": "{{version_id}}" } ] } }, "response": [] }, { "name": "Get Version Properties", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('getVersionProperties') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Get Version Properties Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "file", "file": { "src": "/C:/Temp/RepositoryFolder1/ASubFolder/ChildFolder/Test.txt" } }, "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version/properties?docId={{file_id}}&versionSeriesId={{version_series_id}}&versionId={{version_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version", "properties" ], "query": [ { "key": "docId", "value": "{{file_id}}" }, { "key": "versionSeriesId", "value": "{{version_series_id}}" }, { "key": "versionId", "value": "{{version_id}}" } ] } }, "response": [] }, { "name": "List Versions", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('listVersions') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"List Versions Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/listversions?id={{file_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "listversions" ], "query": [ { "key": "id", "value": "{{file_id}}" } ] } }, "response": [] }, { "name": "Revert Version", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('revertVersion') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Revert Version Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version/revert?docId={{file_id}}&versionSeriesId={{version_series_id}}&versionId={{version_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version", "revert" ], "query": [ { "key": "docId", "value": "{{file_id}}" }, { "key": "versionSeriesId", "value": "{{version_series_id}}" }, { "key": "versionId", "value": "{{version_id}}" } ] } }, "response": [] }, { "name": "Delete Version", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('deleteVersion') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Delete Version Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "})" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/version?docId={{file_id}}&versionSeriesId={{version_series_id}}&versionId={{version_id}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "version" ], "query": [ { "key": "docId", "value": "{{file_id}}" }, { "key": "versionSeriesId", "value": "{{version_series_id}}" }, { "key": "versionId", "value": "{{version_id}}" } ] } }, "response": [] }, { "name": "Delete File", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('deleteObjectByID') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Delete Object By ID Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "});\r", "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/delete?allversions=false&id={{file_id}}&path=", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "delete" ], "query": [ { "key": "allversions", "value": "false" }, { "key": "id", "value": "{{file_id}}" }, { "key": "path", "value": "" } ] } }, "response": [] }, { "name": "Delete Folder", "event": [ { "listen": "test", "script": { "exec": [ "var expectedStatus = 200;\r", "\r", "if ( !utils.supportsCap('deleteFolder') )\r", " expectedStatus = 405;\r", "\r", "var connectortype = pm.collectionVariables.get('connector_id_type');\r", "pm.test(\"Delete Folder Status Check - \" + connectortype, function() {\r", " pm.response.to.have.status(expectedStatus);\r", "});\r", "\r", "//Loop back to the beginning call\r", "postman.setNextRequest(\"Get Capabilities\"); " ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/repo/{{connector_id}}/delete?path={{folder_path}}", "host": [ "{{base_url}}" ], "path": [ "repo", "{{connector_id}}", "delete" ], "query": [ { "key": "path", "value": "{{folder_path}}" } ] } }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "utils = {", " supportsCap: function(capname) {", " var currentCaps = pm.collectionVariables.get(\"connector_id_caps\");", " var hasCap = currentCaps.indexOf(capname) != -1;", " return hasCap;", " },", " getConnectorIdList: function() {", " return pm.collectionVariables.get(\"connector_id_list\");", " }", "};" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] } ] } ] }, { "name": "Hold Service", "item": [ { "name": "Get Document Holds", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/holds?docId=12c50a8f-f861-4d5b-b0ef-66b89240c9a3", "host": [ "{{base_url}}" ], "path": [ "holds" ], "query": [ { "key": "docId", "value": "12c50a8f-f861-4d5b-b0ef-66b89240c9a3" } ] } }, "response": [] }, { "name": "Add Document Hold", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/holds/add?docId=67f52ef6-c2aa-4e26-810b-4239ad7a8898&connectorId=SharePointRM&holdId=1610041874033&searchConnId=elasticrm", "host": [ "{{base_url}}" ], "path": [ "holds", "add" ], "query": [ { "key": "docId", "value": "67f52ef6-c2aa-4e26-810b-4239ad7a8898" }, { "key": "connectorId", "value": "SharePointRM" }, { "key": "holdId", "value": "1610041874033" }, { "key": "searchConnId", "value": "elasticrm" } ] } }, "response": [] }, { "name": "Remove Document Hold", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/holds/remove?docId=67f52ef6-c2aa-4e26-810b-4239ad7a8898&connectorId=SharePointRM&holdId=1610041874033&searchConnId=elasticrm", "host": [ "{{base_url}}" ], "path": [ "holds", "remove" ], "query": [ { "key": "docId", "value": "67f52ef6-c2aa-4e26-810b-4239ad7a8898" }, { "key": "connectorId", "value": "SharePointRM" }, { "key": "holdId", "value": "1610041874033" }, { "key": "searchConnId", "value": "elasticrm" } ] } }, "response": [] } ] }, { "name": "Job Service", "item": [ { "name": "Abort Job", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/{{jobid}}/abort", "host": [ "{{base_url}}" ], "path": [ "job", "service", "{{jobid}}", "abort" ] } }, "response": [] }, { "name": "Get Record Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/{{jobid}}/recordstatus?docId=1&recordType=r", "host": [ "{{base_url}}" ], "path": [ "job", "service", "{{jobid}}", "recordstatus" ], "query": [ { "key": "docId", "value": "1" }, { "key": "recordType", "value": "r" } ] } }, "response": [] }, { "name": "Resume Job", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/{{jobid}}/resume", "host": [ "{{base_url}}" ], "path": [ "job", "service", "{{jobid}}", "resume" ] } }, "response": [] }, { "name": "Run Job Errors", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/{{jobid}}/runerrors", "host": [ "{{base_url}}" ], "path": [ "job", "service", "{{jobid}}", "runerrors" ] } }, "response": [] }, { "name": "Start Job", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/{{jobid}}/start", "host": [ "{{base_url}}" ], "path": [ "job", "service", "{{jobid}}", "start" ] } }, "response": [] }, { "name": "Get Job Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/{{jobid}}/status", "host": [ "{{base_url}}" ], "path": [ "job", "service", "{{jobid}}", "status" ] } }, "response": [] }, { "name": "Get Job Status List", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/job/service/statuslist", "host": [ "{{base_url}}" ], "path": [ "job", "service", "statuslist" ] } }, "response": [] } ] }, { "name": "Search Service", "item": [ { "name": "Add Document Index", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"simflofy_filename\": \"test.txt\",\r\n \"simflofy_connectorid\": \"fs-connector\",\r\n \"simflofy_repository_id\": \"repoid\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/add", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "add" ] } }, "response": [] }, { "name": "Remove a field from a Document", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/clear?docId=123&fieldName=field1", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "clear" ], "query": [ { "key": "docId", "value": "123" }, { "key": "fieldName", "value": "field1" } ] } }, "response": [] }, { "name": "Get Document Count for Collection", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/count", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "count" ] } }, "response": [] }, { "name": "Delete an Indexed Document", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/delete?docId=1", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "delete" ], "query": [ { "key": "docId", "value": "1" } ] } }, "response": [] }, { "name": "Delete Collection", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/drop", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "drop" ] } }, "response": [] }, { "name": "Ensure Field is Mapped", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"hasPii\": \"boolean\",\r\n \"country\": \"text\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/mappings", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "mappings" ] } }, "response": [] }, { "name": "Add Security Marks to Documents", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"docIds\": [\r\n \"760342825400\",\r\n \"760342791027\"\r\n ],\r\n \"marks\": [\r\n \"Top Secret\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/security", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "security" ] } }, "response": [] }, { "name": "Edit Security Marks and Declassify Document", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"docs\": [\r\n {\r\n \"docId\": \"760342825400\",\r\n \"marks\": [\r\n 1624379650102\r\n ],\r\n \"declassify\": true\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/security", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "security" ] } }, "response": [] }, { "name": "Search Select with Collection", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/select", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "select" ] } }, "response": [] }, { "name": "Update Document Index", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"isRM\": true\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/update?docId=cb39529d-6223-43a4-a748-8a7a7b1a370e", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "update" ], "query": [ { "key": "docId", "value": "cb39529d-6223-43a4-a748-8a7a7b1a370e" } ] } }, "response": [] }, { "name": "Update Document Index Bulk", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"ids\": [\r\n \"id1\",\r\n \"id2\",\r\n \"ids3\"\r\n ],\r\n \"properties\": {\r\n \"simflofy_filename\": \"newname.jpg\",\r\n \"department\": \"Accounting\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/update", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "update" ] } }, "response": [] }, { "name": "Update Document Permissions", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"docPermissions\": [\r\n {\r\n \"action\": \"Search\",\r\n \"allow\": true,\r\n \"prinicpals\": [\r\n \"everyone\"\r\n ]\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/update/permission?docId=123", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "update", "permission" ], "query": [ { "key": "docId", "value": "123" } ] } }, "response": [] }, { "name": "Update Document Permissions Bulk", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"ids\": [\r\n \"id1\",\r\n \"id2\",\r\n \"id3\"\r\n ],\r\n \"properties\": {\r\n \"action\":Search,\r\n \"allow\": true,\r\n \"prinicpals\": [\r\n \"everyone\"\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/{{search_collection_name}}/update/permission/bulk?action=Search", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "{{search_collection_name}}", "update", "permission", "bulk" ], "query": [ { "key": "action", "value": "Search" } ] } }, "response": [] }, { "name": "Search More Like This", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/morelikethis", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "morelikethis" ] } }, "response": [] }, { "name": "Search Connection Info", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/searchConnectionInfo", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "searchConnectionInfo" ] } }, "response": [] }, { "name": "Search Select", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/select", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "select" ] } }, "response": [] }, { "name": "Search Connector UI Widget", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/{{search_connector_id}}/ui", "host": [ "{{base_url}}" ], "path": [ "search", "{{search_connector_id}}", "ui" ] } }, "response": [] }, { "name": "Get View Configuration", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/viewname/view", "host": [ "{{base_url}}" ], "path": [ "search", "viewname", "view" ] } }, "response": [] }, { "name": "Get Search Connector Options", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/connector/options", "host": [ "{{base_url}}" ], "path": [ "search", "connector", "options" ] } }, "response": [] }, { "name": "Get Search Connections", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/searchconnections", "host": [ "{{base_url}}" ], "path": [ "search", "searchconnections" ] } }, "response": [] }, { "name": "Get Template", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/tsearch/template?shortName=rm", "host": [ "{{base_url}}" ], "path": [ "search", "tsearch", "template" ], "query": [ { "key": "shortName", "value": "rm" } ] } }, "response": [] }, { "name": "Get Templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/tsearch/templates", "host": [ "{{base_url}}" ], "path": [ "search", "tsearch", "templates" ] } }, "response": [] }, { "name": "Get View by Short Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/tsearch/view?shortName=view_name", "host": [ "{{base_url}}" ], "path": [ "search", "tsearch", "view" ], "query": [ { "key": "shortName", "value": "view_name" } ] } }, "response": [] }, { "name": "Get Views", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/tsearch/views", "host": [ "{{base_url}}" ], "path": [ "search", "tsearch", "views" ] } }, "response": [] }, { "name": "Search For Users and Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/search/user/search?search=username*", "host": [ "{{base_url}}" ], "path": [ "search", "user", "search" ], "query": [ { "key": "search", "value": "username*" } ] } }, "response": [] } ] }, { "name": "User Search Service", "item": [ { "name": "Load Saved Searches", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/user/service/searches", "host": [ "{{base_url}}" ], "path": [ "user", "service", "searches" ] } }, "response": [] }, { "name": "Delete Saved Search", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"username\": \"myusername\",\r\n \"viewId\": \"view id\",\r\n \"id\": \"searchid\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/user/service/searches/delete", "host": [ "{{base_url}}" ], "path": [ "user", "service", "searches", "delete" ] } }, "response": [] }, { "name": "Save Search", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/user/service/searches/save", "host": [ "{{base_url}}" ], "path": [ "user", "service", "searches", "save" ] } }, "response": [] } ] }, { "name": "Event Service", "item": [ { "name": "Push Event", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/event/service/pushevent?jobId=1631569493226&documentId=C:/SourceDocuments/sampledoc.pdf", "host": [ "{{base_url}}" ], "path": [ "event", "service", "pushevent" ], "query": [ { "key": "jobId", "value": "1631569493226" }, { "key": "documentId", "value": "C:/SourceDocuments/sampledoc.pdf" } ] } }, "response": [] }, { "name": "Push Event Copy", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/event/service/pushevent?jobId=1636997986436&documentId=C:/SourceDocuments/ThisIsAPushEventDoc.txt", "host": [ "{{base_url}}" ], "path": [ "event", "service", "pushevent" ], "query": [ { "key": "jobId", "value": "1636997986436" }, { "key": "documentId", "value": "C:/SourceDocuments/ThisIsAPushEventDoc.txt" } ] } }, "response": [] } ], "description": "## Simflofy Push Events\n\nTo use a push event you will need to create a job and set its type to be Event. Then just call the URL below, providing the necessary parameters.\n\nSimflofy will then sync the content based on the source documentId.\n\n### Overview\n\nSimflofy Push Events allow you to send events to event based jobs in Simflofy.  This will tell the job to get and process a document. If the job is not already running, it will also start the job for you.\n\n### Push Event\n\nURL: http://{HOST}:{PORT}/simflofy-admin/event/remoteservice/pushevent?jobId=\\[JOBID\\]&documentId=\\[documentId\\] \n\nParameters (Form Fields):\n\n| Parameter | Description | Optional? |\n| jobId | The Event Job you are pushing the notification to. | No |\n| documentId | The id of the document in the source system. | No |" } ], "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{password}}", "type": "string" }, { "key": "username", "value": "{{username}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "base_url", "value": "http://localhost:8080/simflofy-admin/api" }, { "key": "search_connector_id", "value": "elasticrm" }, { "key": "search_collection_name", "value": "rm" }, { "key": "connector_id", "value": "BoxConn1" }, { "key": "username", "value": "admin" }, { "key": "password", "value": "admin" }, { "key": "job_id", "value": "1" }, { "key": "connector_id_type", "value": "boxContentServiceConnector" }, { "key": "connector_id_caps", "value": "" }, { "key": "connector_id_list", "value": "[\n {\n\t\t\"connector_id\": \"salesforce-test\",\n\t\t\"connector_id_type\": \"salesforceContentServiceConnector\",\n\t\t\"folder_path\": \"/TestFolder/ChildFolder\",\n\t\t\"acl_id\": \"{}\"\n\t}\n ]\n" }, { "key": "connector_id_index", "value": "0" }, { "key": "file_id", "value": "" }, { "key": "folder_id", "value": "150655735081" }, { "key": "acl_id", "value": "%7B%22testuser%40box.com%22%3A%22EDITOR%22%7D" }, { "key": "folder_path", "value": "/TestFolder/ChildFolder" }, { "key": "version_id", "value": "1" }, { "key": "version_series_id", "value": "1" }, { "key": "document_type", "value": "document" } ] }