JavaScript SDK Samples - Attachment Operations
Get Attachments
class Attachment {
/**
* Get Attachments
* This method is used to get a single record's attachments' details with ID and print the response.
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordID The ID of the record to get attachments
*/
static async getAttachments(moduleAPIName, recordID) {
//example
// let moduleAPIName = "Leads";
// let recordId = 3409643000002267003n;
//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new ZCRM.Attachment.Operations(moduleAPIName, recordID);
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
// Possible parameters of Get Attachments Operation
// await paramInstance.add(ZCRM.Attachment.Model.GetAttachmentsParam.FIELDS, "id");
await paramInstance.add(ZCRM.Attachment.Model.GetAttachmentsParam.PAGE, 1);
await paramInstance.add(ZCRM.Attachment.Model.GetAttachmentsParam.PER_PAGE, 10);
//Call getAttachments method that takes ParameterMap instance as parameter
let response = await attachmentsOperations.getAttachments(paramInstance);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if([204, 304].includes(response.getStatusCode())){
console.log(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ResponseWrapper instance is received.
if(responseObject instanceof ZCRM.Attachment.Model.ResponseWrapper){
//Get the array of obtained Attachment instances
let attachments = responseObject.getData();
attachments.forEach(attachment => {
//Get the ID of each attachment
console.log("Attachment ID: " + attachment.getId());
//Get the owner User instance of each attachment
let owner = attachment.getOwner();
//Check if owner is not null
if(owner != null){
//Get the Name of the Owner
console.log("Attachment Owner - Name: " + owner.getName());
//Get the ID of the Owner
console.log("Attachment Owner ID: " + owner.getId());
//Get the Email of the Owner
console.log("Attachment Owner Email: " + owner.getEmail());
}
if(attachment.getModifiedTime() != null) {
//Get the modified time of each attachment
console.log("Attachment Modified Time: " + attachment.getModifiedTime().toString());
}
//Get the name of the File
console.log("Attachment File Name: " + attachment.getFileName());
//Get the created time of each attachment
console.log("Attachment Created Time: " + attachment.getCreatedTime());
//Get the Attachment file size
console.log("Attachment File Size: " + attachment.getSize());
//Get the parentId Record instance of each attachment
let parentId = attachment.getParentId();
//Check if parentId is not null
if(parentId != null){
//Get the parent record Name of each attachment
console.log("Attachment parent record Name: " + parentId.getKeyValue("name"));
//Get the parent record ID of each attachment
console.log("Attachment parent record ID: " + parentId.getId());
}
if(attachment.getEditable() != null) {
//Check if the attachment is Editable
console.log("Attachment is Editable: " + attachment.getEditable().toString());
}
//Get the file ID of each attachment
console.log("Attachment File ID: " + attachment.getFileId());
//Get the type of each attachment
console.log("Attachment File Type: " + attachment.getType());
//Get the seModule of each attachment
console.log("Attachment seModule: " + attachment.getSeModule());
//Get the modifiedBy User instance of each attachment
let modifiedBy = attachment.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the Name of the modifiedBy User
console.log("Attachment Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Attachment Modified By User-ID: " + modifiedBy.getId());
//Get the Email of the modifiedBy User
console.log("Attachment Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the state of each attachment
console.log("Attachment State: " + attachment.getState());
//Get the createdBy User instance of each attachment
let createdBy = attachment.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null){
//Get the name of the createdBy User
console.log("Attachment Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Attachment Created By User-ID: " + createdBy.getId());
//Get the Email of the createdBy User
console.log("Attachment Created By User-Email: " + createdBy.getEmail());
}
//Get the linkUrl of each attachment
console.log("Attachment LinkUrl: " + attachment.getLinkUrl());
});
//Get the obtained Info object
let info = responseObject.getInfo();
if(info != null){
if(info.getPerPage() != null){
//Get the PerPage of the Info
console.log("Attachment Info PerPage: " + info.getPerPage().toString());
}
if(info.getCount() != null){
//Get the Count of the Info
console.log("Attachment Info Count: " + info.getCount().toString());
}
if(info.getPage() != null){
//Get the Page of the Info
console.log("Attachment Info Page: " + info.getPage().toString());
}
if(info.getMoreRecords() != null){
//Get the MoreRecords of the Info
console.log("Attachment Info MoreRecords: " + info.getMoreRecords().toString());
}
}
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Attachment.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Upload Attachments
class Attachment
{
/**
* Upload Attachments
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record to upload attachment
*/
static async uploadAttachments(moduleAPIName, recordId) {
//example
// let moduleAPIName = "Leads";
// let recordId = 3409643000002267003n;
// let absoluteFilePath = "/Users/user-name/Documents/image.jpg";
//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new ZCRM.Attachment.Operations(moduleAPIName, recordId);
//Get instance of FileBodyWrapper class that will contain the request file
let fileBodyWrapper = new ZCRM.Attachment.Model.FileBodyWrapper();
/** StreamWrapper can be initialized in any of the following ways */
var filesToLoad = document.getElementById("attachment").files;
var file = filesToLoad[0];
/**
* param 1 -> fileName
* param 2 -> Read Stream
*/
let streamWrapper = new StreamWrapper.Model.StreamWrapper(null, file);
//Set file to the FileBodyWrapper instance
fileBodyWrapper.setFile(streamWrapper);
//Call uploadAttachment method that takes FileBodyWrapper instance as parameter
let response = await attachmentsOperations.uploadAttachment(fileBodyWrapper);
if(response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if(responseObject != null) {
//Check if expected ActionWrapper instance is received.
if(responseObject instanceof ZCRM.Attachment.Model.ActionWrapper) {
//Get the array of obtained action responses
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof ZCRM.Attachment.Model.SuccessResponse){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof ZCRM.Attachment.Model.APIException) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Attachment.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Delete Attachments
class Attachment
{
/**
* Delete Attachments
* This method is used to Delete attachments of a single record with ID and print the response.
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record to delete attachments
* @param {String} attachmentIds The array of attachment IDs to be deleted
*/
static async deleteAttachments(moduleAPIName, recordId, attachmentIds){
//example
// let moduleAPIName = "Leads";
// let recordId = 3409643000002267003n;
// let attachmentIds = [3409643000002267024n, 3409643000002267034n, 3409643000002267198n]
//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new ZCRM.Attachment.Operations(moduleAPIName, recordId);
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
for(let attachmentId of attachmentIds) {
//Add the ids to parameter map instance
await paramInstance.add(ZCRM.Attachment.Model.DeleteAttachmentsParam.IDS, attachmentId);
}
//Call deleteAttachments method that takes paramInstance as parameter
let response = await attachmentsOperations.deleteAttachments(paramInstance);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received.
if(responseObject instanceof ZCRM.Attachment.Model.ActionWrapper){
//Get the array of obtained Action Responses.
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof ZCRM.Attachment.Model.SuccessResponse){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
let details = actionResponse.getDetails();
//Get the details map
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof ZCRM.Attachment.Model.APIException){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
let details = actionResponse.getDetails();
//Get the details map
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Attachment.Model.APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
let details = responseObject.getDetails();
//Get the details map
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Download an Attachment
class Attachment
{
/**
* Download Attachment
* This method is used to download an attachment of a single record of a module with ID and attachment ID and write the file in the specified destination.
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record to download attachment
* @param {BigInt} attachmentId The ID of the attachment to be downloaded
* @param {String} destinationFolder The absolute path of the destination folder to store the attachment
*/
static async downloadAttachment(moduleAPIName, recordId, attachmentId) {
//example
// let moduleAPIName = "Leads";
// let recordId = 3409643000002267003n;
// let attachmentId = 3409643000002267024n;
// let destinationFolder = "/Users/user-name/Desktop";
//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new ZCRM.Attachment.Operations(moduleAPIName, recordId);
//Call downloadAttachment method that takes attachmentId as parameters
let response = await attachmentsOperations.downloadAttachment(attachmentId);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if(response.getStatusCode() == 204){
console.log("No Content");
return;
}
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected FileBodyWrapper instance is received.
if(responseObject instanceof ZCRM.Attachment.Model.FileBodyWrapper){
//Get StreamWrapper instance from the returned FileBodyWrapper instance
let streamWrapper = responseObject.getFile();
//Get name from StreamWrapper instance
let fileName = streamWrapper.getName();
//Get the stream from StreamWrapper instance
let readStream = streamWrapper.getStream();
var url = URL.createObjectURL(readStream);
var ttt = document.createElement('a');
ttt.href = url;
ttt.download = fileName;
ttt.click();
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Attachment.Model.APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
let details = responseObject.getDetails();
//Get the details map
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Delete an Attachment
class Attachment
{
/**
* Delete Attachment
* This method is used to delete an attachment of a single record of a module with ID and attachment ID and print the response
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record to delete attachment
* @param {BigInt} attachmentId The ID of the attachment to be deleted
*/
static async deleteAttachment(moduleAPIName, recordId, attachmentId){
//example
// let moduleAPIName = "Leads";
// let recordId = 3409643000002267003n;
// let attachmentId = 3409643000002267024n;
//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new ZCRM.Attachment.Operations(moduleAPIName, recordId);
//Call deleteAttachment method that takes attachmentId as parameter
let response = await attachmentsOperations.deleteAttachment(attachmentId);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received.
if(responseObject instanceof ZCRM.Attachment.Model.ActionWrapper){
//Get the list of obtained Action Response instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof ZCRM.Attachment.Model.SuccessResponse){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof ZCRM.Attachment.Model.APIException) {
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
let details = actionResponse.getDetails();
//Get the details map
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Attachment.Model.APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
let details = responseObject.getDetails();
//Get the details map
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Upload Link as an Attachment
class Attachment
{
/**
* Upload Link Attachments
* This method is used to upload link attachment and print the response.
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record to upload Link attachment
* @param {String} attachmentURL The attachmentURL of the doc or image link to be attached
*/
static async uploadLinkAttachment(moduleAPIName, recordId, attachmentURL){
//example
// let moduleAPIName = "Leads";
// let recordId = 3409643000002267003n;
// let attachmentURL = "https://5.imimg.com/data5/KJ/UP/MY-8655440/zoho-crm-500x500.png";
//Get instance of AttachmentsOperations Class that takes recordId and moduleAPIName as parameter
let attachmentsOperations = new ZCRM.Attachment.Operations(moduleAPIName, recordId);
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Add the attachmentURL to parameter Instance
await paramInstance.add(ZCRM.Attachment.Model.UploadLinkAttachmentParam.ATTACHMENTURL, attachmentURL);
//Call uploadLinkAttachments method that takes paramInstance as parameter
let response = await attachmentsOperations.uploadLinkAttachment(paramInstance);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received.
if(responseObject instanceof ZCRM.Attachment.Model.ActionWrapper){
//Get the array of obtained Action Response instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof ZCRM.Attachment.Model.SuccessResponse){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof ZCRM.Attachment.Model.APIException){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Attachment.Model.APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}