Attaches a file into a field of the table record in your knowledgebase.
int n = ew.EWAttachFromSOAPAttachment(String sessionId, String tableName, long id, String fieldName, String fileName); |
Use the EWAttachFromSOAPAttachment call to attach a file passed as a SOAP attachment into a file or image field in the table using the specified file name.
When attaching files, consider the following rules and guidelines:
Attaching files to records involves the following basic steps:
In MyKB knowledgebase as user A, attach from the client-side filesystem file B.txt located in the current directory to the field Additional Files of case #456 and return the total number of files currently attached.
The task is completed by performing the following steps:
You can generate sample Web Services code for any table by selecting Setup > Tables > (Edit Table) > API > Download Sample.
public int attach() throws Exception { EWServiceAPI binding = new EWServiceAPIServiceLocator().getDemo(); try { String sessionId = binding.EWLogin("MyKB", "A", "password", "en"); DataHandler dataHandler = new DataHandler(new FileDataSource("B.txt")); binding.addAttachment(dataHandler); int n = binding.EWAttachFromSOAPAttachment(sessionId, "case", 456, "additional_files", "B.txt"); return n; } finally { binding.EWLogout(sessionId); } } |
Note: The file to be attached is passed as a SOAP attachment.
Name | Type | Description |
---|---|---|
sessionId | String | Session token |
tableName | String | The name of the table where the record is. |
id | long | The identifier of the record to attach files to. |
fieldName | String | The name of the field to attach files to. |
fileName | String | The name of the file to be used in File or Image field. |
The current number of files attached in the specified field.
EWSessionException - client not logged in or session has expired; client should re-login.
EWPermissionException - user used to create the session lacks sufficient privileges to read the record.
EWWrongDataException - client has supplied wrong data, for instance ID cannot be found.
EWOperationException - the operation has been blocked by one of functionalities, for example a table-level lock.
EWIntegrityException - specified table cannot be found or its primary key cannot be identified.
EWUnexpectedException - an unexpected exception has happened; user should report this for investigation.
Related articles |