Node JS SDK Samples - Layouts Operations
Get Layouts
Get a Layout
const LayoutsOperations = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/layouts/layouts_operations").LayoutsOperations;
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/layouts/response_wrapper").ResponseWrapper;
const APIException = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/layouts/api_exception").APIException;
class Layout{
/**
* Get Layout
* This method is used to get metadata about a single layout of a module with layoutID and print the response.
* @param {String} moduleAPIName The API Name of the layout's modules
* @param {BigInt} layoutId The ID of the layout to be obtained
*/
static async getLayout(moduleAPIName, layoutId) {
//example
//let moduleAPIName = "module_api_name";
//let layoutId = 091055n
//Get instance of LayoutsOperations Class that takes moduleAPIName as parameter
let layoutsOperations = new LayoutsOperations(moduleAPIName);
//Call getLayout method
let response = await layoutsOperations.getLayout(layoutId);
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) {
let layouts = responseObject.getLayouts();
layouts.forEach(layout => {
if (layout.getCreatedTime() != null) {
//Get the CreatedTime of each Layout
console.log("Layout CreatedTime: " + layout.getCreatedTime().toString());
}
//Check if ConvertMapping is not null
if (layout.getConvertMapping() != null) {
//Get the MultiModuleLookup map
Array.from(layout.getConvertMapping().keys()).forEach(key => {
console.log(key + ": " + layout.getConvertMapping().get(key));
});
}
//Get the Visible of each Layout
console.log("Layout Visible: " + layout.getVisible().toString());
//Get the createdFor User instance of each Layout
let createdFor = layout.getCreatedFor();
//Check if createdFor is not null
if (createdFor != null) {
//Get the Name of the createdFor User
console.log("Layout CreatedFor User-Name: " + createdFor.getName());
//Get the ID of the createdFor User
console.log("Layout CreatedFor User-ID: " + createdFor.getId());
//Get the Email of the createdFor User
console.log("Layout CreatedFor User-Email: " + createdFor.getEmail());
}
//Get the profiles of each Layout
let profiles = layout.getProfiles();
//Check if profiles is not null
if (profiles != null) {
profiles.forEach(profile => {
//Get the Default of each Profile
console.log("Layout Profile Default: " + profile.getDefault().toString());
//Get the Name of each Profile
console.log("Layout Profile Name: " + profile.getName().toString());
//Get the ID of each Profile
console.log("Layout Profile ID: " + profile.getId().toString());
let defaultView = profile.getDefaultview();
if (defaultView != null) {
//Get the Name of each DefaultView Profile
console.log("Layout Profile DefaultView Name: " + defaultView.getName());
//Get the ID of each DefaultView Profile
console.log("Layout Profile DefaultView ID: " + defaultView.getId());
//Get the Type of each DefaultView Profile
console.log("Layout Profile DefaultView Type: " + defaultView.getType());
}
});
}
//Get the createdBy User instance of each Layout
let createdBy = layout.getCreatedBy();
//Check if createdBy is not null
if (createdBy != null) {
//Get the Name of the createdBy User
console.log("Layout CreatedBy User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Layout CreatedBy User-ID: " + createdBy.getId());
//Get the Email of the createdBy User
console.log("Layout CreatedBy User-Email: " + createdBy.getEmail());
}
//Get the sections of each Layout
let sections = layout.getSections();
//Check if sections is not null
if (sections != null) {
sections.forEach(section => {
//Get the DisplayLabel of each Section
console.log("Layout Section DisplayLabel: " + section.getDisplayLabel());
//Get the SequenceNumber of each Section
console.log("Layout Section SequenceNumber: " + section.getSequenceNumber().toString());
//Get the Issubformsection of each Section
console.log("Layout Section Issubformsection: " + section.getIssubformsection().toString());
//Get the TabTraversal of each Section
console.log("Layout Section TabTraversal: " + section.getTabTraversal().toString());
//Get the APIName of each Section
console.log("Layout Section APIName: " + section.getAPIName());
//Get the ColumnCount of each Section
console.log("Layout Section ColumnCount: " + section.getColumnCount().toString());
//Get the Name of each Section
console.log("Layout Section Name: " + section.getName());
//Get the GeneratedType of each Section
console.log("Layout Section GeneratedType: " + section.getGeneratedType());
//Get the Type of each Section
console.log("Layout Section Type: " + section.getType());
//Get the fields of each Section
let fields = section.getFields();
//Check if fields is not null
if (fields != null) {
fields.forEach(async field => {
await this.printField(field);
});
}
//Get the properties instance of each Section
let properties = section.getProperties();
//Check if properties is not null
if (properties != null) {
//Get the ReorderRows of each Properties
console.log("Layout Section Properties ReorderRows: " + properties.getReorderRows().toString());
//Get the tooltip User instance of the Properties
let tooltip = properties.getTooltip();
//Check if tooltip is not null
if (tooltip != null) {
//Get the Name of the ToolTip
console.log("Layout Section Properties ToolTip Name: " + tooltip.getName().toString());
//Get the Value of the ToolTip
console.log("Layout Section Properties ToolTip Value: " + tooltip.getValue().toString());
}
//Get the MaximumRows of each Properties
console.log("Layout Section Properties MaximumRows: " + properties.getMaximumRows().toString());
}
});
}
//Get the ShowBusinessCard of each Layout
console.log("Layout ShowBusinessCard: " + layout.getShowBusinessCard());
if (layout.getModifiedTime() != null) {
//Get the ModifiedTime of each Layout
console.log("Layout ModifiedTime: " + layout.getModifiedTime());
}
//Get the Name of each Layout
console.log("Layout Name: " + layout.getName());
//Get the modifiedBy User instance of each Layout
let modifiedBy = layout.getModifiedBy();
//Check if modifiedBy is not null
if (modifiedBy != null) {
//Get the Name of the modifiedBy User
console.log("Layout ModifiedBy User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Layout ModifiedBy User-ID: " + modifiedBy.getId());
//Get the Email of the modifiedBy User
console.log("Layout ModifiedBy User-Email: " + modifiedBy.getEmail());
}
//Get the ID of each Layout
console.log("Layout ID: " + layout.getId());
//Get the Status of each Layout
console.log("Layout Status: " + layout.getStatus());
//Get the display type of each Layout
console.log("Layout DisplayType : " + layout.getDisplayType());
});
}
//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());
}
}
}
}
static async printField(field) {
//Get the SystemMandatory of each Field
console.log("Field SystemMandatory: " + field.getSystemMandatory().toString());
//Get the Webhook of each Field
console.log("Field Webhook: " + field.getWebhook().toString());
//Get the JsonType of each Field
console.log("Field JsonType: " + field.getJsonType());
//Get the private info of each field
let privateInfo = field.getPrivate();
//Check if privateInfo is not null
if (privateInfo != null) {
console.log("Private Details\n");
//Get the type
console.log("Field Private Type: " + privateInfo.getType());
//Get the Export
console.log("Field Private Export: " + privateInfo.getExport());
//Get the Restricted
console.log("Field Private Restricted: " + privateInfo.getRestricted());
}
//Get the obtained Crypt instance
let crypt = field.getCrypt();
if (crypt != null) {
console.log("Crypt Details");
//Get the Crypt Mode
console.log("Field Crypt Mode: " + crypt.getMode());
//Get the Crypt Column
console.log("Field Crypt Column: " + crypt.getColumn());
//Get the Crypt Table
console.log("Field Crypt Table: " + crypt.getTable());
//Get the Crypt Status
console.log("Field Crypt Status: " + crypt.getStatus().toString());
let encFldIds = crypt.getEncfldids();
if (encFldIds != null) {
console.log("EncFldIds : ");
encFldIds.forEach(encFldId => {
console.log(encFldId);
});
}
//Get the Notify of the Crypt
console.log("Field Crypt Notify: " + crypt.getNotify());
}
//Get the FieldLabel of each Field
console.log("Field FieldLabel: " + field.getFieldLabel());
//Get the obtained Tooltip instance
let toolTip = field.getTooltip();
if (toolTip != null) {
//Get the Name of the ToolTip
console.log("Field ToolTip Name: " + toolTip.getName());
//Get the Value of the ToolTip
console.log("Field ToolTip Value: " + toolTip.getValue());
}
//Get the CreatedSource of each Field
console.log("Field CreatedSource: " + field.getCreatedSource());
//Get the FieldReadOnly of each Field
console.log("Field FieldReadOnly: " + field.getFieldReadOnly().toString());
//Get the DisplayLabel of each Field
console.log("Field DisplayLabel: " + field.getDisplayLabel());
//Get the ReadOnly of each Field
console.log("Field ReadOnly: " + field.getReadOnly().toString());
//Get the obtained AssociationDetails instance
let associationDetails = field.getAssociationDetails();
//Check if associationDetails is not null
if (associationDetails != null) {
//Get the obtained LookupField instance
let lookupField = associationDetails.getLookupField();
if (lookupField != null) {
//Get the ID of the LookupField
console.log("Field AssociationDetails LookupField ID: " + lookupField.getId());
//Get the Name of the LookupField
console.log("Field AssociationDetails LookupField Name: " + lookupField.getName())
}
//Get the obtained LookupField instance
let relatedField = associationDetails.getRelatedField();
if (relatedField != null) {
//Get the ID of the relatedField
console.log("Field AssociationDetails RelatedField ID: " + relatedField.getId());
//Get the Name of the relatedField
console.log("Field AssociationDetails RelatedField Name: " + relatedField.getName());
}
}
//Get the Filterable of each Field
console.log("Field Filterable: "+ field.getFilterable() );
//Check if ConvertMapping is not null
if (field.getConvertMapping() != null) {
console.log("Field ConvertMapping: \n");
Array.from(field.getConvertMapping().keys()).forEach(key => {
console.log(key + ": " + field.getConvertMapping().get(key));
});
}
if(field.getHistoryTracking() != null)
{
let historytracking = field.getHistoryTracking();
//Get the Module of history tracking
let module = historytracking.getModule();
if (module != null) {
let moduleLayout = module.getLayout();
if (moduleLayout != null) {
console.log("Module Layout ID" + moduleLayout.getId());
}
console.log("Module Layout Module DisplayLabe" + module.getDisplayLabel());
console.log("Module Layout Module APIName" + module.getAPIName());
console.log("Module Layout Module ID" + module.getId());
console.log("Module Layout Module" + module.getModule());
console.log("Module Layout Module Name" + module.getModuleName());
}
//Get the duration configured field of each history tracking
let durationConfigured = historytracking.getDurationConfiguredField();
if(durationConfigured != null) {
console.log("historytracking duration configured field" + durationConfigured.getId());
}
}
if (field.getBusinesscardSupported() != null) {
//Get the BusinesscardSupported of each Field
console.log("Field BusinesscardSupported: " + field.getBusinesscardSupported().toString());
}
//Get the obtained Currency instance
let currency = field.getCurrency();
//Check if currency is not null
if (currency != null) {
//Get the RoundingOption of the Currency
console.log("Field Currency RoundingOption: " + currency.getRoundingOption());
if (currency.getPrecision() != null) {
//Get the Precision of the Currency
console.log("Field Currency Precision: " + currency.getPrecision().toString());
}
}
if (field.getQuickSequenceNumber() != null) {
//Get the QuickSequenceNumber of each Field
console.log("Field QuickSequenceNumber: " + field.getQuickSequenceNumber().toString());
}
//Get the ID of each Field
console.log("Field ID: " + field.getId().toString());
if (field.getCustomField() != null) {
//Get the CustomField of each Field
console.log("Field CustomField: " + field.getCustomField().toString());
}
//Get the obtained Module instance
let lookup = field.getLookup();
//Check if lookup is not null
if (lookup != null) {
//Get the obtained Layout instance
let layout = lookup.getLayout();
//Check if layout is not null
if (layout != null) {
//Get the ID of the Layout
console.log("Field Lookup Layout ID: " + layout.getId().toString());
//Get the Name of the Layout
console.log("Field Lookup Layout Name: " + layout.getName());
}
//Get the DisplayLabel of the Module
console.log("Field Lookup DisplayLabel: " + lookup.getDisplayLabel());
//Get the APIName of the Module
console.log("Field Lookup APIName: " + lookup.getAPIName());
//Get the Module of the ModuleLookup
console.log("Field Lookup Module: " + lookup.getModule());
if (lookup.getId() != null) {
//Get the ID of the Module
console.log("Field Lookup ID: " + lookup.getId().toString());
}
//Get the ModuleName of the Module
console.log("Field Lookup ModuleName: " + lookup.getModuleName());
}
if (field.getVisible() != null) {
//Get the Visible of each Field
console.log("Field Visible: " + field.getVisible().toString());
}
//Get the PickListValuesSortedLexically of each Field
console.log("Field PickListValuesSortedLexically: " + field.getPickListValuesSortedLexically());
//Get the Sortable of each Field
console.log("Field Sortable: " + field.getSortable());
//Get the UIType of each Field
console.log("Field UIType: " + field.getUiType());
if (field.getSequenceNumber() != null) {
//Get the SequenceNumber of each Field
console.log("Field PickListValue SequenceNumber: " + field.getSequenceNumber().toString());
}
let profiles = field.getProfiles();
if (profiles != null) {
profiles.forEach(profile => {
//Get the PermissionType of each Profile
console.log("Field Profile PermissionType: " + profile.getPermissionType());
//Get the Name of each Profile
console.log("Field Profile Name: " + profile.getName());
//Get the Id of each Profile
console.log("Field Profile Id: " + profile.getId());
});
}
if(field.getLength() != null) {
//Get the Length of each Field
console.log("Field Length: " + field.getLength().toString());
}
//Get the obtained ViewType instance
let viewType = field.getViewType();
//Check if viewType is not null
if (viewType != null) {
//Get the View of the ViewType
console.log("Field ViewType View: " + viewType.getView().toString());
//Get the Edit of the ViewType
console.log("Field ViewType Edit: " + viewType.getEdit().toString());
//Get the Create of the ViewType
console.log("Field ViewType Create: " + viewType.getCreate().toString());
//Get the QuickCreate of the ViewType
console.log("Field ViewType QuickCreate: " + viewType.getQuickCreate().toString());
}
//Get the obtained Module instance
let subform = field.getSubform();
if (subform != null) {
//Get the Object obtained Layout instance
let layout = subform.getLayout();
//Check if layout is not null
if (layout != null) {
//Get the ID of the Layout
console.log("Field Subform Layout ID: " + layout.getId().toString());
//Get the Name of the Layout
console.log("Field Subform Layout Name: " + layout.getName());
}
//Get the DisplayLabel of the Module
console.log("Field Subform DisplayLabel: " + subform.getDisplayLabel());
//Get the APIName of the Module
console.log("Field Subform APIName: " + subform.getAPIName());
//Get the Module of the Module
console.log("Field Subform Module: " + subform.getModule());
if (subform.getId() != null) {
//Get the ID of the Module
console.log("Field Subform ID: " + subform.getId().toString());
}
}
//Get the APIName of each Field
console.log("Field APIName: " + field.getAPIName().toString());
//Get the obtained Unique instance
let unique = field.getUnique();
//Check if unique is not null
if (unique != null) {
//Get the Casesensitive of the Unique
console.log("Field Unique Casesensitive : " + unique.getCasesensitive());
}
//Get the DataType of each Field
console.log("Field DataType: " + field.getDataType().toString());
//Get the Object obtained Formula instance
let formula = field.getFormula();
//Check if formula is not null
if (formula != null) {
//Get the ReturnType of the Formula
console.log("Field Formula ReturnType : " + formula.getReturnType());
if (formula.getExpression() != null) {
//Get the Expression of the Formula
console.log("Field Formula Expression : " + formula.getExpression().toString());
}
}
if (field.getDecimalPlace() != null) {
//Get the DecimalPlace of each Field
console.log("Field DecimalPlace: " + field.getDecimalPlace().toString());
}
//Get the MassUpdate of each Field
console.log("Field MassUpdate: " + field.getMassUpdate());
if (field.getBlueprintSupported() != null) {
//Get the BlueprintSupported of each Field
console.log("Field BlueprintSupported: " + field.getBlueprintSupported().toString());
}
//Get all entries from the MultiSelectLookup instance
let multiSelectLookup = field.getMultiselectlookup();
//Check if multiSelectLookup is not null
if (multiSelectLookup != null) {
//Get the DisplayValue of the MultiSelectLookup
console.log("Field MultiSelectLookup DisplayLabel: " + multiSelectLookup.getDisplayLabel());
//Get the LinkingModule of the MultiSelectLookup
console.log("Field MultiSelectLookup LinkingModule: " + multiSelectLookup.getLinkingModule());
//Get the LookupApiname of the MultiSelectLookup
console.log("Field MultiSelectLookup LookupApiname: " + multiSelectLookup.getLookupApiname());
//Get the APIName of the MultiSelectLookup
console.log("Field MultiSelectLookup APIName: " + multiSelectLookup.getAPIName());
//Get the ConnectedModule of the MultiSelectLookup
console.log("Field MultiSelectLookup ConnectedModule: " + multiSelectLookup.getConnectedModule());
//Get the ConnectedlookupApiname of the MultiSelectLookup
console.log("Field MultiSelectLookup ConnectedlookupApiname: " + multiSelectLookup.getConnectedlookupApiname());
//Get the ID of the MultiSelectLookup
console.log("Field MultiSelectLookup ID: " + multiSelectLookup.getId());
}
let pickListValues = field.getPickListValues();
if (pickListValues != null) {
pickListValues.forEach(async pickListValue => {
await this.printPickListValue(pickListValue);
});
}
let autoNumber = field.getAutoNumber();
//Check if autoNumber is not null
if (autoNumber != null) {
//Get the Prefix of the AutoNumber
console.log("Field AutoNumber Prefix: " + autoNumber.getPrefix());
//Get the Suffix of the AutoNumber
console.log("Field AutoNumber Suffix: " + autoNumber.getSuffix());
if (autoNumber.getStartNumber() != null) {
//Get the StartNumber of the AutoNumber
console.log("Field AutoNumber StartNumber: " + autoNumber.getStartNumber().toString());
}
}
if(field.getDefaultValue() != null){
//Get the DefaultValue of each Field
console.log("Field DefaultValue: " + field.getDefaultValue().toString());
}
//Get the DisplayType of each Field
console.log("Field DisplayType: " + field.getDisplayType());
//Check if ValidationRule is not null
if(field.getValidationRule() != null) {
console.log("Field ValidationRule: \n");
Array.from(field.getValidationRule().keys()).forEach(key => {
console.log(key + ": " + field.getValidationRule().get(key));
});
}
console.log("Get field type" + field.getType());
let external = field.getExternal();
if (external != null) {
//Get the Show of External
console.log("Field External Show: " + external.getShow());
//Get the Type of External
console.log("Field External Type: " + external.getType());
//Get the AllowMultipleConfig of External
console.log("Field External AllowMultipleConfig: " + external.getAllowMultipleConfig());
}
//get multi user lookup for field
if (field.getMultiuserlookup() != null) {
let multiuserlookup = field.getMultiuserlookup();
//get displaylabel of multiuser lookup
console.log("Field MultiUserLookup DisplayLabel" + multiuserlookup.getDisplayLabel());
//get linking module of multiuser lookup
console.log("Field MultiUserLookup LinkingModule" + multiuserlookup.getLinkingModule());
//get lookup apiname of multiuser lookup
console.log("Field MultiUserLookup LookupApiname" + multiuserlookup.getLookupApiname());
//get apiname of multiuser lookup
console.log("Field MultiUserLookup APIName" + multiuserlookup.getAPIName());
//get id of multiuser lookup
console.log("Field MultiUserLookup ID" + multiuserlookup.getId());
//get connected module of multiuser lookup
console.log("Field MultiUserLookup ConnectedModule" + multiuserlookup.getConnectedModule());
//get connected lookup apiname of multiuser lookup
console.log("Field MultiUserLookup ConnectedlookupApiname" + multiuserlookup.getConnectedlookupApiname());
}
}
}
module.exports = {Layout}