Add Attachments to Progress Tab of an Event

Allows a file to be attached to an event from the Workflow module through its Progress tab.

 

URL

{WSUrl}/api/events/<EventCode>/attachments

 

REQUEST METHOD

POST

 

URL PARAMETER

EventCode: This parameter is provided in the URL and does not need to be sent through POST.

 

FORM CONTENT

Data (Required): File to be attached to the event. The maximum file size is 10 MB. The file bytes must be converted to a base64 string before sending.

FileName (Required): Name used to identify the attachment. This name can later be used to recover the file.

Comment (Required): Comment with the reason the event was updated.

 

REQUEST EXAMPLE

{WSUrl}/api/events/EVTC201105000052/attachments

 

FORM CONTENT EXAMPLE

{
"FileName": "ProofOfPayment.pdf",
"Data": "TWFuIGlzIGR...WQsIG5vdCBvbm",
"Comment": "Proof of payment sent."
}

 

SUCCESS RESPONSE

The ID of the attachment added. Returns a Guid.

 

SUCCESS RESPONSE EXAMPLE

"ab70bc23-2cd0-43a2-9f45-a34d18fb60a7"