Edit File in Attachment Business Component Attribute

Allows a file in an Attachment business component attribute to be edited.

 

URL

{RMUrl}/api/Organization/BusinessComponents/<BusinessComponentCode>/attributes/<AttributeVariableName>/files/<AttachmentGUID>

 

REQUEST METHOD

PUT

 

URL PARAMETERS

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

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

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

 

FORM CONTENT

FileName (Required): Name used to identify the attachment.

Data (Required): The file attached to the business component specified. Maximum file size is 10 MB. The file bytes must be converted to a base64 string before sending.

Description (Optional): Optional comment for the attachment.

 

REQUEST EXAMPLE

{RMUrl}/api/organization/businesscomponents/78395d3d-d7e6-4938-9682-b5bd3c5be422/attributes/attachmentattribute/files/06a1f497-023f-4a1e-acaa-787aeed8a5c1

 

FORM CONTENT EXAMPLE

"FileName":"Receipt.pdf",

"Data": "TWFuIGlzIGR...WQsIG5vdCBvbm",

"Description":"Proof of payment sent."

}

 

SUCCESS RESPONSE

HTTP status code 204: NoContent