TypeScript SDK Samples - Modules Operations
Get Modules
import { Criteria } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/criteria";
import { CustomView } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/custom_view";
import { SharedDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/shared_details";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/success_response";
import { Argument } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/argument";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/body_wrapper";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_wrapper";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import {ModulesOperations,GetModulesHeader} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/modules_operations";
import { RelatedListProperties } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/related_list_properties";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_wrapper";
import { Profile } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/profiles/profile";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_response";
export class Modules{
/**
* Get Modules
* This method is used to get metadata about all the modules and print the response.
*/
public static async getModules(){
//Get instance of ModulesOperations Class
let modulesOperations: ModulesOperations = new ModulesOperations();
//Get the instance of HeaderMap Class
let headerInstance: HeaderMap = new HeaderMap();
//Add header to HeaderMap instance, if necessary
// await headerInstance.add(GetModulesHeader.IF_MODIFIED_SINCE, new Date("2020-07-13T12:12:12+05:30"));
//Call getModules method that takes headerInstance as parameters
let response: APIResponse<ResponseHandler> = await modulesOperations.getModules(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: ResponseHandler = response.getObject();
if(responseObject != null){
//Check if expected ResponseWrapper instance is received.
if(responseObject instanceof ResponseWrapper){
//Get the array of obtained Module instances
let modules: Module[] = responseObject.getModules();
modules.forEach(module=> {
//Get the Name of each Module
console.log("Module Name: " + module.getName());
//Get the GlobalSearchSupported of each Module
console.log("Module GlobalSearchSupported: " + module.getGlobalSearchSupported().toString());
//Get the Deletable of each Module
console.log("Module Deletable: " + module.getDeletable().toString());
//Get the Description of each Module
console.log("Module Description: " + module.getDescription());
//Get the Creatable of each Module
console.log("Module Creatable: " + module.getCreatable().toString());
//Get the InventoryTemplateSupported of each Module
console.log("Module InventoryTemplateSupported: " + module.getInventoryTemplateSupported().toString());
if(module.getModifiedTime() != null){
//Get the ModifiedTime of each Module
console.log("Module ModifiedTime: " + module.getModifiedTime());
}
//Get the PluralLabel of each Module
console.log("Module PluralLabel: " + module.getPluralLabel());
//Get the PresenceSubMenu of each Module
console.log("Module PresenceSubMenu: " + module.getPresenceSubMenu().toString());
//Get the TriggersSupported of each Module
console.log("Module TriggersSupported: " + module.getTriggersSupported().toString());
//Get the Id of each Module
console.log("Module Id: " + module.getId().toString());
//Get the Visibility of each Module
console.log("Module Visibility: " + module.getVisibility().toString());
//Get the Convertable of each Module
console.log("Module Convertable: " + module.getConvertable().toString());
//Get the Editable of each Module
console.log("Module Editable: " + module.getEditable().toString());
//Get the EmailtemplateSupport of each Module
console.log("Module EmailtemplateSupport: " + module.getEmailtemplateSupport().toString());
//Get the list of Profile instance each Module
let profiles: Profile[] = module.getProfiles();
//Check if profiles is not null
if(profiles != null){
profiles.forEach(profile => {
//Get the Name of each Profile
console.log("Module Profile Name: " + profile.getName());
//Get the Id of each Profile
console.log("Module Profile Id: " + profile.getId().toString());
});
}
//Get the FilterSupported of each Module
console.log("Module FilterSupported: " + module.getFilterSupported().toString());
//Get the ShowAsTab of each Module
console.log("Module ShowAsTab: " + module.getShowAsTab().toString());
//Get the WebLink of each Module
console.log("Module WebLink: " + module.getWebLink());
//Get the SequenceNumber of each Module
console.log("Module SequenceNumber: " + module.getSequenceNumber().toString());
//Get the SingularLabel of each Module
console.log("Module SingularLabel: " + module.getSingularLabel());
//Get the Viewable of each Module
console.log("Module Viewable: " + module.getViewable().toString());
//Get the APISupported of each Module
console.log("Module APISupported: " + module.getAPISupported().toString());
//Get the APIName of each Module
console.log("Module APIName: " + module.getAPIName());
//Get the QuickCreate of each Module
console.log("Module QuickCreate: " + module.getQuickCreate().toString());
//Get the modifiedBy User instance of each Module
let modifiedBy: User = module.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the name of the modifiedBy User
console.log("Module Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Module Modified By User-ID: " + modifiedBy.getId());
}
//Get the GeneratedType of each Module
console.log("Module GeneratedType: " + module.getGeneratedType().getValue());
//Get the FeedsRequired of each Module
console.log("Module FeedsRequired: " + module.getFeedsRequired().toString());
//Get the ScoringSupported of each Module
console.log("Module ScoringSupported: " + module.getScoringSupported().toString());
//Get the WebformSupported of each Module
console.log("Module WebformSupported: " + module.getWebformSupported().toString());
//Get the list of Argument instance each Module
let moduleArguments: Argument[] = module.getArguments();
//Check if arguments is not null
if(moduleArguments != null){
moduleArguments.forEach(argument => {
//Get the Name of each Argument
console.log("Module Argument Name: " + argument.getName());
//Get the Value of each Argument
console.log("Module Argument Value: " + argument.getValue());
});
}
//Get the ModuleName of each Module
console.log("Module ModuleName: " + module.getModuleName());
//Get the BusinessCardFieldLimit of each Module
console.log("Module BusinessCardFieldLimit: " + module.getBusinessCardFieldLimit().toString());
//Get the parentModule Module instance of each Module
let parentModule: Module = module.getParentModule();
//Check if arguments is not null
if(parentModule != null && parentModule.getAPIName() != null){
//Get the Name of Parent Module
console.log("Module Parent Module Name: " + parentModule.getAPIName());
//Get the Value of Parent Module
console.log("Module Parent Module Id: " + parentModule.getId().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: Map<string,any> = 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());
}
}
}
}
private static async printCustomView(customView: CustomView){
//Get the ID of the CustomView
console.log("CustomView ID: " + customView.getId());
//Get the Name of the CustomView
console.log("CustomView Name: " + customView.getName());
//Get the DisplayValue of the CustomView
console.log("CustomView DisplayValue: " + customView.getDisplayValue());
//Get the SharedType of the CustomView
console.log("CustomView SharedType: " + customView.getSharedType());
//Get the SystemName of the CustomView
console.log("CustomView SystemName: " + customView.getSystemName());
//Get the Criteria instance of the CustomView
let criteria: Criteria = customView.getCriteria();
if(criteria != null && criteria !== undefined){
await this.printCriteria(criteria);
}
let sharedDetails: SharedDetails[] = customView.getSharedDetails();
if(sharedDetails != null){
sharedDetails.forEach(sharedDetail => {
//Get the Name of the each SharedDetails
console.log("SharedDetails Name: " + sharedDetail.getName());
//Get the ID of the each SharedDetails
console.log("SharedDetails ID: " + sharedDetail.getId());
//Get the Type of the each SharedDetails
console.log("SharedDetails Type: " + sharedDetail.getType());
//Get the Subordinates of the each SharedDetails
console.log("SharedDetails Subordinates: " + sharedDetail.getSubordinates());
});
}
//Get the SortBy of the the CustomView
console.log("CustomView SortBy: " + customView.getSortBy());
//Get the Offline of the the CustomView
console.log("CustomView Offline: " + customView.getOffline());
//Get the Default of the CustomView
console.log("CustomView Default: " + customView.getDefault());
//Get the SystemDefined of the CustomView
console.log("CustomView SystemDefined: " + customView.getSystemDefined());
//Get the Category of the CustomView
console.log("CustomView Category: " + customView.getCategory());
//Get the list of fields in the CustomView
let fields: string[] = customView.getFields();
if(fields != null && fields !== undefined){
console.log("Fields");
fields.forEach(field => {
console.log(field);
});
}
if(customView.getFavorite() != null){
//Get the Favorite of the CustomView
console.log("CustomView Favorite: " + customView.getFavorite());
}
if(customView.getSortOrder() != null){
//Get the SortOrder of the CustomView
console.log("CustomView SortOrder: " + customView.getSortOrder());
}
}
private static async printCriteria(criteria: Criteria){
if(criteria.getComparator() != null){
//Get the Comparator of the Criteria
console.log("CustomView Criteria Comparator: " + criteria.getComparator().getValue());
}
if(criteria.getField() != null){
//Get the Field of the Criteria
console.log("CustomView Criteria Field: " + criteria.getField());
}
if(criteria.getValue() != null){
//Get the Value of the Criteria
console.log("CustomView Criteria Value: " + criteria.getValue().toString());
}
// Get the List of Criteria instance of each Criteria
let criteriaGroup: Criteria[] = criteria.getGroup();
if(criteriaGroup != null){
criteriaGroup.forEach(eachCriteria => {
this.printCriteria(eachCriteria);
});
}
if(criteria.getGroupOperator() != null){
//Get the Group Operator of the Criteria
console.log("CustomView Criteria Group Operator: " + criteria.getGroupOperator().getValue());
}
}
}
Get a Module
import { Criteria } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/criteria";
import { CustomView } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/custom_view";
import { SharedDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/shared_details";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/success_response";
import { Argument } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/argument";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/body_wrapper";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_wrapper";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import {ModulesOperations,GetModulesHeader} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/modules_operations";
import { RelatedListProperties } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/related_list_properties";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_wrapper";
import { Profile } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/profiles/profile";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_response";
export class Modules{
/**
* Get a Module
* This method is used to get metadata about single module with it's API Name and print the response.
* @param moduleAPIName The API Name of the module to obtain metadata
*/
public static async getModule(moduleAPIName: string){
//example
//let moduleAPIName = "Leads";
//Get instance of ModulesOperations Class
let modulesOperations: ModulesOperations = new ModulesOperations();
//Call getModule method that takes moduleAPIName as parameter
let response: APIResponse<ResponseHandler> = await modulesOperations.getModule(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: ResponseHandler = response.getObject();
if(responseObject != null){
//Check if expected ResponseWrapper instance is received.
if(responseObject instanceof ResponseWrapper){
//Get the array of obtained Module instances
let modules: Module[] = responseObject.getModules();
modules.forEach(module => {
//Get the GlobalSearchSupported of each Module
console.log("Module GlobalSearchSupported: " + module.getGlobalSearchSupported().toString());
if(module.getKanbanView() != null) {
//Get the KanbanView of each Module
console.log("Module KanbanView: " + module.getKanbanView().toString());
}
//Get the Deletable of each Module
console.log("Module Deletable: " + module.getDeletable().toString());
//Get the Description of each Module
console.log("Module Description: " + module.getDescription());
//Get the Creatable of each Module
console.log("Module Creatable: " + module.getCreatable().toString());
if(module.getFilterStatus() != null) {
//Get the FilterStatus of each Module
console.log("Module FilterStatus: " + module.getFilterStatus().toString());
}
//Get the InventoryTemplateSupported of each Module
console.log("Module InventoryTemplateSupported: " + module.getInventoryTemplateSupported().toString());
if(module.getModifiedTime() != null){
//Get the ModifiedTime of each Module
console.log("Module ModifiedTime: " + module.getModifiedTime());
}
//Get the PluralLabel of each Module
console.log("Module PluralLabel: " + module.getPluralLabel());
//Get the PresenceSubMenu of each Module
console.log("Module PresenceSubMenu: " + module.getPresenceSubMenu().toString());
//Get the TriggersSupported of each Module
console.log("Module TriggersSupported: " + module.getTriggersSupported().toString());
//Get the Id of each Module
console.log("Module Id: " + module.getId().toString());
//Get the RelatedListProperties instance of each Module
let relatedListProperties: RelatedListProperties = module.getRelatedListProperties();
//Check if relatedListProperties is not null
if(relatedListProperties != null){
//Get the SortBy of RelatedListProperties
console.log("Module RelatedListProperties SortBy: " + relatedListProperties.getSortBy());
//Get List of fields APIName
let fields: string[] = relatedListProperties.getFields();
//Check if fields is not null
if(fields != null){
fields.forEach(fieldName => {
//Get the Field Name
console.log("Module RelatedListProperties Fields: " + fieldName);
});
}
//Get the SortOrder of RelatedListProperties
console.log("Module RelatedListProperties SortOrder: " + relatedListProperties.getSortOrder());
}
//Get List of properties field APIName
let properties: string[] = module.getProperties();
//Check if properties is not null
if(properties != null){
properties.forEach(fieldName => {
//Get the Field Name
console.log("Module Properties Fields: " + fieldName);
});
}
//Get the PerPage of each Module
console.log("Module PerPage: " + module.getPerPage().toString());
//Get the Visibility of each Module
console.log("Module Visibility: " + module.getVisibility().toString());
//Get the Convertable of each Module
console.log("Module Convertable: " + module.getConvertable().toString());
//Get the Editable of each Module
console.log("Module Editable: " + module.getEditable().toString());
//Get the EmailtemplateSupport of each Module
console.log("Module EmailtemplateSupport: " + module.getEmailtemplateSupport().toString());
//Get the list of Profile instance each Module
let profiles: Profile[] = module.getProfiles();
//Check if profiles is not null
if(profiles != null){
profiles.forEach(profile => {
//Get the Name of each Profile
console.log("Module Profile Name: " + profile.getName());
//Get the Id of each Profile
console.log("Module Profile Id: " + profile.getId().toString());
});
}
//Get the FilterSupported of each Module
console.log("Module FilterSupported: " + module.getFilterSupported().toString());
//Get the DisplayField of each Module
console.log("Module DisplayField: " + module.getDisplayField());
//Get List of SearchLayoutFields APIName
let searchLayoutFields: string[] = module.getSearchLayoutFields();
//Check if searchLayoutFields is not null
if(searchLayoutFields != null){
searchLayoutFields.forEach(fieldName => {
//Get the Field Name
console.log("Module SearchLayoutFields Fields: " + fieldName);
});
}
if(module.getKanbanViewSupported() != null) {
//Get the KanbanViewSupported of each Module
console.log("Module KanbanViewSupported: " + module.getKanbanViewSupported().toString());
}
//Get the ShowAsTab of each Module
console.log("Module ShowAsTab: " + module.getShowAsTab().toString());
//Get the WebLink of each Module
console.log("Module WebLink: " + module.getWebLink());
//Get the SequenceNumber of each Module
console.log("Module SequenceNumber: " + module.getSequenceNumber().toString());
//Get the SingularLabel of each Module
console.log("Module SingularLabel: " + module.getSingularLabel());
//Get the Viewable of each Module
console.log("Module Viewable: " + module.getViewable().toString());
//Get the APISupported of each Module
console.log("Module APISupported: " + module.getAPISupported().toString());
//Get the APIName of each Module
console.log("Module APIName: " + module.getAPIName());
//Get the QuickCreate of each Module
console.log("Module QuickCreate: " + module.getQuickCreate().toString());
//Get the modifiedBy User instance of each Module
let modifiedBy: User = module.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the name of the modifiedBy User
console.log("Module Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Module Modified By User-ID: " + modifiedBy.getId());
}
//Get the GeneratedType of each Module
console.log("Module GeneratedType: " + module.getGeneratedType().getValue());
//Get the FeedsRequired of each Module
console.log("Module FeedsRequired: " + module.getFeedsRequired().toString());
//Get the ScoringSupported of each Module
console.log("Module ScoringSupported: " + module.getScoringSupported().toString());
//Get the WebformSupported of each Module
console.log("Module WebformSupported: " + module.getWebformSupported().toString());
//Get the list of Argument instance each Module
let moduleArguments: Argument[] = module.getArguments();
//Check if arguments is not null
if(moduleArguments != null){
moduleArguments.forEach(argument => {
//Get the Name of each Argument
console.log("Module Argument Name: " + argument.getName());
//Get the Value of each Argument
console.log("Module Argument Value: " + argument.getValue());
});
}
//Get the ModuleName of each Module
console.log("Module ModuleName: " + module.getModuleName());
//Get the BusinessCardFieldLimit of each Module
console.log("Module BusinessCardFieldLimit: " + module.getBusinessCardFieldLimit().toString());
//Get the CustomView instance of each Module
let customView: CustomView = module.getCustomView();
//Check if customView is not null
if(customView != null){
this.printCustomView(customView);
}
//Get the parentModule Module instance of each Module
let parentModule: Module = module.getParentModule();
//Check if parentModule is not null
if(parentModule != null && parentModule.getAPIName() != null){
//Get the Name of Parent Module
console.log("Module Parent Module Name: " + parentModule.getAPIName());
//Get the Value of Parent Module
console.log("Module Parent Module Id: " + parentModule.getId().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());
}
}
}
}
private static async printCustomView(customView: CustomView){
//Get the ID of the CustomView
console.log("CustomView ID: " + customView.getId());
//Get the Name of the CustomView
console.log("CustomView Name: " + customView.getName());
//Get the DisplayValue of the CustomView
console.log("CustomView DisplayValue: " + customView.getDisplayValue());
//Get the SharedType of the CustomView
console.log("CustomView SharedType: " + customView.getSharedType());
//Get the SystemName of the CustomView
console.log("CustomView SystemName: " + customView.getSystemName());
//Get the Criteria instance of the CustomView
let criteria: Criteria = customView.getCriteria();
if(criteria != null && criteria !== undefined){
await this.printCriteria(criteria);
}
let sharedDetails: SharedDetails[] = customView.getSharedDetails();
if(sharedDetails != null){
sharedDetails.forEach(sharedDetail => {
//Get the Name of the each SharedDetails
console.log("SharedDetails Name: " + sharedDetail.getName());
//Get the ID of the each SharedDetails
console.log("SharedDetails ID: " + sharedDetail.getId());
//Get the Type of the each SharedDetails
console.log("SharedDetails Type: " + sharedDetail.getType());
//Get the Subordinates of the each SharedDetails
console.log("SharedDetails Subordinates: " + sharedDetail.getSubordinates());
});
}
//Get the SortBy of the the CustomView
console.log("CustomView SortBy: " + customView.getSortBy());
//Get the Offline of the the CustomView
console.log("CustomView Offline: " + customView.getOffline());
//Get the Default of the CustomView
console.log("CustomView Default: " + customView.getDefault());
//Get the SystemDefined of the CustomView
console.log("CustomView SystemDefined: " + customView.getSystemDefined());
//Get the Category of the CustomView
console.log("CustomView Category: " + customView.getCategory());
//Get the list of fields in the CustomView
let fields: string[] = customView.getFields();
if(fields != null && fields !== undefined){
console.log("Fields");
fields.forEach(field => {
console.log(field);
});
}
if(customView.getFavorite() != null){
//Get the Favorite of the CustomView
console.log("CustomView Favorite: " + customView.getFavorite());
}
if(customView.getSortOrder() != null){
//Get the SortOrder of the CustomView
console.log("CustomView SortOrder: " + customView.getSortOrder());
}
}
private static async printCriteria(criteria: Criteria){
if(criteria.getComparator() != null){
//Get the Comparator of the Criteria
console.log("CustomView Criteria Comparator: " + criteria.getComparator().getValue());
}
if(criteria.getField() != null){
//Get the Field of the Criteria
console.log("CustomView Criteria Field: " + criteria.getField());
}
if(criteria.getValue() != null){
//Get the Value of the Criteria
console.log("CustomView Criteria Value: " + criteria.getValue().toString());
}
// Get the List of Criteria instance of each Criteria
let criteriaGroup: Criteria[] = criteria.getGroup();
if(criteriaGroup != null){
criteriaGroup.forEach(eachCriteria => {
this.printCriteria(eachCriteria);
});
}
if(criteria.getGroupOperator() != null){
//Get the Group Operator of the Criteria
console.log("CustomView Criteria Group Operator: " + criteria.getGroupOperator().getValue());
}
}
}
Update the Module by its API Name
import { Criteria } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/criteria";
import { CustomView } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/custom_view";
import { SharedDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/shared_details";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/success_response";
import { Argument } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/argument";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/body_wrapper";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_wrapper";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import {ModulesOperations,GetModulesHeader} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/modules_operations";
import { RelatedListProperties } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/related_list_properties";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_wrapper";
import { Profile } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/profiles/profile";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_response";
export class Modules{
/**
* Update Module By APIName
* This method is used to update module details using module APIName and print the response.
* @param moduleAPIName The API Name of the module to update
*/
public static async updateModuleByAPIName(moduleAPIName: string){
//example
//let moduleAPIName = "Leads";
//Get instance of ModulesOperations Class
let modulesOperations: ModulesOperations = new ModulesOperations();
let modulesArray: Module[] = [];
let profilesArray: Profile[] = [];
//Get instance of Profile Class
let profile: Profile = new Profile();
//To set the Profile Id
profile.setId(BigInt("347706126014"));
//Add Profile instance to the array
profilesArray.push(profile);
//Get instance of Module Class
let module: Module = new Module();
//Set the array to profiles in Module instance
module.setProfiles(profilesArray);
//Add the Module instance to array
modulesArray.push(module);
//Get instance of BodyWrapper Class which contains the request body
let request: BodyWrapper = new BodyWrapper();
//Set the array to modules in BodyWrapper instance
request.setModules(modulesArray);
//Call updateModuleByAPIName method that takes BodyWrapper instance and moduleAPIName as parameter
let response: APIResponse<ActionHandler> = await modulesOperations.updateModuleByAPIName(moduleAPIName, request);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject: ActionHandler = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received
if(responseObject instanceof ActionWrapper){
//Get the array of obtained ActionResponse instances
let actionResponses: ActionResponse[] = responseObject.getModules();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof 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: Map<string,any> = 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 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: Map<string,any> = 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 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: Map<string,any> = 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());
}
}
}
}
private static async printCustomView(customView: CustomView){
//Get the ID of the CustomView
console.log("CustomView ID: " + customView.getId());
//Get the Name of the CustomView
console.log("CustomView Name: " + customView.getName());
//Get the DisplayValue of the CustomView
console.log("CustomView DisplayValue: " + customView.getDisplayValue());
//Get the SharedType of the CustomView
console.log("CustomView SharedType: " + customView.getSharedType());
//Get the SystemName of the CustomView
console.log("CustomView SystemName: " + customView.getSystemName());
//Get the Criteria instance of the CustomView
let criteria: Criteria = customView.getCriteria();
if(criteria != null && criteria !== undefined){
await this.printCriteria(criteria);
}
let sharedDetails: SharedDetails[] = customView.getSharedDetails();
if(sharedDetails != null){
sharedDetails.forEach(sharedDetail => {
//Get the Name of the each SharedDetails
console.log("SharedDetails Name: " + sharedDetail.getName());
//Get the ID of the each SharedDetails
console.log("SharedDetails ID: " + sharedDetail.getId());
//Get the Type of the each SharedDetails
console.log("SharedDetails Type: " + sharedDetail.getType());
//Get the Subordinates of the each SharedDetails
console.log("SharedDetails Subordinates: " + sharedDetail.getSubordinates());
});
}
//Get the SortBy of the the CustomView
console.log("CustomView SortBy: " + customView.getSortBy());
//Get the Offline of the the CustomView
console.log("CustomView Offline: " + customView.getOffline());
//Get the Default of the CustomView
console.log("CustomView Default: " + customView.getDefault());
//Get the SystemDefined of the CustomView
console.log("CustomView SystemDefined: " + customView.getSystemDefined());
//Get the Category of the CustomView
console.log("CustomView Category: " + customView.getCategory());
//Get the list of fields in the CustomView
let fields: string[] = customView.getFields();
if(fields != null && fields !== undefined){
console.log("Fields");
fields.forEach(field => {
console.log(field);
});
}
if(customView.getFavorite() != null){
//Get the Favorite of the CustomView
console.log("CustomView Favorite: " + customView.getFavorite());
}
if(customView.getSortOrder() != null){
//Get the SortOrder of the CustomView
console.log("CustomView SortOrder: " + customView.getSortOrder());
}
}
private static async printCriteria(criteria: Criteria){
if(criteria.getComparator() != null){
//Get the Comparator of the Criteria
console.log("CustomView Criteria Comparator: " + criteria.getComparator().getValue());
}
if(criteria.getField() != null){
//Get the Field of the Criteria
console.log("CustomView Criteria Field: " + criteria.getField());
}
if(criteria.getValue() != null){
//Get the Value of the Criteria
console.log("CustomView Criteria Value: " + criteria.getValue().toString());
}
// Get the List of Criteria instance of each Criteria
let criteriaGroup: Criteria[] = criteria.getGroup();
if(criteriaGroup != null){
criteriaGroup.forEach(eachCriteria => {
this.printCriteria(eachCriteria);
});
}
if(criteria.getGroupOperator() != null){
//Get the Group Operator of the Criteria
console.log("CustomView Criteria Group Operator: " + criteria.getGroupOperator().getValue());
}
}
}
Update a Module by its ID
import { Criteria } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/criteria";
import { CustomView } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/custom_view";
import { SharedDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/custom_views/shared_details";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/success_response";
import { Argument } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/argument";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/body_wrapper";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_wrapper";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import {ModulesOperations,GetModulesHeader} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/modules_operations";
import { RelatedListProperties } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/related_list_properties";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/response_wrapper";
import { Profile } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/profiles/profile";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/action_response";
export class Modules{
**
* Update Module By Id
* This method is used to update module details using module Id and print the response.
* @param moduleId The ID of the module to be updated.
*/
public static async updateModuleById(moduleId: bigint){
//example
//moduleId = 3409643252001n
//Get instance of ModulesOperations Class
let modulesOperations: ModulesOperations = new ModulesOperations();
let modulesArray: Module[] = [];
let profilesArray: Profile[] = [];
//Get instance of Profile Class
let profile: Profile = new Profile();
//Get instance of Module Class
let module: Module = new Module();
//To set the Profile Id
profile.setId(BigInt("347706126014"));
profile.setDelete(true);
//Add the Profile instance to the array.
profilesArray.push(profile);
//Set profiles array to profiles in Module instance
module.setProfiles(profilesArray);
//Set the API Name to be modified
module.setAPIName("Test123");
//Add the Module instance to the array
modulesArray.push(module);
//Get instance of BodyWrapper Class that contains the request body
let request: BodyWrapper = new BodyWrapper();
//Set the array of module Instance to modules in BodyWrapper instance.
request.setModules(modulesArray);
//Call updateModuleById method that takes BodyWrapper instance and moduleAPIName as parameter
let response: APIResponse<ActionHandler> = await modulesOperations.updateModuleById(moduleId, request);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject: ActionHandler = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received
if(responseObject instanceof ActionWrapper){
//Get the array of obtained ActionResponse instances
let actionResponses: ActionResponse[] = responseObject.getModules();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof 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: Map<string,any> = 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 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: Map<string,any> = 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 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: Map<string,any> = 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());
}
}
}
}
private static async printCustomView(customView: CustomView){
//Get the ID of the CustomView
console.log("CustomView ID: " + customView.getId());
//Get the Name of the CustomView
console.log("CustomView Name: " + customView.getName());
//Get the DisplayValue of the CustomView
console.log("CustomView DisplayValue: " + customView.getDisplayValue());
//Get the SharedType of the CustomView
console.log("CustomView SharedType: " + customView.getSharedType());
//Get the SystemName of the CustomView
console.log("CustomView SystemName: " + customView.getSystemName());
//Get the Criteria instance of the CustomView
let criteria: Criteria = customView.getCriteria();
if(criteria != null && criteria !== undefined){
await this.printCriteria(criteria);
}
let sharedDetails: SharedDetails[] = customView.getSharedDetails();
if(sharedDetails != null){
sharedDetails.forEach(sharedDetail => {
//Get the Name of the each SharedDetails
console.log("SharedDetails Name: " + sharedDetail.getName());
//Get the ID of the each SharedDetails
console.log("SharedDetails ID: " + sharedDetail.getId());
//Get the Type of the each SharedDetails
console.log("SharedDetails Type: " + sharedDetail.getType());
//Get the Subordinates of the each SharedDetails
console.log("SharedDetails Subordinates: " + sharedDetail.getSubordinates());
});
}
//Get the SortBy of the the CustomView
console.log("CustomView SortBy: " + customView.getSortBy());
//Get the Offline of the the CustomView
console.log("CustomView Offline: " + customView.getOffline());
//Get the Default of the CustomView
console.log("CustomView Default: " + customView.getDefault());
//Get the SystemDefined of the CustomView
console.log("CustomView SystemDefined: " + customView.getSystemDefined());
//Get the Category of the CustomView
console.log("CustomView Category: " + customView.getCategory());
//Get the list of fields in the CustomView
let fields: string[] = customView.getFields();
if(fields != null && fields !== undefined){
console.log("Fields");
fields.forEach(field => {
console.log(field);
});
}
if(customView.getFavorite() != null){
//Get the Favorite of the CustomView
console.log("CustomView Favorite: " + customView.getFavorite());
}
if(customView.getSortOrder() != null){
//Get the SortOrder of the CustomView
console.log("CustomView SortOrder: " + customView.getSortOrder());
}
}
private static async printCriteria(criteria: Criteria){
if(criteria.getComparator() != null){
//Get the Comparator of the Criteria
console.log("CustomView Criteria Comparator: " + criteria.getComparator().getValue());
}
if(criteria.getField() != null){
//Get the Field of the Criteria
console.log("CustomView Criteria Field: " + criteria.getField());
}
if(criteria.getValue() != null){
//Get the Value of the Criteria
console.log("CustomView Criteria Value: " + criteria.getValue().toString());
}
// Get the List of Criteria instance of each Criteria
let criteriaGroup: Criteria[] = criteria.getGroup();
if(criteriaGroup != null){
criteriaGroup.forEach(eachCriteria => {
this.printCriteria(eachCriteria);
});
}
if(criteria.getGroupOperator() != null){
//Get the Group Operator of the Criteria
console.log("CustomView Criteria Group Operator: " + criteria.getGroupOperator().getValue());
}
}
}