Node JS SDK Samples - Custom View Operations
Get Custom views
const { CustomViewsOperations, GetCustomViewsParam } = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/custom_views/custom_views_operations");
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/custom_views/response_wrapper").ResponseWrapper;
const APIException = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/custom_views/api_exception").APIException;
const ParameterMap = require("@zohocrm/nodejs-sdk-2.1/routes/parameter_map").ParameterMap;
class CustomView{
/**
* Get CustomViews
* This method is used to get the custom views data of a particular module.
* Specify the module name in your API request whose custom view data you want to retrieve.
* @param {String} moduleAPIName Specify the API name of the required module.
*/
static async getCustomViews(moduleAPIName) {
//example
//let moduleAPIName = "module_api_name";
//Get instance of CustomViewOperations Class that takes moduleAPIName as parameter
let customViewsOperations = new CustomViewsOperations(moduleAPIName);
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Possible parameters of Get CustomViews operation
await paramInstance.add(GetCustomViewsParam.PAGE, 1);
await paramInstance.add(GetCustomViewsParam.PER_PAGE, 20);
//Call getCustomViews method that takes ParameterMap instance as parameter
let response = await customViewsOperations.getCustomViews(paramInstance);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ResponseWrapper) {
//Get the array of obtained CustomView instances
let customViews = responseObject.getCustomViews();
customViews.forEach(customView => {
//Get the DisplayValue of each CustomView
console.log("CustomView DisplayValue: " + customView.getDisplayValue());
//Get the Default of each CustomView
console.log("CustomView Default: " + customView.getDefault().toString());
//Get the ModifiedTime of each CustomView
console.log("CustomView ModifiedTime: " + customView.getModifiedTime());
//Get the SystemName of each CustomView
console.log("CustomView SystemName: " + customView.getSystemName());
//Get the Name of each CustomView
console.log("CustomView Name: " + customView.getName());
//Get the SystemDefined of each CustomView
console.log("CustomView SystemDefined: " + customView.getSystemDefined().toString());
//Get the modifiedBy User instance of each CustomView
let modifiedBy = customView.getModifiedBy();
//Check if modifiedBy is not null
if (modifiedBy != null) {
//Get the Name of the modifiedBy User
console.log("CustomView Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("CustomView Modified By User-ID: " + modifiedBy.getId());
}
//Get the ID of each CustomView
console.log("CustomView ID: " + customView.getId());
//Get the Category of each CustomView
console.log("CustomView Category: " + customView.getCategory());
//Get the LastAccessedTime of each CustomView
console.log("CustomView LastAccessedTime: " + customView.getLastAccessedTime());
if (customView.getFavorite() != null) {
//Get the Favorite of each CustomView
console.log("CustomView Favorite: " + customView.getFavorite().toString());
}
//Get the createdBy User instance of each CustomView
let createdBy = customView.getCreatedBy();
//Check if createdBy is not null
if (createdBy != null) {
//Get the Name of the createdBy User
console.log("CustomView Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("CustomView Created By User-ID: " + createdBy.getId());
}
});
//Get the obtained Info instance from object
let info = responseObject.getInfo();
//Check if info is not null
if (info != null) {
console.log("CustomView Info");
if (info.getPerPage() != null) {
//Get the PerPage from Info
console.log("PerPage: " + info.getPerPage().toString());
}
if (info.getDefault() != null) {
//Get the Default from Info
console.log("Default: " + info.getDefault());
}
if (info.getCount() != null) {
//Get the Count from Info
console.log("Count: " + info.getCount().toString());
}
//Get the Translation instance from Info
let translation = info.getTranslation();
if (translation != null) {
console.log("Translation details");
//Get the PublicViews of the Translation
console.log("PublicViews: " + translation.getPublicViews());
//Get the OtherUsersViews of the Translation
console.log("OtherUsersViews: " + translation.getOtherUsersViews());
//Get the SharedWithMe of the Translation
console.log("SharedWithMe: " + translation.getSharedWithMe());
//Get the CreatedByMe of the Translation
console.log("CreatedByMe: " + translation.getCreatedByMe());
}
if (info.getPage() != null) {
//Get the Page from Info
console.log("Page: " + info.getPage().toString());
}
if (info.getMoreRecords() != null) {
//Get the MoreRecords from Info
console.log("MoreRecords: " + info.getMoreRecords().toString());
}
}
}
//Check if the request returned an exception
else if (responseObject instanceof 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());
}
}
}
}
module.exports = {CustomView}
Get a Custom View
const { CustomViewsOperations, GetCustomViewsParam } = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/custom_views/custom_views_operations");
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/custom_views/response_wrapper").ResponseWrapper;
const APIException = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/custom_views/api_exception").APIException;
const ParameterMap = require("@zohocrm/nodejs-sdk-2.1/routes/parameter_map").ParameterMap;
class CustomView{
/**
* This method is used to get the data of any specific custom view of the module.
* Specify the custom view ID of the module in your API request whose custom view data you want to retrieve.
* @param {String} moduleAPIName Specify the API name of the required module.
* @param {BigInt} customViewId ID of the CustomView to be obtained.
*/
static async getCustomView(moduleAPIName, customViewId) {
//example
// let moduleAPIName = "module_api_name"
// let customViewId = 87507n;
//Get instance of CustomViewOperations Class that takes moduleAPIName as parameter
let customViewsOperations = new CustomViewsOperations(moduleAPIName);
//Call getCustomView method that takes customViewId as parameter
let response = await customViewsOperations.getCustomView(customViewId);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ResponseWrapper) {
//Get the array of obtained CustomView instances
let customViews = responseObject.getCustomViews();
for (let index = 0; index {
//Get the Name of the sharedTo
console.log("CustomView sharedTo Name: " + sharedTo.getName());
//Get the ID of the sharedTo
console.log("CustomView sharedTo Id: " + sharedTo.getId());
//Get the Type of the sharedTo
console.log("CustomView sharedTo Type: " + sharedTo.getType());
//Get the Subordinates of the sharedTo
console.log("CustomView sharedTo Subordinates: " + sharedTo.getSubordinates());
});
}
//Get the Default of each CustomView
console.log("CustomView Default: " + customView.getDefault().toString());
//Get the ModifiedTime of each CustomView
console.log("CustomView ModifiedTime: " + customView.getModifiedTime());
//Get the SystemDefined of each CustomView
console.log("CustomView SystemDefined: " + customView.getSystemDefined().toString());
//Get the modifiedBy User instance of each CustomView
let modifiedBy = customView.getModifiedBy();
//Check if modifiedBy is not null
if (modifiedBy != null) {
//Get the Name of the modifiedBy User
console.log("CustomView Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("CustomView Modified By User-ID: " + modifiedBy.getId());
}
//Get the list of fields in each CustomView
let fields = customView.getFields();
if (fields != null) {
fields.forEach(field => {
//Get the APIName of the Fields
console.log("CustomView Fields APIName: " + field.getAPIName());
//Get the Id of the Fields
console.log("CustomView Fields Id: " + field.getId());
});
}
//Get the Category of each CustomView
console.log("CustomView Category: " + customView.getCategory());
//Get the LastAccessedTime of each CustomView
console.log("CustomView LastAccessedTime: " + customView.getLastAccessedTime());
if (customView.getFavorite() != null) {
//Get the Favorite of each CustomView
console.log("CustomView Favorite: " + customView.getFavorite().toString());
}
if (customView.getSortOrder() != null) {
//Get the SortOrder of each CustomView
console.log("CustomView SortOrder: " + customView.getSortOrder().toString());
}
}
//Get the Info instance from object
let info = responseObject.getInfo();
if (info != null) {
//Get the Translation instance of CustomView
let translation = info.getTranslation();
if (translation != null) {
console.log("Translation details");
//Get the PublicViews of the Translation
console.log("PublicViews: " + translation.getPublicViews());
//Get the OtherUsersViews of the Translation
console.log("OtherUsersViews: " + translation.getOtherUsersViews());
//Get the SharedWithMe of the Translation
console.log("SharedWithMe: " + translation.getSharedWithMe());
//Get the CreatedByMe of the Translation
console.log("CreatedByMe: " + translation.getCreatedByMe());
}
}
}
//Check if the request returned an exception
else if (responseObject instanceof 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());
}
}
}
}
module.exports = {CustomView}