Using the AddAttachment Web Method

adds an attachment to the specified business object record request syntax use the following syntax in preparing your request frsheatintegrationaddattachmentresponse addattachment(string sessionkey, string tenantid, objectattachmentcommanddata commanddata) parameters provide these parameters in your request sessionkey the session key from the connect web method tenantid the tenant for which the session key is authenticated commanddata a structure containing information about the creation request public class objectattachmentcommanddata { public string objectid; public string objecttype; public string filename; public byte\[] filedata; public boolean forcesaveindatabase; } include the following attributes for the objectattachmentcommanddata objectid the recid of the new attachment objecttype the type of the main business object to which this attachment is attached in the object reference notation filename name of the file filedata actual file bytes forcesaveindatabase saves the attachment to the database regardless of client configuration this attribute is false by default return value frsheatintegrationaddattachmentresponse object, defined as follows public class frsheatintegrationaddattachmentresponse { public string status { get; set; } public string exceptionreason { get; set; } } the frsheatintegrationaddattachmentresponse class has the following fields status provides a status about the state of the connection the table below contains a full description of the available status values exceptionreason contains exception information, if the application throws an exception when running this web method the following table lists the available status values and describes how to interpret them \<font color="#ffffff">status\</font>\<font color="#ffffff">explanation\</font> success successfully added the attachment to the business object record error cannot add the attachment to the business object record the exception information is stored in the exceptionreason field the following are common errors the file that is uploaded is a restricted file extension please contact your system administrator for a list of allowed file extensions for upload the attachment has a file extension that is not allowed for the specified tenant attachment upload finished unsuccessfully the application cannot find the business object record the definition for business object \<business object># was not found the specified business object does not exist in the tenant example the following example reads in a sample image from the local file application of the user, and attaches the file to the specified incident record const string filename = "c \\\temp\\\sample jpg"; using (filestream fs = new filestream(filename, filemode open, fileaccess read)) { using (binaryreader r = new binaryreader(fs)) { byte\[] attachmentdata = new byte\[fs length]; for (int i = 0; i < fs length; i++) { attachmentdata\[i] = r readbyte(); } objectattachmentcommanddata data = new objectattachmentcommanddata() { objectid = "9981fbebaa8b4ee2820364505855abc2", objecttype = "incident#", filename = "sample png", filedata = attachmentdata }; frsheatintegrationaddattachmentresponse response = frsvc addattachment(authsessionkey, tenantid, data); if (response status != "success") { console writeline("encountered the following error while adding the attachment to the record " + response exceptionreason); } } }