Attachment Service

ResourceDescription
Delete attachmentDeletes the image with the given id
Get attachmentReturns the attachment with the given id
Upload attachmentUploads a temporary attachment to the server.

Delete attachment

Deletes the image with the given id

DELETE http://domain:port/application_context/api/core/v2/attachments/{id}

Path Parameters

NameTypeDescriptionDefault Value
idlongthe system wide unique identifier for the image 

Response

TypeDescription
void

Get attachment

Returns the attachment with the given id

GET http://domain:port/application_context/api/core/v2/attachments/{id}

Path Parameters

NameTypeDescriptionDefault Value
idlongthe system wide unique identifier for the attachment 

Response

TypeDescription
Responsethe attachment

Upload attachment

Uploads a temporary attachment to the server. Temporary attachments well exist on the server for a certain amount of time before they will be automatically removed unless they are attached to an object. A multipart form post is expected with at least one file attached, if one is not located a bad request error will be triggered, OpenClientError.missing_param.

POST http://domain:port/application_context/api/core/v2/attachments

Post Payload

NameTypeDescriptionDefault Value
bodyMultipartBodymulti-part form post with attachment. 

Response

TypeDescription
Responsea HTTP 201 response including the URL for the uploaded attachment in the Location header