Attachment Web-services

General

 Mandatory input for each operation

• Credentials - Web Service Client User authentication credentials
• extendedSettings - Extended Settings such as response format.

Each Operation returns -

• DefaultServiceResponse JavaBean container which stores the specific bean response for Web Services operation.

Notes:

• While creating an entity, values for fields such as Row ID (Unique system generated), Entity ID (System generated )should not be entered as input parameter values.
• While updating an entity, values for fields that already contain a Read only value should not be entered as input parameter values.

getAttachment

ID: 1

A web service operation which Returns an excerpt pertaining to the specified attachment document.

Input Parameters

attachmentId - Attachment Id for which details should be fetched.

Output

Created By, Created By Contact ID, Created Date, Description, File Data, URL, Attachment Type (Maximum size limit is 3 MB), Can be used as Global, Name, Row ID

listAttachments

Id: 2

A web service operation which Returns the list of all the global attachment documents matching the specified search criteria.

Input Parameters
searchText - String to match the User etc.

Output

Attachment Description, attach_file_type, Type, Attachment Name, Attachment Name, Attachment Name, Attachment Id]]

addAttachments

Id: 3

A web service operation which Adds the attachment document entry into the database.
Input Parameters
attachmentBean - Attachment Bean containing details which must be used to add the attachment

Name,  Attachment Type, Description, File Name / URL, Attach File, Can be used as Global, Created Date, Created By, Created By Contact ID:  
attachFileData - Attachment File Data in binary format

Output

attachment_Id

deleteAttachment

Id: 4

A web service operation which Deletes the attachment document entry from the database.

Input Parameters
attachmentId - Attachment Id which must be deleted

Output:

None