REST API - createDocument - Multi-part POST

The table summarizes the REST API - createDocument using a multi-part POST.

Request - Multi-Part POST

Format

POST <baseurl>/bpm/document/upload?caseReference=<case>

For example:

POST <baseurl>/bpm/document/upload?caseReference=BDS-1-com.example.claimbom.Policy-1-0

Response - Multi-Part POST

JSON Returns a JSON representation of the content of the createDocumentResponse element.
XML Returns the content of the createDocumentResponse element (from the DocumentService schema).

Example - Multi-Part POST

Request
POST <baseurl>/bpm/document/upload?caseReference=<case>
Body (with the document content stored in a MIME-type attachment)
{
"name": "New Post Upload Test", "request": {
"auth": { "type": "basic",
"basic": [
{
"key": "password",
"value": "staff123", "type": "string" }, { "key": "username", "value": "tibco-admin", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "content", "type": "file", "src": "/C:/Users/userA/Documents/432SAMLSSO.txt" } ] }, "url": { "raw": "https://bpmwin.apac.xyz.com:8080/bpm/document/upload?caseReference=BDS-1-com.example.caseactionstudy.Case1-6-0", "protocol": "https", "host": [ "bpmwin", "apac", "xyz", "com" ], "port": "8080", "path": [ "bpm", "document", "upload" ], "query": [ { "key": "caseReference", "value": "BDS-1-com.example.caseactionstudy.Case1-6-0" } ] }
Response
{"status": "SUCCESS","documentReference": "DocumentID-66c8ba6b-d424-4ebe-9f18-a9ceb7c3f154-1.0",
"documentName": "432SAMLSSO.txt"}