Node JS SDK Samples - Fields Operations
Get Fields (Metadata)
Get Field (Metadata)
const { FieldsOperations, GetFieldsParam } = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/fields/fields_operations");
const { APIException } = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/contact_roles/api_exception");
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.1/core/com/zoho/crm/api/fields/response_wrapper").ResponseWrapper;
const ParameterMap = require("@zohocrm/nodejs-sdk-2.1/routes/parameter_map").ParameterMap;
class Field{
/**
* Get Field
* This method is used to get metadata about a single field of a module with fieldID and print the response.
* @param {String} moduleAPIName The API Name of the field's module
* @param {BigInt} fieldId The ID of the field to be obtained
*/
static async getField(moduleAPIName, fieldId) {
//example
// let moduleAPIName = "module_api_name"
// let fieldId = 93043n
//Get instance of FieldsOperations Class that takes moduleAPIName as parameter
let fieldsOperations = new FieldsOperations(moduleAPIName);
//Call getField method which takes fieldId as parameter
let response = await fieldsOperations.getField(fieldId);
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 Field instances
let fields = responseObject.getFields();
fields.forEach(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) {
//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 Type of each Field
console.log("Field Type: " + field.getType());
//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 DisplayType of each Field
console.log("Field DisplayType: " + field.getDisplayType());
//Get the UIType of each Field
console.log("Field UIType: " + field.getUiType());
//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());
}
}
if (field.getQuickSequenceNumber() != null) {
//Get the QuickSequenceNumber of each Field
console.log("Field QuickSequenceNumber: " + field.getQuickSequenceNumber().toString());
}
if (field.getBusinesscardSupported() != null) {
//Get the BusinesscardSupported of each Field
console.log("Field BusinesscardSupported: " + field.getBusinesscardSupported().toString());
}
//Get the MultiModuleLookup of each Field
let multiModuleLookup = field.getMultiModuleLookup();
if (multiModuleLookup != null) {
//Get the APIName of MultiModuleLookup
console.log("Field MultiModuleLookup Name: " + multiModuleLookup.getName());
//Get the Id of MultiModuleLookup
console.log("Field MultiModuleLookup Id: " + multiModuleLookup.getId());
let module1 = multiModuleLookup.getModule();
if (module1 != null) {
//Get the APIName of MultiModuleLookup Module
console.log("Field MultiModuleLookup Module APIName: " + module1.getAPIName());
//Get the Id of MultiModuleLookup Module
console.log("Field MultiModuleLookup Module Id: " + module1.getId());
}
}
//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());
}
}
//Get the ID of each Field
console.log("Field ID: " + field.getId());
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 Filterable of each Field
console.log("Field Filterable: " + field.getFilterable());
if (field.getVisible() != null) {
//Get the Visible of each Field
console.log("Field Visible: " + field.getVisible().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());
}
if(field.getDisplayField() != null) {
//check if field is DisplayField
console.log("Field DisplayField " + field.getDisplayField());
}
//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 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());
}
}
if(field.getSequenceNumber() != null) {
//get UI type of field
console.log("Field sequence number " + field.getSequenceNumber());
}
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 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());
}
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 DisplayLabel" + module.getDisplayLabel());
console.log("Module APIName" + module.getAPIName());
console.log("Module ID" + module.getId());
console.log("Module Module" + module.getModule());
console.log("Module ModuleName"+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());
}
}
//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 ConnectedlookupApiname of the MultiSelectLookup
console.log("Field MultiSelectLookup ConnectedlookupApiname: " + multiSelectLookup.getConnectedlookupApiname());
//Get the ID of the MultiSelectLookup
console.log("Field MultiSelectLookup ID: " + multiSelectLookup.getId());
//Get the connected module of the MultiSelectLookup
console.log("Field MultiSelectLookup ConnectedModule: " + multiSelectLookup.getConnectedModule());
}
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());
}
//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));
});
}
//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));
});
}
//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());
}
});
}
//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 = 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());
}
}
}
}
}
module.exports = {Field}