JavaScript SDK Samples - Records Operations
Get a Record
class Records
{
/**
* Get Record
* This method is used to get a single record of a module 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 be obtained.
*/
static async getRecord(moduleAPIName, recordId) {
//example
//let moduleAPIName = "Contacts";
//let recordId = 34770616603276n;
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Record operation*/
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.APPROVED, "true");
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.CONVERTED, "false");
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.CVID, "34096430087501");
let fieldsArray = ["id", "Subform_1"];
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.FIELDS, fieldsArray.toString());
/* Month is zero-indexed.
0 -> January ..... 11 -> December
*/
// let startDateTime = new Date(2020,7,10,10,10,10);
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.STARTDATETIME, startDateTime);
// let endDateTime = new Date(2020,7,10,12,12,12);
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.ENDDATETIME, endDateTime);
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.TERRITORY_ID, "34096430505351");
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.INCLUDE_CHILD, "true");
// await paramInstance.add(ZCRM.Record.Model.GetRecordParam.UID, "34096430500741");
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
/* Possible headers for Get Record operation*/
// await headerInstance.add(ZCRM.Record.Model.GetRecordHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T01:01:01+05:30"));
await headerInstance.add(ZCRM.Record.Model.GetRecordHeader.X_EXTERNAL, "Leads.External");
//Call getRecord method that takes paramInstance, headerInstance, moduleAPIName and recordID as parameter
let response = await recordOperations.getRecord(recordId, moduleAPIName, paramInstance, headerInstance);
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 ResponseWrapper instance is received
if (responseObject instanceof ZCRM.Record.Model.ResponseWrapper) {
//Get the array of obtained Record instances
let records = responseObject.getData();
for (let index = 0; index {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
//To get particular field value
console.log("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
console.log("Record KeyValues: ");
let keyValues = record.getKeyValues();
let keyArray = Array.from(keyValues.keys());
for (let keyIndex = 0; keyIndex 0) {
if (value[0] instanceof ZCRM.Record.Model.FileDetails) {
let fileDetails = value;
fileDetails.forEach(fileDetail => {
//Get the Extn of each FileDetails
console.log("Record FileDetails Extn: " + fileDetail.getExtn());
//Get the IsPreviewAvailable of each FileDetails
console.log("Record FileDetails IsPreviewAvailable: " + fileDetail.getIsPreviewAvailable());
//Get the DownloadUrl of each FileDetails
console.log("Record FileDetails DownloadUrl: " + fileDetail.getDownloadUrl());
//Get the DeleteUrl of each FileDetails
console.log("Record FileDetails DeleteUrl: " + fileDetail.getDeleteUrl());
//Get the EntityId of each FileDetails
console.log("Record FileDetails EntityId: " + fileDetail.getEntityId());
//Get the Mode of each FileDetails
console.log("Record FileDetails Mode: " + fileDetail.getMode());
//Get the OriginalSizeByte of each FileDetails
console.log("Record FileDetails OriginalSizeByte: " + fileDetail.getOriginalSizeByte());
//Get the PreviewUrl of each FileDetails
console.log("Record FileDetails PreviewUrl: " + fileDetail.getPreviewUrl());
//Get the FileName of each FileDetails
console.log("Record FileDetails FileName: " + fileDetail.getFileName());
//Get the FileId of each FileDetails
console.log("Record FileDetails FileId: " + fileDetail.getFileId());
//Get the AttachmentId of each FileDetails
console.log("Record FileDetails AttachmentId: " + fileDetail.getAttachmentId());
//Get the FileSize of each FileDetails
console.log("Record FileDetails FileSize: " + fileDetail.getFileSize());
//Get the CreatorId of each FileDetails
console.log("Record FileDetails CreatorId: " + fileDetail.getCreatorId());
//Get the LinkDocs of each FileDetails
console.log("Record FileDetails LinkDocs: " + fileDetail.getLinkDocs());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Reminder) {
let reminders = value;
reminders.forEach(reminder => {
console.log("Reminder Period: " + reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Participants) {
let participants = value;
participants.forEach(participant => {
console.log("Record Participants Name: " + participant.getName());
console.log("Record Participants Invited: " + participant.getInvited());
console.log("Record Participants ID: " + participant.getId());
console.log("Record Participants Type: " + participant.getType());
console.log("Record Participants Participant: " + participant.getParticipant());
console.log("Record Participants Status: " + participant.getStatus());
});
}
else if (value[0] instanceof Choice) {
let choiceArray = value;
console.log(keyName);
console.log("Values");
choiceArray.forEach(eachChoice => {
console.log(eachChoice.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.InventoryLineItems) {
let productDetails = value;
productDetails.forEach(productDetail => {
let lineItemProduct = productDetail.getProduct();;
if (lineItemProduct != null) {
console.log("Record ProductDetails LineItemProduct ProductCode: " + lineItemProduct.getProductCode());
console.log("Record ProductDetails LineItemProduct Currency: " + lineItemProduct.getCurrency());
console.log("Record ProductDetails LineItemProduct Name: " + lineItemProduct.getName());
console.log("Record ProductDetails LineItemProduct Id: " + lineItemProduct.getId());
}
console.log("Record ProductDetails Quantity: " + productDetail.getQuantity());
console.log("Record ProductDetails Discount: " + productDetail.getDiscount());
console.log("Record ProductDetails TotalAfterDiscount: " + productDetail.getTotalAfterDiscount());
console.log("Record ProductDetails NetTotal: " + productDetail.getNetTotal());
if (productDetail.getBook() != null) {
console.log("Record ProductDetails Book: " + productDetail.getBook());
}
console.log("Record ProductDetails Tax: " + productDetail.getTax());
console.log("Record ProductDetails ListPrice: " + productDetail.getListPrice());
console.log("Record ProductDetails UnitPrice: " + productDetail.getUnitPrice());
console.log("Record ProductDetails QuantityInStock: " + productDetail.getQuantityInStock());
console.log("Record ProductDetails Total: " + productDetail.getTotal());
console.log("Record ProductDetails ID: " + productDetail.getId());
console.log("Record ProductDetails ProductDescription: " + productDetail.getProductDescription());
let lineTaxes = productDetail.getLineTax();
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
});
}
else if (value[0] instanceof ZCRM.Tag.Model.Tag) {
let tags = value;
tags.forEach(tag => {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
else if (value[0] instanceof ZCRM.Record.Model.PricingDetails) {
let pricingDetails = value;
pricingDetails.forEach(pricingDetail => {
console.log("Record PricingDetails ToRange: " + pricingDetail.getToRange());
console.log("Record PricingDetails Discount: " + pricingDetail.getDiscount());
console.log("Record PricingDetails ID: " + pricingDetail.getId());
console.log("Record PricingDetails FromRange: " + pricingDetail.getFromRange());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Record) {
let recordArray = value;
recordArray.forEach(record => {
Array.from(record.getKeyValues().keys()).forEach(key => {
console.log(key + ": " + record.getKeyValues().get(key));
});
});
}
else if (value[0] instanceof ZCRM.Record.Model.LineTax) {
let lineTaxes = value;
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Comment) {
let comments = value;
comments.forEach(comment => {
console.log("Record Comment CommentedBy: " + comment.getCommentedBy());
console.log("Record Comment CommentedTime: " + comment.getCommentedTime());
console.log("Record Comment CommentContent: " + comment.getCommentContent());
console.log("Record Comment Id: " + comment.getId());
});
}
else if (value[0] instanceof ZCRM.Attachment.Model.Attachment) {
let attachments = value;
attachments.forEach(attachment => {
//Get the ID of each attachment
console.log("Record 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("Record Attachment Owner - Name: " + owner.getName());
//Get the ID of the Owner
console.log("Record Attachment Owner ID: " + owner.getId());
//Get the Email of the Owner
console.log("Record Attachment Owner Email: " + owner.getEmail());
}
//Get the modified time of each attachment
console.log("Record Attachment Modified Time: " + attachment.getModifiedTime());
//Get the name of the File
console.log("Record Attachment File Name: " + attachment.getFileName());
//Get the created time of each attachment
console.log("Record Attachment Created Time: " + attachment.getCreatedTime());
//Get the Attachment file size
console.log("Record 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("Record Attachment parent record Name: " + parentId.getKeyValue("name"));
//Get the parent record ID of each attachment
console.log("Record Attachment parent record ID: " + parentId.getId());
}
//Check if the attachment is Editable
console.log("Record Attachment is Editable: " + attachment.getEditable());
//Get the file ID of each attachment
console.log("Record Attachment File ID: " + attachment.getFileId());
//Get the type of each attachment
console.log("Record Attachment File Type: " + attachment.getType());
//Get the seModule of each attachment
console.log("Record 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("Record Attachment Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Record Attachment Modified By User-ID: " + modifiedBy.getId());
//Get the Email of the modifiedBy User
console.log("Record Attachment Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the state of each attachment
console.log("Record 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("Record Attachment Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Record Attachment Created By User-ID: " + createdBy.getId());
//Get the Email of the createdBy User
console.log("Record Attachment Created By User-Email: " + createdBy.getEmail());
}
//Get the linkUrl of each attachment
console.log("Record Attachment LinkUrl: " + attachment.getLinkUrl());
});
}
else {
console.log(keyName + ": " + value);
}
}
}
else if (value instanceof ZCRM.User.Model.User) {
console.log("Record " + keyName + " User-ID: " + value.getId());
console.log("Record " + keyName + " User-Name: " + value.getName());
console.log("Record " + keyName + " User-Email: " + value.getEmail());
}
else if (value instanceof ZCRM.Layout.Model.Layout) {
console.log(keyName + " ID: " + value.getId());
console.log(keyName + " Name: " + value.getName());
}
else if (value instanceof ZCRM.Record.Model.Record) {
console.log(keyName + " Record ID: " + value.getId());
console.log(keyName + " Record Name: " + value.getKeyValue("name"));
}
else if (value instanceof Choice) {
console.log(keyName + ": " + value.getValue());
}
else if (value instanceof ZCRM.Record.Model.RemindAt) {
console.log(keyName + ": " + value.getAlarm());
}
else if (value instanceof ZCRM.Record.Model.RecurringActivity) {
console.log(keyName);
console.log("RRULE: " + value.getRrule());
}
else if (value instanceof ZCRM.Record.Model.Consent) {
console.log("Record Consent ID: " + value.getId());
//Get the Owner User instance of each attachment
let owner = value.getOwner();
//Check if owner is not null
if (owner != null) {
//Get the name of the owner User
console.log("Record Consent Owner Name: " + owner.getName());
//Get the ID of the owner User
console.log("Record Consent Owner ID: " + owner.getId());
//Get the Email of the owner User
console.log("Record Consent Owner Email: " + owner.getEmail());
}
let consentCreatedBy = value.getCreatedBy();
//Check if createdBy is not null
if (consentCreatedBy != null) {
//Get the name of the CreatedBy User
console.log("Record Consent CreatedBy Name: " + consentCreatedBy.getName());
//Get the ID of the CreatedBy User
console.log("Record Consent CreatedBy ID: " + consentCreatedBy.getId());
//Get the Email of the CreatedBy User
console.log("Record Consent CreatedBy Email: " + consentCreatedBy.getEmail());
}
let consentModifiedBy = value.getModifiedBy();
//Check if createdBy is not null
if (consentModifiedBy != null) {
//Get the name of the ModifiedBy User
console.log("Record Consent ModifiedBy Name: " + consentModifiedBy.getName());
//Get the ID of the ModifiedBy User
console.log("Record Consent ModifiedBy ID: " + consentModifiedBy.getId());
//Get the Email of the ModifiedBy User
console.log("Record Consent ModifiedBy Email: " + consentModifiedBy.getEmail());
}
console.log("Record Consent CreatedTime: " + value.getCreatedTime());
console.log("Record Consent ModifiedTime: " + value.getModifiedTime());
console.log("Record Consent ContactThroughEmail: " + value.getContactThroughEmail());
console.log("Record Consent ContactThroughSocial: " + value.getContactThroughSocial());
console.log("Record Consent ContactThroughSurvey: " + value.getContactThroughSurvey());
console.log("Record Consent ContactThroughPhone: " + value.getContactThroughPhone());
console.log("Record Consent MailSentTime: " + value.getMailSentTime());
console.log("Record Consent ConsentDate: " + value.getConsentDate());
console.log("Record Consent ConsentRemarks: " + value.getConsentRemarks());
console.log("Record Consent ConsentThrough: " + value.getConsentThrough());
console.log("Record Consent DataProcessingBasis: " + value.getDataProcessingBasis());
//To get custom values
console.log("Record Consent Lawful Reason: " + value.getKeyValue("Lawful_Reason"));
}
else if (value instanceof Map) {
console.log(keyName);
Array.from(value.keys()).forEach(key => {
console.log(key + ": " + value.get(key));
});
}
else {
console.log(keyName + ": " + value);
}
}
}
}
//Check if FileBodyWrapper instance is received
else if (responseObject instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Update a Record
class Records
{
/**
* Update Record
* This method is used to update a single record of a module 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 be updated
*/
static async updateRecord(moduleAPIName, recordId) {
//example
//let moduleAPIName = "Leads";
//let recordId = 34770615177002n;
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.BodyWrapper();
//Array to hold Record instances
let recordsArray = [];
//Get instance of Record Class
let record1 = new ZCRM.Record.Model.Record();
/*
* Call addFieldValue method that takes two arguments
* Import the "zcrmsdk/core/com/zoho/crm/api/record/field" file
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "First Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "KKRNP");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record1.addKeyValue("Custom_field", "Value");
record1.addKeyValue("Custom_field_2", "value");
record1.addKeyValue("Date_1", new Date(2017, 1, 13));
let fileDetails = [];
let fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c32537b7c2400dadca8ff55f620c65357da");
fileDetails.push(fileDetail);
fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c32e0063e7321b5b4ca878a934519e6cdb2");
fileDetails.push(fileDetail);
fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c323daf4780bfe0058133556f155795981f");
fileDetails.push(fileDetail);
record1.addKeyValue("File_Upload", fileDetails);
//Used when GDPR is enabled
let dataConsent = new ZCRM.Record.Model.Consent();
dataConsent.setConsentRemarks("Approved.");
dataConsent.setConsentThrough("Email");
dataConsent.setContactThroughEmail(true);
dataConsent.setContactThroughSocial(false);
// record1.addKeyValue("Data_Processing_Basis_Details", dataConsent);
//Add Record instance to the array
recordsArray.push(record1);
//Set the array to Records in BodyWrapper instance
request.setData(recordsArray);
let trigger = [];
trigger.push("approval");
trigger.push("workflow");
trigger.push("blueprint");
request.setTrigger(trigger);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
await headerInstance.add(ZCRM.Record.Model.UpdateRecordHeader.X_EXTERNAL, "Leads.External");
//Call updateRecord method that takes BodyWrapper instance, ModuleAPIName and recordId as parameter.
let response = await recordOperations.updateRecord(recordId, moduleAPIName, request, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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 a Record
class Records
{
/**
* Delete Record
* This method is used to delete a single record of a module 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 be deleted
*/
static async deleteRecord(moduleAPIName, recordId) {
//example
//let moduleAPIName = "Leads";
//let recordId = 34770615177002n;
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Possible parameters for Delete Record operation
await paramInstance.add(ZCRM.Record.Model.DeleteRecordParam.WF_TRIGGER, true);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
await headerInstance.add(ZCRM.Record.Model.DeleteRecordHeader.X_EXTERNAL, "Leads.External");
//Call deleteRecord method that takes paramInstance, ModuleAPIName and recordId as parameter.
let response = await recordOperations.deleteRecord(recordId, moduleAPIName, paramInstance, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Get Record Using External ID
class Records
{
/**
* Delete Record
* This method is used to delete a single record of a module 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 be deleted
*/
static async getRecordUsingExternalId(moduleAPIName, externalFieldValue) {
//example
//let moduleAPIName = "Contacts";
//let externalFieldValue = "34770616603276";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Record operation*/
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.APPROVED, "true");
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.CONVERTED, "false");
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.CVID, "34096430087501");
let fieldsArray = ["id", "Subform_1"];
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.FIELDS, fieldsArray.toString());
/* Month is zero-indexed.
0 -> January ..... 11 -> December
*/
// let startDateTime = new Date(2020,7,10,10,10,10);
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.STARTDATETIME, startDateTime);
// let endDateTime = new Date(2020,7,10,12,12,12);
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.ENDDATETIME, endDateTime);
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.TERRITORY_ID, "34096430505351");
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.INCLUDE_CHILD, "true");
// await paramInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.UID, "34096430500741");
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
/* Possible headers for Get Record operation*/
// await headerInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T01:01:01+05:30"));
await headerInstance.add(ZCRM.Record.Model.GetRecordUsingExternalIDHeader.X_EXTERNAL, "Leads.External");
//Call getRecordUsingExternalId method that takes externalFieldValue, moduleAPIName, paramInstance and headerInstance as parameter
let response = await recordOperations.getRecordUsingExternalId(externalFieldValue, moduleAPIName, paramInstance, headerInstance);
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 ResponseWrapper instance is received
if (responseObject instanceof ZCRM.Record.Model.ResponseWrapper) {
//Get the array of obtained Record instances
let records = responseObject.getData();
for (let index = 0; index {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
//To get particular field value
console.log("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
console.log("Record KeyValues: ");
let keyValues = record.getKeyValues();
let keyArray = Array.from(keyValues.keys());
for (let keyIndex = 0; keyIndex 0) {
if (value[0] instanceof ZCRM.Record.Model.FileDetails) {
let fileDetails = value;
fileDetails.forEach(fileDetail => {
//Get the Extn of each FileDetails
console.log("Record FileDetails Extn: " + fileDetail.getExtn());
//Get the IsPreviewAvailable of each FileDetails
console.log("Record FileDetails IsPreviewAvailable: " + fileDetail.getIsPreviewAvailable());
//Get the DownloadUrl of each FileDetails
console.log("Record FileDetails DownloadUrl: " + fileDetail.getDownloadUrl());
//Get the DeleteUrl of each FileDetails
console.log("Record FileDetails DeleteUrl: " + fileDetail.getDeleteUrl());
//Get the EntityId of each FileDetails
console.log("Record FileDetails EntityId: " + fileDetail.getEntityId());
//Get the Mode of each FileDetails
console.log("Record FileDetails Mode: " + fileDetail.getMode());
//Get the OriginalSizeByte of each FileDetails
console.log("Record FileDetails OriginalSizeByte: " + fileDetail.getOriginalSizeByte());
//Get the PreviewUrl of each FileDetails
console.log("Record FileDetails PreviewUrl: " + fileDetail.getPreviewUrl());
//Get the FileName of each FileDetails
console.log("Record FileDetails FileName: " + fileDetail.getFileName());
//Get the FileId of each FileDetails
console.log("Record FileDetails FileId: " + fileDetail.getFileId());
//Get the AttachmentId of each FileDetails
console.log("Record FileDetails AttachmentId: " + fileDetail.getAttachmentId());
//Get the FileSize of each FileDetails
console.log("Record FileDetails FileSize: " + fileDetail.getFileSize());
//Get the CreatorId of each FileDetails
console.log("Record FileDetails CreatorId: " + fileDetail.getCreatorId());
//Get the LinkDocs of each FileDetails
console.log("Record FileDetails LinkDocs: " + fileDetail.getLinkDocs());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Reminder) {
let reminders = value;
reminders.forEach(reminder => {
console.log("Reminder Period: " + reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Participants) {
let participants = value;
participants.forEach(participant => {
console.log("Record Participants Name: " + participant.getName());
console.log("Record Participants Invited: " + participant.getInvited());
console.log("Record Participants ID: " + participant.getId());
console.log("Record Participants Type: " + participant.getType());
console.log("Record Participants Participant: " + participant.getParticipant());
console.log("Record Participants Status: " + participant.getStatus());
});
}
else if (value[0] instanceof Choice) {
let choiceArray = value;
console.log(keyName);
console.log("Values");
choiceArray.forEach(eachChoice => {
console.log(eachChoice.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.InventoryLineItems) {
let productDetails = value;
productDetails.forEach(productDetail => {
let lineItemProduct = productDetail.getProduct();;
if (lineItemProduct != null) {
console.log("Record ProductDetails LineItemProduct ProductCode: " + lineItemProduct.getProductCode());
console.log("Record ProductDetails LineItemProduct Currency: " + lineItemProduct.getCurrency());
console.log("Record ProductDetails LineItemProduct Name: " + lineItemProduct.getName());
console.log("Record ProductDetails LineItemProduct Id: " + lineItemProduct.getId());
}
console.log("Record ProductDetails Quantity: " + productDetail.getQuantity());
console.log("Record ProductDetails Discount: " + productDetail.getDiscount());
console.log("Record ProductDetails TotalAfterDiscount: " + productDetail.getTotalAfterDiscount());
console.log("Record ProductDetails NetTotal: " + productDetail.getNetTotal());
if (productDetail.getBook() != null) {
console.log("Record ProductDetails Book: " + productDetail.getBook());
}
console.log("Record ProductDetails Tax: " + productDetail.getTax());
console.log("Record ProductDetails ListPrice: " + productDetail.getListPrice());
console.log("Record ProductDetails UnitPrice: " + productDetail.getUnitPrice());
console.log("Record ProductDetails QuantityInStock: " + productDetail.getQuantityInStock());
console.log("Record ProductDetails Total: " + productDetail.getTotal());
console.log("Record ProductDetails ID: " + productDetail.getId());
console.log("Record ProductDetails ProductDescription: " + productDetail.getProductDescription());
let lineTaxes = productDetail.getLineTax();
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
});
}
else if (value[0] instanceof ZCRM.Tag.Model.Tag) {
let tags = value;
tags.forEach(tag => {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
else if (value[0] instanceof ZCRM.Record.Model.PricingDetails) {
let pricingDetails = value;
pricingDetails.forEach(pricingDetail => {
console.log("Record PricingDetails ToRange: " + pricingDetail.getToRange());
console.log("Record PricingDetails Discount: " + pricingDetail.getDiscount());
console.log("Record PricingDetails ID: " + pricingDetail.getId());
console.log("Record PricingDetails FromRange: " + pricingDetail.getFromRange());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Record) {
let recordArray = value;
recordArray.forEach(record => {
Array.from(record.getKeyValues().keys()).forEach(key => {
console.log(key + ": " + record.getKeyValues().get(key));
});
});
}
else if (value[0] instanceof ZCRM.Record.Model.LineTax) {
let lineTaxes = value;
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Comment) {
let comments = value;
comments.forEach(comment => {
console.log("Record Comment CommentedBy: " + comment.getCommentedBy());
console.log("Record Comment CommentedTime: " + comment.getCommentedTime());
console.log("Record Comment CommentContent: " + comment.getCommentContent());
console.log("Record Comment Id: " + comment.getId());
});
}
else if (value[0] instanceof ZCRM.Attachment.Model.Attachment) {
let attachments = value;
attachments.forEach(attachment => {
//Get the ID of each attachment
console.log("Record 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("Record Attachment Owner - Name: " + owner.getName());
//Get the ID of the Owner
console.log("Record Attachment Owner ID: " + owner.getId());
//Get the Email of the Owner
console.log("Record Attachment Owner Email: " + owner.getEmail());
}
//Get the modified time of each attachment
console.log("Record Attachment Modified Time: " + attachment.getModifiedTime());
//Get the name of the File
console.log("Record Attachment File Name: " + attachment.getFileName());
//Get the created time of each attachment
console.log("Record Attachment Created Time: " + attachment.getCreatedTime());
//Get the Attachment file size
console.log("Record 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("Record Attachment parent record Name: " + parentId.getKeyValue("name"));
//Get the parent record ID of each attachment
console.log("Record Attachment parent record ID: " + parentId.getId());
}
//Check if the attachment is Editable
console.log("Record Attachment is Editable: " + attachment.getEditable());
//Get the file ID of each attachment
console.log("Record Attachment File ID: " + attachment.getFileId());
//Get the type of each attachment
console.log("Record Attachment File Type: " + attachment.getType());
//Get the seModule of each attachment
console.log("Record 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("Record Attachment Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Record Attachment Modified By User-ID: " + modifiedBy.getId());
//Get the Email of the modifiedBy User
console.log("Record Attachment Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the state of each attachment
console.log("Record 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("Record Attachment Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Record Attachment Created By User-ID: " + createdBy.getId());
//Get the Email of the createdBy User
console.log("Record Attachment Created By User-Email: " + createdBy.getEmail());
}
//Get the linkUrl of each attachment
console.log("Record Attachment LinkUrl: " + attachment.getLinkUrl());
});
}
else {
console.log(keyName + ": " + value);
}
}
}
else if (value instanceof ZCRM.User.Model.User) {
console.log("Record " + keyName + " User-ID: " + value.getId());
console.log("Record " + keyName + " User-Name: " + value.getName());
console.log("Record " + keyName + " User-Email: " + value.getEmail());
}
else if (value instanceof ZCRM.Layout.Model.Layout) {
console.log(keyName + " ID: " + value.getId());
console.log(keyName + " Name: " + value.getName());
}
else if (value instanceof ZCRM.Record.Model.Record) {
console.log(keyName + " Record ID: " + value.getId());
console.log(keyName + " Record Name: " + value.getKeyValue("name"));
}
else if (value instanceof Choice) {
console.log(keyName + ": " + value.getValue());
}
else if (value instanceof ZCRM.Record.Model.RemindAt) {
console.log(keyName + ": " + value.getAlarm());
}
else if (value instanceof ZCRM.Record.Model.RecurringActivity) {
console.log(keyName);
console.log("RRULE: " + value.getRrule());
}
else if (value instanceof ZCRM.Record.Model.Consent) {
console.log("Record Consent ID: " + value.getId());
//Get the Owner User instance of each attachment
let owner = value.getOwner();
//Check if owner is not null
if (owner != null) {
//Get the name of the owner User
console.log("Record Consent Owner Name: " + owner.getName());
//Get the ID of the owner User
console.log("Record Consent Owner ID: " + owner.getId());
//Get the Email of the owner User
console.log("Record Consent Owner Email: " + owner.getEmail());
}
let consentCreatedBy = value.getCreatedBy();
//Check if createdBy is not null
if (consentCreatedBy != null) {
//Get the name of the CreatedBy User
console.log("Record Consent CreatedBy Name: " + consentCreatedBy.getName());
//Get the ID of the CreatedBy User
console.log("Record Consent CreatedBy ID: " + consentCreatedBy.getId());
//Get the Email of the CreatedBy User
console.log("Record Consent CreatedBy Email: " + consentCreatedBy.getEmail());
}
let consentModifiedBy = value.getModifiedBy();
//Check if createdBy is not null
if (consentModifiedBy != null) {
//Get the name of the ModifiedBy User
console.log("Record Consent ModifiedBy Name: " + consentModifiedBy.getName());
//Get the ID of the ModifiedBy User
console.log("Record Consent ModifiedBy ID: " + consentModifiedBy.getId());
//Get the Email of the ModifiedBy User
console.log("Record Consent ModifiedBy Email: " + consentModifiedBy.getEmail());
}
console.log("Record Consent CreatedTime: " + value.getCreatedTime());
console.log("Record Consent ModifiedTime: " + value.getModifiedTime());
console.log("Record Consent ContactThroughEmail: " + value.getContactThroughEmail());
console.log("Record Consent ContactThroughSocial: " + value.getContactThroughSocial());
console.log("Record Consent ContactThroughSurvey: " + value.getContactThroughSurvey());
console.log("Record Consent ContactThroughPhone: " + value.getContactThroughPhone());
console.log("Record Consent MailSentTime: " + value.getMailSentTime());
console.log("Record Consent ConsentDate: " + value.getConsentDate());
console.log("Record Consent ConsentRemarks: " + value.getConsentRemarks());
console.log("Record Consent ConsentThrough: " + value.getConsentThrough());
console.log("Record Consent DataProcessingBasis: " + value.getDataProcessingBasis());
//To get custom values
console.log("Record Consent Lawful Reason: " + value.getKeyValue("Lawful_Reason"));
}
else if (value instanceof Map) {
console.log(keyName);
Array.from(value.keys()).forEach(key => {
console.log(key + ": " + value.get(key));
});
}
else {
console.log(keyName + ": " + value);
}
}
}
}
//Check if FileBodyWrapper instance is received
else if (responseObject instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Update Records Using External ID
class Records
{
/**
* Delete Record
* This method is used to delete a single record of a module 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 be deleted
*/
static async updateRecordUsingExternalId(moduleAPIName, externalFieldValue) {
//example
//let moduleAPIName = "Leads";
//let externalFieldValue = "34770615177002";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.BodyWrapper();
//Array to hold Record instances
let recordsArray = [];
//Get instance of Record Class
let record1 = new ZCRM.Record.Model.Record();
/*
* Call addFieldValue method that takes two arguments
* Import the "zcrmsdk/core/com/zoho/crm/api/record/field" file
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "First Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "KKRNP");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record1.addKeyValue("Custom_field", "Value");
record1.addKeyValue("Custom_field_2", "value");
record1.addKeyValue("Date_1", new Date(2017, 1, 13));
let fileDetails = [];
let fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c32537b7c2400dadca8ff55f620c65357da");
fileDetails.push(fileDetail);
fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c32e0063e7321b5b4ca878a934519e6cdb2");
fileDetails.push(fileDetail);
fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c323daf4780bfe0058133556f155795981f");
fileDetails.push(fileDetail);
record1.addKeyValue("File_Upload", fileDetails);
//Used when GDPR is enabled
let dataConsent = new ZCRM.Record.Model.Consent();
dataConsent.setConsentRemarks("Approved.");
dataConsent.setConsentThrough("Email");
dataConsent.setContactThroughEmail(true);
dataConsent.setContactThroughSocial(false);
// record1.addKeyValue("Data_Processing_Basis_Details", dataConsent);
//Add Record instance to the array
recordsArray.push(record1);
//Set the array to Records in BodyWrapper instance
request.setData(recordsArray);
let trigger = [];
trigger.push("approval");
trigger.push("workflow");
trigger.push("blueprint");
request.setTrigger(trigger);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
await headerInstance.add(ZCRM.Record.Model.UpdateRecordHeader.X_EXTERNAL, "Leads.External");
//Call updateRecordUsingExternalId method that takes externalFieldValue, moduleAPIName, BodyWrapper instance and headerInstance as parameter.
let response = await recordOperations.updateRecordUsingExternalId(externalFieldValue, moduleAPIName, request, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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 Record Using External ID
class Records
{
/**
* Delete Record
* This method is used to delete a single record of a module 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 be deleted
*/
static async deleteRecordUsingExternalId(moduleAPIName, externalFieldValue) {
//example
//let moduleAPIName = "Leads";
//let externalFieldValue = "34770615177002n";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Possible parameters for Delete Record operation
await paramInstance.add(ZCRM.Record.Model.DeleteRecordUsingExternalIDParam.WF_TRIGGER, true);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
await headerInstance.add(ZCRM.Record.Model.DeleteRecordHeader.X_EXTERNAL, "Leads.External");
//Call deleteRecordUsingExternalId method that takes externalFieldValue, ModuleAPIName, paramInstance and headerInstance as parameter.
let response = await recordOperations.deleteRecordUsingExternalId(externalFieldValue, moduleAPIName, paramInstance, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Get All Records of a Module
class Records
{
/**
* Get Records
* This method is used to get all the records of a module and print the response.
* @param {String} moduleAPIName The API Name of the module to fetch records
*/
static async getRecords(moduleAPIName) {
//example
//let moduleAPIName = "Leads";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Records operation*/
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.APPROVED, "both");
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.CONVERTED, "both");
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.CVID, "34770610087501");
// let ids = ["Last_Name2", "34770614352001"];
// for(let id of ids) {
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.IDS, id);
// }
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.UID, "34770615181008");
// let fieldNames = ["Company", "Email"];
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.FIELDS, fieldNames.toString());
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.SORT_BY, "Email");
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.SORT_ORDER, "desc");
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.PAGE, 1);
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.PER_PAGE, 200);
// let startDateTime = new Date(2020,1,10,10,10,10);
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.STARTDATETIME, startDateTime);
// let endDateTime = new Date(2020,7,10,12,12,12);
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.ENDDATETIME, endDateTime);
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.TERRITORY_ID, "34096430505351");
// await paramInstance.add(ZCRM.Record.Model.GetRecordsParam.INCLUDE_CHILD, "true");
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
/* Possible headers for Get Record operation*/
// await headerInstance.add(ZCRM.Record.Model.GetRecordsHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T00:00:00+05:30"));
// await headerInstance.add(ZCRM.Record.Model.GetRecordsHeader.X_EXTERNAL, "Leads.External");
//Call getRecords method that takes paramInstance, headerInstance and moduleAPIName as parameters
let response = await recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
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 the object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ZCRM.Record.Model.ResponseWrapper) {
//Get the array of obtained Record instances
let records = responseObject.getData();
for (let index = 0; index {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
//To get particular field value
console.log("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
console.log("Record KeyValues: ");
let keyValues = record.getKeyValues();
let keyArray = Array.from(keyValues.keys());
for (let keyName of keyArray) {
let value = keyValues.get(keyName);
if (Array.isArray(value)) {
if (value.length > 0) {
if (value[0] instanceof ZCRM.Record.Model.FileDetails) {
let fileDetails = value;
fileDetails.forEach(fileDetail => {
//Get the Extn of each FileDetails
console.log("Record FileDetails Extn: " + fileDetail.getExtn());
//Get the IsPreviewAvailable of each FileDetails
console.log("Record FileDetails IsPreviewAvailable: " + fileDetail.getIsPreviewAvailable());
//Get the DownloadUrl of each FileDetails
console.log("Record FileDetails DownloadUrl: " + fileDetail.getDownloadUrl());
//Get the DeleteUrl of each FileDetails
console.log("Record FileDetails DeleteUrl: " + fileDetail.getDeleteUrl());
//Get the EntityId of each FileDetails
console.log("Record FileDetails EntityId: " + fileDetail.getEntityId());
//Get the Mode of each FileDetails
console.log("Record FileDetails Mode: " + fileDetail.getMode());
//Get the OriginalSizeByte of each FileDetails
console.log("Record FileDetails OriginalSizeByte: " + fileDetail.getOriginalSizeByte());
//Get the PreviewUrl of each FileDetails
console.log("Record FileDetails PreviewUrl: " + fileDetail.getPreviewUrl());
//Get the FileName of each FileDetails
console.log("Record FileDetails FileName: " + fileDetail.getFileName());
//Get the FileId of each FileDetails
console.log("Record FileDetails FileId: " + fileDetail.getFileId());
//Get the AttachmentId of each FileDetails
console.log("Record FileDetails AttachmentId: " + fileDetail.getAttachmentId());
//Get the FileSize of each FileDetails
console.log("Record FileDetails FileSize: " + fileDetail.getFileSize());
//Get the CreatorId of each FileDetails
console.log("Record FileDetails CreatorId: " + fileDetail.getCreatorId());
//Get the LinkDocs of each FileDetails
console.log("Record FileDetails LinkDocs: " + fileDetail.getLinkDocs());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Reminder) {
let reminders = value;
reminders.forEach(reminder => {
console.log("Reminder Period: " + reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if (value[0] instanceof Choice) {
let choiceArray = value;
console.log(keyName);
console.log("Values");
choiceArray.forEach(eachChoice => {
console.log(eachChoice.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Participants) {
let participants = value;
participants.forEach(participant => {
console.log("Record Participants Name: " + participant.getName());
console.log("Record Participants Invited: " + participant.getInvited());
console.log("Record Participants ID: " + participant.getId());
console.log("Record Participants Type: " + participant.getType());
console.log("Record Participants Participant: " + participant.getParticipant());
console.log("Record Participants Status: " + participant.getStatus());
});
}
else if (value[0] instanceof ZCRM.Record.Model.InventoryLineItems) {
let productDetails = value;
productDetails.forEach(productDetail => {
let lineItemProduct = productDetail.getProduct();;
if (lineItemProduct != null) {
console.log("Record ProductDetails LineItemProduct ProductCode: " + lineItemProduct.getProductCode());
console.log("Record ProductDetails LineItemProduct Currency: " + lineItemProduct.getCurrency());
console.log("Record ProductDetails LineItemProduct Name: " + lineItemProduct.getName());
console.log("Record ProductDetails LineItemProduct Id: " + lineItemProduct.getId());
}
console.log("Record ProductDetails Quantity: " + productDetail.getQuantity());
console.log("Record ProductDetails Discount: " + productDetail.getDiscount());
console.log("Record ProductDetails TotalAfterDiscount: " + productDetail.getTotalAfterDiscount());
console.log("Record ProductDetails NetTotal: " + productDetail.getNetTotal());
if (productDetail.getBook() != null) {
console.log("Record ProductDetails Book: " + productDetail.getBook());
}
console.log("Record ProductDetails Tax: " + productDetail.getTax());
console.log("Record ProductDetails ListPrice: " + productDetail.getListPrice());
console.log("Record ProductDetails UnitPrice: " + productDetail.getUnitPrice());
console.log("Record ProductDetails QuantityInStock: " + productDetail.getQuantityInStock());
console.log("Record ProductDetails Total: " + productDetail.getTotal());
console.log("Record ProductDetails ID: " + productDetail.getId());
console.log("Record ProductDetails ProductDescription: " + productDetail.getProductDescription());
let lineTaxes = productDetail.getLineTax();
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
});
}
else if (value[0] instanceof ZCRM.Tag.Model.Tag) {
let tags = value;
tags.forEach(tag => {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
else if (value[0] instanceof ZCRM.Record.Model.PricingDetails) {
let pricingDetails = value;
pricingDetails.forEach(pricingDetail => {
console.log("Record PricingDetails ToRange: " + pricingDetail.getToRange());
console.log("Record PricingDetails Discount: " + pricingDetail.getDiscount());
console.log("Record PricingDetails ID: " + pricingDetail.getId());
console.log("Record PricingDetails FromRange: " + pricingDetail.getFromRange());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Record) {
let recordArray = value;
recordArray.forEach(record => {
Array.from(record.getKeyValues().keys()).forEach(key => {
console.log(key + ": " + record.getKeyValues().get(key));
});
});
}
else if (value[0] instanceof ZCRM.Record.Model.LineTax) {
let lineTaxes = value;
lineTaxes.forEach(lineTax => {
console.log("Record LineTax Percentage: " + lineTax.getPercentage());
console.log("Record LineTax Name: " + lineTax.getName());
console.log("Record LineTax Id: " + lineTax.getId());
console.log("Record LineTax Value: " + lineTax.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Comment) {
let comments = value;
comments.forEach(comment => {
console.log("Record Comment CommentedBy: " + comment.getCommentedBy());
console.log("Record Comment CommentedTime: " + comment.getCommentedTime());
console.log("Record Comment CommentContent: " + comment.getCommentContent());
console.log("Record Comment Id: " + comment.getId());
});
}
else if (value[0] instanceof ZCRM.Attachment.Model.Attachment) {
let attachments = value;
attachments.forEach(attachment => {
//Get the ID of each attachment
console.log("Record 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("Record Attachment Owner - Name: " + owner.getName());
//Get the ID of the Owner
console.log("Record Attachment Owner ID: " + owner.getId());
//Get the Email of the Owner
console.log("Record Attachment Owner Email: " + owner.getEmail());
}
//Get the modified time of each attachment
console.log("Record Attachment Modified Time: " + attachment.getModifiedTime());
//Get the name of the File
console.log("Record Attachment File Name: " + attachment.getFileName());
//Get the created time of each attachment
console.log("Record Attachment Created Time: " + attachment.getCreatedTime());
//Get the Attachment file size
console.log("Record 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("Record Attachment parent record Name: " + parentId.getKeyValue("name"));
//Get the parent record ID of each attachment
console.log("Record Attachment parent record ID: " + parentId.getId());
}
//Check if the attachment is Editable
console.log("Record Attachment is Editable: " + attachment.getEditable());
//Get the file ID of each attachment
console.log("Record Attachment File ID: " + attachment.getFileId());
//Get the type of each attachment
console.log("Record Attachment File Type: " + attachment.getType());
//Get the seModule of each attachment
console.log("Record 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("Record Attachment Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Record Attachment Modified By User-ID: " + modifiedBy.getId());
//Get the Email of the modifiedBy User
console.log("Record Attachment Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the state of each attachment
console.log("Record 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("Record Attachment Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Record Attachment Created By User-ID: " + createdBy.getId());
//Get the Email of the createdBy User
console.log("Record Attachment Created By User-Email: " + createdBy.getEmail());
}
//Get the linkUrl of each attachment
console.log("Record Attachment LinkUrl: " + attachment.getLinkUrl());
});
}
else {
console.log(keyName);
for (let arrayIndex = 0; arrayIndex {
console.log(key + ": " + value.get(key));
});
}
else {
console.log(keyName + ": " + value);
}
}
}
//Get the obtained Info instance
let info = responseObject.getInfo();
if (info != null) {
if (info.getPerPage() != null) {
//Get the PerPage of the Info
console.log("Record Info PerPage: " + info.getPerPage());
}
if (info.getCount() != null) {
//Get the Count of the Info
console.log("Record Info Count: " + info.getCount());
}
if (info.getPage() != null) {
//Get the Page of the Info
console.log("Record Info Page: " + info.getPage());
}
if (info.getMoreRecords() != null) {
//Get the MoreRecords of the Info
console.log("Record Info MoreRecords: " + info.getMoreRecords());
}
}
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Record.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());
}
}
}
}
}
Create Records
class Records
{
/**
* Create Records
* This method is used to create records of a module and print the response.
* @param {String} moduleAPIName The API Name of the module to create records.
*/
static async createRecords(moduleAPIName) {
//example
//let moduleAPIName = "Leads";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.BodyWrapper();
//Array to hold Record instances
let recordsArray = [];
//Get instance of Record Class
let record = new ZCRM.Record.Model.Record();
/* Value to Record's fields can be provided in any of the following ways */
/*
* Call addFieldValue method that takes two arguments
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "JS SDK");
record.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "JS");
record.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "ZCRM");
record.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record.addKeyValue("Custom_field", "Value");
record.addKeyValue("Custom_field_2", "value");
record.addKeyValue("Date_1", new Date(2020, 10, 20));
record.addKeyValue("Subject", "AutomatedSDK");
let taxName = [new Choice("Vat"), new Choice("Sales Tax")];
record.addKeyValue("Tax", taxName);
record.addKeyValue("Product_Name", "AutomatedSDK");
let fileDetails = [];
let fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c32e98a84dfc2df549e9a46a78e8a27d753");
fileDetails.push(fileDetail);
fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c32e0063e7321b5b4ca878a934519e6cdb2");
fileDetails.push(fileDetail);
fileDetail = new ZCRM.Record.Model.FileDetails();
fileDetail.setFileId("ae9c7cefa418aec1d6a5cc2d9ab35c323daf4780bfe0058133556f155795981f");
fileDetails.push(fileDetail);
record.addKeyValue("File_Upload", fileDetails);
// Used when GDPR is enabled
let dataConsent = new ZCRM.Record.Model.Consent();
dataConsent.setConsentRemarks("Approved.");
dataConsent.setConsentThrough("Email");
dataConsent.setContactThroughEmail(true);
dataConsent.setContactThroughSocial(false);
record.addKeyValue("Data_Processing_Basis_Details", dataConsent);
/** Following methods are being used only by Inventory modules */
let dealName = new ZCRM.Record.Model.Record();
dealName.addFieldValue(ZCRM.Record.Model.Field.Deals.ID, 347706110553012n);
record.addFieldValue(ZCRM.Record.Model.Field.Sales_Orders.DEAL_NAME, dealName);
let contactName = new ZCRM.Record.Model.Record();
contactName.addFieldValue(ZCRM.Record.Model.Field.Contacts.ID, 347706110352015n);
contactName.addFieldValue(ZCRM.Record.Model.Field.Sales_Orders.CONTACT_NAME, contactName);
let accountName = new ZCRM.Record.Model.Record();
accountName.addFieldValue(ZCRM.Record.Model.Field.Accounts.ID, 347706110352011n);
record.addFieldValue(ZCRM.Record.Model.Field.Sales_Orders.ACCOUNT_NAME, accountName);
record.addKeyValue("Discount", 10.5);
let inventoryLineItemArray = [];
let inventoryLineItem = new ZCRM.Record.Model.InventoryLineItems();
let lineItemProduct = new ZCRM.Record.Model.LineItemProduct();
lineItemProduct.setId(347706111082001n);
// lineItemProduct.addKeyValue("Products_External", "ProductExternal");
inventoryLineItem.setProduct(lineItemProduct);
inventoryLineItem.setQuantity(3);
inventoryLineItem.setProductDescription("productDescription");
inventoryLineItem.setListPrice(10.0);
inventoryLineItem.setDiscount("5.90");
let productLineTaxes = [];
let productLineTax = new ZCRM.Record.Model.LineTax();
productLineTax.setName("MyTax1134");
productLineTax.setPercentage(20.0);
productLineTaxes.push(productLineTax);
inventoryLineItem.setLineTax(productLineTaxes);
inventoryLineItemArray.push(inventoryLineItem);
record.addKeyValue("Product_Details", inventoryLineItemArray);
let lineTaxes = [];
let lineTax = new ZCRM.Record.Model.LineTax();
lineTax.setName("MyTax1134");
lineTax.setPercentage(20.0);
lineTaxes.push(lineTax);
record.addKeyValue("$line_tax", lineTaxes);
/** End Inventory **/
/** Following methods are being used only by Activity modules */
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.DESCRIPTION, "New Task");
record.addKeyValue("Currency", new Choice("INR"));
let remindAt = new ZCRM.Record.Model.RemindAt();
remindAt.setAlarm("FREQ=NONE;ACTION=EMAILANDPOPUP;TRIGGER=DATE-TIME:2021-07-03T12:30:00+05:30");
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.REMIND_AT, remindAt);
let whoId = new ZCRM.Record.Model.Record();
whoId.setId(347706110938005n);
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.WHO_ID, whoId);
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.STATUS, new Choice("Waiting for Input"));
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.DUE_DATE, new Date(2020, 10, 10));
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.PRIORITY, new Choice("High"));
let whatId = new ZCRM.Record.Model.Record();
whatId.setId(347706110938001n);
record.addFieldValue(ZCRM.Record.Model.Field.Tasks.WHAT_ID, whatId);
record.addKeyValue("$se_module", "Accounts");
/** Recurring Activity can be provided in any activity module*/
let recurringActivity = new ZCRM.Record.Model.RecurringActivity();
recurringActivity.setRrule("FREQ=DAILY;INTERVAL=10;UNTIL=2020-08-14;DTSTART=2020-07-03");
record.addFieldValue(ZCRM.Record.Model.Field.Events.RECURRING_ACTIVITY, recurringActivity);
record.addFieldValue(ZCRM.Record.Model.Field.Events.DESCRIPTION, "My Event");
let startDateTime = new Date('October 15, 2020 05:35:32');
record.addFieldValue(ZCRM.Record.Model.Field.Events.START_DATETIME, startDateTime);
let participantsArray = [];
let participant = new ZCRM.Record.Model.Participants();
participant.setParticipant("test@gmail.com");
participant.setType("email");
participantsArray.push(participant);
participant = new ZCRM.Record.Model.Participants();
participant.setParticipant("347706110938005");
participant.setType("contact");
participantsArray.push(participant);
record.addFieldValue(ZCRM.Record.Model.Field.Events.PARTICIPANTS, participantsArray);
record.addKeyValue("$send_notification", true);
record.addFieldValue(ZCRM.Record.Model.Field.Events.EVENT_TITLE, "New Automated Event");
let endDateTime = new Date('November 15, 2020 05:35:32');
record.addFieldValue(ZCRM.Record.Model.Field.Events.END_DATETIME, endDateTime);
let remindAt1 = new Date('October 15, 2020 04:35:32');
record.addFieldValue(ZCRM.Record.Model.Field.Events.REMIND_AT, remindAt1);
record.addFieldValue(ZCRM.Record.Model.Field.Events.CHECK_IN_STATUS, "PLANNED");
whatId = new ZCRM.Record.Model.Record();
whatId.setId(347706111074008n);
record.addFieldValue(ZCRM.Record.Model.Field.Events.WHAT_ID, whatId);
record.addKeyValue("$se_module", "Leads");
/** End Activity **/
/** Following methods are being used only by Price_Books module */
let pricingDetailsArray = [];
let pricingDetail = new ZCRM.Record.Model.PricingDetails();
pricingDetail.setFromRange(1.0);
pricingDetail.setToRange(5.0);
pricingDetail.setDiscount(2.0);
pricingDetailsArray.push(pricingDetail);
pricingDetail = new ZCRM.Record.Model.PricingDetails();
pricingDetail.addKeyValue("from_range", 6.0);
pricingDetail.addKeyValue("to_range", 11.0);
pricingDetail.addKeyValue("discount", 3.0);
pricingDetailsArray.push(pricingDetail);
record.addFieldValue(ZCRM.Record.Model.Field.Price_Books.PRICING_DETAILS, pricingDetailsArray);
record.addKeyValue("Email", "abc@zoho.com");
record.addFieldValue(ZCRM.Record.Model.Field.Price_Books.DESCRIPTION, "TEST");
record.addFieldValue(ZCRM.Record.Model.Field.Price_Books.PRICE_BOOK_NAME, "book_name");
record.addFieldValue(ZCRM.Record.Model.Field.Price_Books.PRICING_MODEL, new Choice("Flat"));
/** End of Price_Books */
let tagsArray = [];
let tag = new ZCRM.Tag.Model.Tag();
tag.setName("Testtask");
tagsArray.push(tag);
record.setTag(tagsArray);
//Add Record instance to the array
recordsArray.push(record);
//Set the array to data in BodyWrapper instance
request.setData(recordsArray);
let trigger = [];
trigger.push("approval");
trigger.push("workflow");
trigger.push("blueprint");
//Set the array containing the trigger operations to be run
request.setTrigger(trigger);
let larId = "34096432157065";
//Set the larId
request.setLarId(larId);
let process = ["review_process"];
//Set the array containing the process to be run
request.setProcess(process);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
// await headerInstance.add(ZCRM.Record.Model.CreateRecordsHeader.X_EXTERNAL, "Quotes.Product_Details.product.Products_External");
//Call createRecords method that takes moduleAPIName, BodyWrapper instance and headerInstance as parameters
let response = await recordOperations.createRecords(moduleAPIName, request, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Update Records
class Records
{
/**
* Update Records
* This method is used to update the records of a module with ID and print the response.
* @param {String} moduleAPIName The API Name of the module to update records.
*/
static async updateRecords(moduleAPIName) {
//example
//let moduleAPIName = "Leads";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.BodyWrapper();
//Array to hold Record instances
let recordsArray = [];
let record1 = new ZCRM.Record.Model.Record();
//ID of the record to be updated
record1.setId(347706111074008n);
/*
* Call addFieldValue method that takes two arguments
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "First Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "KKRNP");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record1.addKeyValue("Custom_field", "Custom val");
record1.addKeyValue("Custom_field_2", 10);
//Used when GDPR is enabled
let dataConsent = new ZCRM.Record.Model.Consent();
dataConsent.setConsentRemarks("Approved.");
dataConsent.setConsentThrough("Email");
dataConsent.setContactThroughEmail(true);
dataConsent.setContactThroughSocial(false);
record1.addKeyValue("Data_Processing_Basis_Details", dataConsent);
recordsArray.push(record1);
let record2 = new ZCRM.Record.Model.Record();
//ID of the record to be updated
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.ID, 34096431881002n);
/*
* Call addFieldValue method that takes two arguments
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "First Name");
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "KKRNP");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record2.addKeyValue("Custom_field", "Value");
record2.addKeyValue("Custom_field_2", "value");
//Add Record instance to the array
recordsArray.push(record2);
//Set the array to data in BodyWrapper instance
request.setData(recordsArray);
let trigger = [];
trigger.push("approval");
trigger.push("workflow");
trigger.push("blueprint");
//Set the array containing the trigger operations to be run
request.setTrigger(trigger);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
// await headerInstance.add(ZCRM.Record.Model.UpdateRecordsHeader.X_EXTERNAL, "Leads.External");
//Call updateRecords method that takes moduleAPIName, BodyWrapper instance and headerInstance as parameter.
let response = await recordOperations.updateRecords(moduleAPIName, request, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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 Records
class Records
{
/**
* Delete Records
* This method is used to delete records of a module and print the response.
* @param {String} moduleAPIName The API Name of the module to delete records.
* @param {Array} recordIds The array of record IDs to be deleted
*/
static async deleteRecords(moduleAPIName, recordIds) {
//example
//let moduleAPIName = "Contacts";
// let recordIds = [34096430756050n, 34096430729017n, 34096430729009n];
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Delete Records operation */
for (let recordId of recordIds) {
await paramInstance.add(ZCRM.Record.Model.DeleteRecordsParam.IDS, recordId);
}
await paramInstance.add(ZCRM.Record.Model.DeleteRecordsParam.WF_TRIGGER, true);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
// await headerInstance.add(ZCRM.Record.Model.DeleteRecordsHeader.X_EXTERNAL, "Leads.External");
//Call deleteRecords method that takes moduleAPIName, paramInstance and headerInstance as parameter.
let response = await recordOperations.deleteRecords(moduleAPIName, paramInstance, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Upsert Records
class Records
{
/**
* Upsert Records
* This method is used to Upsert records of a module and print the response.
* @param {String} moduleAPIName The API Name of the module to upsert records.
*/
static async upsertRecords(moduleAPIName) {
//example
//let moduleAPIName = "Leads";
//Get instance of RecordOperations Class that takes moduleAPIName as parameter
let recordOperations = new ZCRM.Record.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.BodyWrapper();
//Array to hold Record instances
let recordsArray = [];
//Get instance of Record Class
let record1 = new ZCRM.Record.Model.Record();
/*
* Call addFieldValue method that takes two arguments
* Import the "zcrmsdk/core/com/zoho/crm/api/record/field" file
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "First Name");
record1.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "KKRNP");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record1.addKeyValue("Custom_field", "Custom val");
record1.addKeyValue("Custom_field_2", 10);
//Add the record to array
recordsArray.push(record1);
let record2 = new ZCRM.Record.Model.Record();
/*
* Call addFieldValue method that takes two arguments
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "City");
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.LAST_NAME, "Last Name");
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.FIRST_NAME, "First Name");
record2.addFieldValue(ZCRM.Record.Model.Field.Leads.COMPANY, "KKRNP");
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record2.addKeyValue("Custom_field", "Value");
record2.addKeyValue("Custom_field_2", "value");
//Add the record to array
recordsArray.push(record2);
//Set the array to data in BodyWrapper instance
request.setData(recordsArray);
let duplicateCheckFields = ["City", "Last_Name", "First_Name"];
//Set the array containing duplicate check fiels to BodyWrapper instance
request.setDuplicateCheckFields(duplicateCheckFields);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
// await headerInstance.add(ZCRM.Record.Model.UpsertRecordsHeader.X_EXTERNAL, "Leads.External");
//Call upsertRecords method that takes moduleAPIName, BodyWrapper instance and headerInstance as parameter.
let response = await recordOperations.upsertRecords(moduleAPIName, request, headerInstance);
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.Record.Model.ActionWrapper) {
//Get the array of obtained ActionResponse instances
let actionResponses = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if (actionResponse instanceof ZCRM.Record.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));
});
}
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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.Record.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());
}
}
}
}
}
Get Deleted Records
class Records
{
/**
* Get Deleted Records
* This method is used to get the deleted records of a module and print the response.
* @param {String} moduleAPIName The API Name of the module to get the deleted records.
*/
static async getDeletedRecords(moduleAPIName) {
//example
//let moduleAPIName = "Deals";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Deleted Records operation */
//can be all/recycle/permanent
await paramInstance.add(ZCRM.Record.Model.GetDeletedRecordsParam.TYPE, "permanent");
await paramInstance.add(ZCRM.Record.Model.GetDeletedRecordsParam.PAGE, 1);
await paramInstance.add(ZCRM.Record.Model.GetDeletedRecordsParam.PER_PAGE, 200);
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
/* Possible headers for Get Deleted Records operation */
await headerInstance.add(ZCRM.Record.Model.GetDeletedRecordsHeader.IF_MODIFIED_SINCE, new Date('January 15, 2020 10:35:32'));
//Call getDeletedRecords method that takes paramInstance, headerInstance and moduleAPIName as parameter
let response = await recordOperations.getDeletedRecords(moduleAPIName, paramInstance, headerInstance);
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 the object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected DeletedRecordsWrapper instance is received
if (responseObject instanceof ZCRM.Record.Model.DeletedRecordsWrapper) {
//Get the array of obtained DeletedRecord instances
let deletedRecords = responseObject.getData();
deletedRecords.forEach(deletedRecord => {
//Get the deletedBy User instance of each DeletedRecord
let deletedBy = deletedRecord.getDeletedBy();
//Check if deletedBy is not null
if (deletedBy != null) {
//Get the name of the deletedBy User
console.log("DeletedRecord Deleted By User-Name: " + deletedBy.getName());
//Get the ID of the deletedBy User
console.log("DeletedRecord Deleted By User-ID: " + deletedBy.getId());
}
//Get the ID of each DeletedRecord
console.log("DeletedRecord ID: " + deletedRecord.getId());
//Get the DisplayName of each DeletedRecord
console.log("DeletedRecord DisplayName: " + deletedRecord.getDisplayName());
//Get the Type of each DeletedRecord
console.log("DeletedRecord Type: " + deletedRecord.getType());
//Get the createdBy User instance of each DeletedRecord
let createdBy = deletedRecord.getCreatedBy();
//Check if createdBy is not null
if (createdBy != null) {
//Get the name of the createdBy User
console.log("DeletedRecord Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("DeletedRecord Created By User-ID: " + createdBy.getId());
}
//Get the DeletedTime of each DeletedRecord
console.log("DeletedRecord DeletedTime: " + deletedRecord.getDeletedTime());
});
//Get the obtained Info object
let info = responseObject.getInfo();
if (info != null) {
if (info.getPerPage() != null) {
//Get the PerPage of the Info
console.log("Record Info PerPage: " + info.getPerPage());
}
if (info.getCount() != null) {
//Get the Count of the Info
console.log("Record Info Count: " + info.getCount());
}
if (info.getPage() != null) {
//Get the Page of the Info
console.log("Record Info Page: " + info.getPage());
}
if (info.getMoreRecords() != null) {
//Get the MoreRecords of the Info
console.log("Record Info MoreRecords: " + info.getMoreRecords());
}
}
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Record.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());
}
}
}
}
}
Search Records
class Records
{
/**
* Search Records
* This method is used to search records of a module and print the response.
* @param {String} moduleAPIName The API Name of the module to search records.
*/
static async searchRecords(moduleAPIName) {
//example
//let moduleAPIName = "Price_Books";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Search Records operation */
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.EMAIL, "abc@zoho.com");
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.PHONE, "234567890");
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.WORD, "First Name Last Name");
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.CONVERTED, "both");
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.APPROVED, "both");
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.PAGE, 1);
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.PER_PAGE, 2);
//Encoding must be done for parentheses or comma
await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.CRITERIA, "((Last_Name:starts_with:Last Name) or (Company:starts_with:fasf\\(123\\) K))");
// await paramInstance.add(ZCRM.Record.Model.SearchRecordsParam.CRITERIA, "(External:equals:usercontact2)");
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
// headerInstance.add(ZCRM.Record.Model.SearchRecordsHeader.X_EXTERNAL, "Leads.External");
//Call searchRecords method that takes moduleAPIName, ParameterMap Instance and headerInstance as parameter
let response = await recordOperations.searchRecords(moduleAPIName, paramInstance, headerInstance);
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 the object from response
let responseObject = response.getObject();
if (responseObject != null) {
if (responseObject instanceof ZCRM.Record.Model.ResponseWrapper) {
//Get the array of obtained Record instances
let records = responseObject.getData();
for (let index = 0; index {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
//To get particular field value
console.log("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
console.log("Record KeyValues: ");
let keyValues = record.getKeyValues();
let keyArray = Array.from(keyValues.keys());
for (let keyIndex = 0; keyIndex 0) {
if (value[0] instanceof ZCRM.Record.Model.FileDetails) {
let fileDetails = value;
fileDetails.forEach(fileDetail => {
//Get the Extn of each FileDetails
console.log("Record FileDetails Extn: " + fileDetail.getExtn());
//Get the IsPreviewAvailable of each FileDetails
console.log("Record FileDetails IsPreviewAvailable: " + fileDetail.getIsPreviewAvailable());
//Get the DownloadUrl of each FileDetails
console.log("Record FileDetails DownloadUrl: " + fileDetail.getDownloadUrl());
//Get the DeleteUrl of each FileDetails
console.log("Record FileDetails DeleteUrl: " + fileDetail.getDeleteUrl());
//Get the EntityId of each FileDetails
console.log("Record FileDetails EntityId: " + fileDetail.getEntityId());
//Get the Mode of each FileDetails
console.log("Record FileDetails Mode: " + fileDetail.getMode());
//Get the OriginalSizeByte of each FileDetails
console.log("Record FileDetails OriginalSizeByte: " + fileDetail.getOriginalSizeByte());
//Get the PreviewUrl of each FileDetails
console.log("Record FileDetails PreviewUrl: " + fileDetail.getPreviewUrl());
//Get the FileName of each FileDetails
console.log("Record FileDetails FileName: " + fileDetail.getFileName());
//Get the FileId of each FileDetails
console.log("Record FileDetails FileId: " + fileDetail.getFileId());
//Get the AttachmentId of each FileDetails
console.log("Record FileDetails AttachmentId: " + fileDetail.getAttachmentId());
//Get the FileSize of each FileDetails
console.log("Record FileDetails FileSize: " + fileDetail.getFileSize());
//Get the CreatorId of each FileDetails
console.log("Record FileDetails CreatorId: " + fileDetail.getCreatorId());
//Get the LinkDocs of each FileDetails
console.log("Record FileDetails LinkDocs: " + fileDetail.getLinkDocs());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Reminder) {
let reminders = value;
reminders.forEach(reminder => {
console.log("Reminder Period: " + reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Participants) {
let participants = value;
participants.forEach(participant => {
console.log("Record Participants Name: " + participant.getName());
console.log("Record Participants Invited: " + participant.getInvited());
console.log("Record Participants ID: " + participant.getId());
console.log("Record Participants Type: " + participant.getType());
console.log("Record Participants Participant: " + participant.getParticipant());
console.log("Record Participants Status: " + participant.getStatus());
});
}
else if (value[0] instanceof Choice) {
let choiceArray = value;
console.log(keyName);
console.log("Values");
choiceArray.forEach(eachChoice => {
console.log(eachChoice.getValue());
});
}
else if (value[0] instanceof ZCRM.Record.Model.InventoryLineItems) {
let productDetails = value;
productDetails.forEach(productDetail => {
let lineItemProduct = productDetail.getProduct();;
if (lineItemProduct != null) {
console.log("Record ProductDetails LineItemProduct ProductCode: " + lineItemProduct.getProductCode());
console.log("Record ProductDetails LineItemProduct Currency: " + lineItemProduct.getCurrency());
console.log("Record ProductDetails LineItemProduct Name: " + lineItemProduct.getName());
console.log("Record ProductDetails LineItemProduct Id: " + lineItemProduct.getId());
}
console.log("Record ProductDetails Quantity: " + productDetail.getQuantity());
console.log("Record ProductDetails Discount: " + productDetail.getDiscount());
console.log("Record ProductDetails TotalAfterDiscount: " + productDetail.getTotalAfterDiscount());
console.log("Record ProductDetails NetTotal: " + productDetail.getNetTotal());
if (productDetail.getBook() != null) {
console.log("Record ProductDetails Book: " + productDetail.getBook());
}
console.log("Record ProductDetails Tax: " + productDetail.getTax());
console.log("Record ProductDetails ListPrice: " + productDetail.getListPrice());
console.log("Record ProductDetails UnitPrice: " + productDetail.getUnitPrice());
console.log("Record ProductDetails QuantityInStock: " + productDetail.getQuantityInStock());
console.log("Record ProductDetails Total: " + productDetail.getTotal());
console.log("Record ProductDetails ID: " + productDetail.getId());
console.log("Record ProductDetails ProductDescription: " + productDetail.getProductDescription());
let lineTaxes = productDetail.getLineTax();
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
});
}
else if (value[0] instanceof ZCRM.Tag.Model.Tag) {
let tags = value;
tags.forEach(tag => {
//Get the Name of each Tag
console.log("Record Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("Record Tag ID: " + tag.getId());
});
}
else if (value[0] instanceof ZCRM.Record.Model.PricingDetails) {
let pricingDetails = value;
pricingDetails.forEach(pricingDetail => {
console.log("Record PricingDetails ToRange: " + pricingDetail.getToRange());
console.log("Record PricingDetails Discount: " + pricingDetail.getDiscount());
console.log("Record PricingDetails ID: " + pricingDetail.getId());
console.log("Record PricingDetails FromRange: " + pricingDetail.getFromRange());
});
}
else if (value[0] instanceof ZCRM.Record.Model.Record) {
let recordArray = value;
recordArray.forEach(record => {
Array.from(record.getKeyValues().keys()).forEach(key => {
console.log(key + ": " + record.getKeyValues().get(key));
});
});
}
else if (value[0] instanceof ZCRM.Record.Model.LineTax) {
let lineTaxes = value;
lineTaxes.forEach(lineTax => {
console.log("Record ProductDetails LineTax Percentage: " + lineTax.getPercentage());
console.log("Record ProductDetails LineTax Name: " + lineTax.getName());
console.log("Record ProductDetails LineTax Id: " + lineTax.getId());
console.log("Record ProductDetails LineTax Value: " + lineTax.getValue());
});
}
else {
console.log(keyName + ": " + value);
}
}
}
else if (value instanceof ZCRM.Layout.Model.Layout) {
console.log(keyName + " ID: " + value.getId());
console.log(keyName + " Name: " + value.getName());
}
else if (value instanceof ZCRM.User.Model.User) {
console.log("Record " + keyName + " User-ID: " + value.getId());
console.log("Record " + keyName + " User-Name: " + value.getName());
console.log("Record " + keyName + " User-Email: " + value.getEmail());
}
else if (value instanceof ZCRM.Record.Model.Record) {
console.log(keyName + " Record ID: " + value.getId());
console.log(keyName + " Record Name: " + value.getKeyValue("name"));
}
else if (value instanceof Choice) {
console.log(keyName + ": " + value.getValue());
}
else if (value instanceof ZCRM.Record.Model.RemindAt) {
console.log(keyName + ": " + value.getAlarm());
}
else if (value instanceof ZCRM.Record.Model.RecurringActivity) {
console.log(keyName);
console.log("RRULE: " + value.getRrule());
}
else if (value instanceof ZCRM.Record.Model.Consent) {
console.log("Record Consent ID: " + value.getId());
//Get the Owner User instance of the Consent
let owner = value.getOwner();
//Check if owner is not null
if (owner != null) {
//Get the name of the owner User
console.log("Record Consent Owner Name: " + owner.getName());
//Get the ID of the owner User
console.log("Record Consent Owner ID: " + owner.getId());
//Get the Email of the owner User
console.log("Record Consent Owner Email: " + owner.getEmail());
}
let consentCreatedBy = value.getCreatedBy();
//Check if createdBy is not null
if (consentCreatedBy != null) {
//Get the name of the CreatedBy User
console.log("Record Consent CreatedBy Name: " + consentCreatedBy.getName());
//Get the ID of the CreatedBy User
console.log("Record Consent CreatedBy ID: " + consentCreatedBy.getId());
//Get the Email of the CreatedBy User
console.log("Record Consent CreatedBy Email: " + consentCreatedBy.getEmail());
}
let consentModifiedBy = value.getModifiedBy();
//Check if createdBy is not null
if (consentModifiedBy != null) {
//Get the name of the ModifiedBy User
console.log("Record Consent ModifiedBy Name: " + consentModifiedBy.getName());
//Get the ID of the ModifiedBy User
console.log("Record Consent ModifiedBy ID: " + consentModifiedBy.getId());
//Get the Email of the ModifiedBy User
console.log("Record Consent ModifiedBy Email: " + consentModifiedBy.getEmail());
}
console.log("Record Consent CreatedTime: " + value.getCreatedTime());
console.log("Record Consent ModifiedTime: " + value.getModifiedTime());
console.log("Record Consent ContactThroughEmail: " + value.getContactThroughEmail());
console.log("Record Consent ContactThroughSocial: " + value.getContactThroughSocial());
console.log("Record Consent ContactThroughSurvey: " + value.getContactThroughSurvey());
console.log("Record Consent ContactThroughPhone: " + value.getContactThroughPhone());
console.log("Record Consent MailSentTime: " + value.getMailSentTime());
console.log("Record Consent ConsentDate: " + value.getConsentDate());
console.log("Record Consent ConsentRemarks: " + value.getConsentRemarks());
console.log("Record Consent ConsentThrough: " + value.getConsentThrough());
console.log("Record Consent DataProcessingBasis: " + value.getDataProcessingBasis());
//To get custom values
console.log("Record Consent Lawful Reason: " + value.getKeyValue("Lawful_Reason"));
}
else if (value instanceof Map) {
console.log(keyName);
Array.from(value.keys()).forEach(key => {
console.log(key + ": " + value.get(key));
});
}
else {
console.log(keyName + ": " + value);
}
}
}
//Get the obtained Info object
let info = responseObject.getInfo();
if (info != null) {
if (info.getPerPage() != null) {
//Get the PerPage of the Info
console.log("Record Info PerPage: " + info.getPerPage());
}
if (info.getCount() != null) {
//Get the Count of the Info
console.log("Record Info Count: " + info.getCount());
}
if (info.getPage() != null) {
//Get the Page of the Info
console.log("Record Info Page: " + info.getPage());
}
if (info.getMoreRecords() != null) {
//Get the MoreRecords of the Info
console.log("Record Info MoreRecords: " + info.getMoreRecords());
}
}
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Record.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());
}
}
}
}
}
Convert a Lead
class Records
{
/**
* Convert Lead
* This method is used to Convert a Lead record and print the response.
* @param {BigInt} leadId The ID of the Lead to be converted.
*/
static async convertLead(leadId) {
//example
//let leadId = 34096432034003n;
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of ConvertBodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.ConvertBodyWrapper();
//Array to hold LeadConverter instances
let data = [];
//Get instance of LeadConverter Class
let record = new ZCRM.Record.Model.LeadConverter();
record.setOverwrite(true);
record.setNotifyLeadOwner(true);
record.setNotifyNewEntityOwner(true);
record.setAccounts("34096430692007");
record.setContacts("34096430836001");
record.setAssignTo("34096430302031");
let deals = new ZCRM.Record.Model.Record();
/*
* Call addFieldValue method that takes two arguments
* Import the "zcrmsdk/core/com/zoho/crm/api/record/field" file
* 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list.
* 2 -> Value
*/
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.DEAL_NAME, "deal_name");
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.DESCRIPTION, "deals description");
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.CLOSING_DATE, new Date(2021, 2, 13));
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.STAGE, new Choice("Closed Won"));
deals.addFieldValue(ZCRM.Record.Model.Field.Deals.AMOUNT, 50.7);
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
deals.addKeyValue("Custom_field", "Value");
deals.addKeyValue("Custom_field_2", "value");
let tagArray = [];
let tag = new ZCRM.Tag.Model.Tag();
tag.setName("Converted");
tagArray.push(tag);
deals.setTag(tagArray);
//Set the Deal record to deals in LeadConverter instance
record.setDeals(deals);
//Add the instance to array
data.push(record);
//Set the array to data ConvertBodyWrapper instance
request.setData(data);
//Call convertLead method that takes ConvertBodyWrapper instance and leadId as parameter
let response = await recordOperations.convertLead(leadId, request);
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 ResponseWrapper instance is received
if (responseObject instanceof ZCRM.Record.Model.ConvertActionWrapper) {
//Get the array of ConvertActionResponses from object
let convertActionResponses = responseObject.getData();
convertActionResponses.forEach(convertActionResponse => {
//Check if the request is successful
if (convertActionResponse instanceof ZCRM.Record.Model.SuccessfulConvert) {
//Get the Accounts ID of Record
console.log("LeadConvert Accounts ID: " + convertActionResponse.getAccounts());
//Get the Contacts ID of Record
console.log("LeadConvert Contacts ID: " + convertActionResponse.getContacts());
//Get the Deals ID of Record
console.log("LeadConvert Deals ID: " + convertActionResponse.getDeals());
}
//Check if the request returned an exception
else if (convertActionResponse instanceof ZCRM.Record.Model.APIException) {
//Get the Status
console.log("Status: " + convertActionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + convertActionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = convertActionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + convertActionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if (actionResponse instanceof ZCRM.Record.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());
}
}
}
}
}
Get a Record Photo
class Records
{
/**
* This method is used to download a photo associated with a module.
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record
*/
static async getPhoto(moduleAPIName, recordId) {
//example
// let moduleAPIName = "Contacts";
// let recordId = 34096432034003n;
// let destinationFolder = "/Users/user-name/Documents";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Call getPhoto method that takes moduleAPIName and recordId as parameters
let response = await recordOperations.getPhoto(recordId, moduleAPIName);
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 FileBodyWrapper instance is received
if (responseObject instanceof ZCRM.Record.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.Record.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 a Photo to a Record
class Records
{
/**
* This method is used to attach a photo to a record. You must include the file in the request
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record
*/
static async uploadPhoto(moduleAPIName, recordId) {
//example
//let moduleAPIName = "Leads";
//let recordId = 34770615177002n;
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of FileBodyWrapper class that will contain the request file
let request = new ZCRM.Record.Model.FileBodyWrapper();
/** StreamWrapper can be initialized in any of the following ways */
var filesToLoad = document.getElementById("uploadphoto").files;
var file = filesToLoad[0];
/**
* param 1 -> fileName
* param 2 -> Read Stream
*/
let streamWrapper = new StreamWrapper.Model.StreamWrapper(null, file);
/**
* param 1 -> fileName
* param 2 -> Read Stream
* param 3 -> Absolute File Path of the file to be attached
*/
// let streamWrapper = new StreamWrapper(null, null, absoluteFilePath);
//Set file to the FileBodyWrapper instance
request.setFile(streamWrapper);
//Call uploadPhoto method that takes FileBodyWrapper instance, moduleAPIName and recordId as parameter
let response = await recordOperations.uploadPhoto(recordId, moduleAPIName, request);
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 the request is successful
if (responseObject instanceof ZCRM.Record.Model.SuccessResponse) {
//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));
});
}
console.log("Message: " + responseObject.getMessage().getValue());
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Record.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 the Photo of a Record
class Records
{
/**
* This method is used to delete a photo from a record in a module.
* @param {String} moduleAPIName The API Name of the record's module
* @param {BigInt} recordId The ID of the record to delete photo
*/
static async deletePhoto(moduleAPIName, recordId) {
//example
//let moduleAPIName = "Leads";
//let recordId = 34770615177002n;
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Call deletePhoto method that takes moduleAPIName and recordId as parameter
let response = await recordOperations.deletePhoto(recordId, moduleAPIName);
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 the request is successful
if (responseObject instanceof ZCRM.Record.Model.SuccessResponse) {
//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));
});
}
console.log("Message: " + responseObject.getMessage().getValue());
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Record.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());
}
}
}
}
}
Mass Update Records
class Records
{
/**
* This method is used to update the values of specific fields for multiple records and print the response.
* @param {String} moduleAPIName The API Name of the module to mass update records.
*/
static async massUpdateRecords(moduleAPIName) {
//example
//let moduleAPIName = "Leads";
//Get instance of RecordOperations Class
let recordOperations = new ZCRM.Record.Operations();
//Get instance of MassUpdateBodyWrapper Class that will contain the request body
let request = new ZCRM.Record.Model.MassUpdateBodyWrapper();
//Array to hold Record instances
let recordsArray = [];
//Get instance of Record Class
let record = new ZCRM.Record.Model.Record();
record.addFieldValue(ZCRM.Record.Model.Field.Leads.CITY, "Chennai");
//Add the record instance to array
recordsArray.push(record);
//Set the array to data in MassUpdateBodyWrapper instance
request.setData(recordsArray);
//Set the cvid to MassUpdateBodyWrapper instance
// request.setCvid("34096430087501");
let ids = ["347706111073003"];
//Set the array of IDs to MassUpdateBodyWrapper instance
request.setIds(ids);
//Set the value to over write
request.setOverWrite(true);
//Get instance of Territory Class
let territory = new ZCRM.Record.Model.Territory();
//Set ID to Territory
territory.setId(34096430505351n);
territory.setIncludeChild(true);
// request.setTerritory(territory);
//Call massUpdateRecords method that takes MassUpdateBodyWrapper instance, ModuleAPIName as parameter.
let response = await recordOperations.massUpdateRecords(moduleAPIName, request);
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 MassUpdateActionWrapper instance is received
if (responseObject instanceof ZCRM.Record.Model.MassUpdateActionWrapper) {
//Get the array of MassUpdate ActionResponses
let massUpdateActionResponses = responseObject.getData();
massUpdateActionResponses.forEach(massUpdateActionResponse => {
//Check if the request is successful
if (massUpdateActionResponse instanceof ZCRM.Record.Model.MassUpdateSuccessResponse) {
//Get the Status
console.log("Status: " + massUpdateActionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + massUpdateActionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = massUpdateActionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + massUpdateActionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if (massUpdateActionResponse instanceof ZCRM.Record.Model.APIException) {
//Get the Status
console.log("Status: " + massUpdateActionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + massUpdateActionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details = massUpdateActionResponse.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + massUpdateActionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Record.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());
}
}
}
}
}
Get the Status of Mass Update