C# SDK Samples - Fields Operations
Get Fields (Metadata)
Get Field (Metadata)
using System;
using Com.Zoho.Crm.API.Fields;
using System.Collections.Generic;
using Com.Zoho.Crm.API;
using Com.Zoho.Crm.API.Util;
using static Com.Zoho.Crm.API.Fields.FieldsOperations;
using Newtonsoft.Json;
using Com.Zoho.Crm.API.Layouts;
using ResponseHandler = Com.Zoho.Crm.API.Fields.ResponseHandler;
using ResponseWrapper = Com.Zoho.Crm.API.Fields.ResponseWrapper;
using APIException = Com.Zoho.Crm.API.Fields.APIException;
using System.Reflection;
using Module = Com.Zoho.Crm.API.Fields.Module;
namespace Com.Zoho.Crm.Sample.Fields
{
public class Fields
{
/// <summary>
/// This method is used to get metadata about a single field of a module with fieldID and print the response.
/// </summary>
/// <param name="moduleAPIName">The API Name of the field's module</param>
/// <param name="fieldId">The ID of the field to be obtained</param>
public static void GetField(string moduleAPIName, long fieldId)
{
//example,
//string moduleAPIName = "module_api_name";
//long fieldId = 5252);
//Get instance of FieldsOperations Class that takes moduleAPIName as parameter
FieldsOperations fieldOperations = new FieldsOperations(moduleAPIName);
//Call GetField method which takes fieldId as parameter
APIResponse<ResponseHandler>response = fieldOperations.GetField(fieldId);
if(response != null)
{
//Get the status code from response
Console.WriteLine("Status Code: " + response.StatusCode);
if( new List<int>() { 204, 304 }.Contains(response.StatusCode))
{
Console.WriteLine(response.StatusCode == 204? "No Content" : "Not Modified");
return;
}
//Check if expected response is received
if(response.IsExpected)
{
//Get object from response
ResponseHandler responseHandler = response.Object;
if(responseHandler is ResponseWrapper)
{
//Get the received ResponseWrapper instance
ResponseWrapper responseWrapper = (ResponseWrapper) responseHandler;
//Get the list of obtained Field instances
List<Field> fields = responseWrapper.Fields;
foreach(Field field in fields)
{
//Get the SystemMandatory of each Field
Console.WriteLine("Field SystemMandatory: " + field.SystemMandatory);
//Get the Webhook of each Field
Console.WriteLine("Field Webhook: " + field.Webhook);
//Get the JsonType of each Field
Console.WriteLine("Field JsonType: " + field.JsonType);
//Get the Object obtained Private instance
Private private1 = field.Private;
//Check if private is not null
if (private1 != null)
{
//Get the Restricted of the Private
Console.WriteLine("Field Private Restricted: " + private1.Restricted);
//Get the Export of the Private
Console.WriteLine("Field Private Export: " + private1.Export);
//Get the Type of the Private
Console.WriteLine("Field Private Type: " + private1.Type);
}
//Get the Object obtained Crypt instance
Crypt crypt = field.Crypt;
//Check if crypt is not null
if(crypt != null)
{
//Get the Mode of the Crypt
Console.WriteLine("Field Crypt Mode: " + crypt.Mode);
//Get the Column of the Crypt
Console.WriteLine("Field Crypt Column: " + crypt.Column);
//Get the Table of the Crypt
Console.WriteLine("Field Crypt Table: " + crypt.Table);
//Get the Status of the Crypt
Console.WriteLine("Field Crypt Status: " + crypt.Status);
List<string> encFldIds = crypt.Encfldids;
if(encFldIds != null)
{
Console.WriteLine("EncFldIds : ");
foreach(string encFldId in encFldIds)
{
Console.WriteLine(encFldId);
}
}
//Get the Notify of the Crypt
Console.WriteLine("Field Crypt Notify: " + crypt.Notify);
}
//Get the FieldLabel of each Field
Console.WriteLine("Field FieldLabel: " + field.FieldLabel);
//Get the Object obtained ToolTip instance
ToolTip tooltip = field.Tooltip;
//Check if tooltip is not null
if(tooltip != null)
{
//Get the Name of the ToolTip
Console.WriteLine("Field ToolTip Name: " + tooltip.Name);
//Get the Value of the ToolTip
Console.WriteLine("Field ToolTip Value: " + tooltip.Value);
}
//Get the CreatedSource of each Field
Console.WriteLine("Field CreatedSource: " + field.CreatedSource);
//Get the Type of each Field
Console.WriteLine("Field Type: " + field.Type);
//Get the FieldReadOnly of each Field
Console.WriteLine("Field FieldReadOnly: " + field.FieldReadOnly);
//Get the DisplayLabel of each Field
Console.WriteLine("Field DisplayLabel: " + field.DisplayLabel);
//Get the DisplayType of each Field
Console.WriteLine("Field DisplayType: " + field.DisplayType.Value);
//Get the UIType of each Field
Console.WriteLine("Field UIType: " + field.UiType);
//Get the ReadOnly of each Field
Console.WriteLine("Field ReadOnly: " + field.ReadOnly);
//Get the Object obtained AssociationDetails instance
AssociationDetails associationDetails = field.AssociationDetails;
//Check if associationDetails is not null
if(associationDetails != null)
{
//Get the Object obtained LookupField instance
LookupField lookupField = associationDetails.LookupField;
//Check if lookupField is not null
if(lookupField != null)
{
//Get the ID of the LookupField
Console.WriteLine("Field AssociationDetails LookupField ID: " + lookupField.Id);
//Get the Name of the LookupField
Console.WriteLine("Field AssociationDetails LookupField Name: " + lookupField.Name);
}
//Get the Object obtained LookupField instance
LookupField relatedField = associationDetails.RelatedField;
//Check if relatedField is not null
if(relatedField != null)
{
//Get the ID of the relatedField
Console.WriteLine("Field AssociationDetails RelatedField ID: " + relatedField.Id);
//Get the Name of the relatedField
Console.WriteLine("Field AssociationDetails RelatedField Name: " + relatedField.Name);
}
}
if(field.QuickSequenceNumber != null)
{
//Get the QuickSequenceNumber of each Field
Console.WriteLine("Field QuickSequenceNumber: " + field.QuickSequenceNumber);
}
//Get the BusinesscardSupported of each Field
Console.WriteLine("Field BusinesscardSupported: " + field.BusinesscardSupported);
//Get the MultiModuleLookup of each Field
MultiModuleLookup multiModuleLookup = field.MultiModuleLookup;
if (multiModuleLookup != null)
{
API.Fields.Module module = multiModuleLookup.Module;
if (module != null)
{
//Get the APIName of MultiModuleLookup Module
Console.WriteLine("Field MultiModuleLookup Module APIName: " + module.APIName);
//Get the Id of MultiModuleLookup Module
Console.WriteLine("Field MultiModuleLookup Module Id: " + module.Id);
}
//Get the APIName of MultiModuleLookup
Console.WriteLine("Field MultiModuleLookup Name: " + multiModuleLookup.Name);
//Get the Id of MultiModuleLookup
Console.WriteLine("Field MultiModuleLookup Id: " + multiModuleLookup.Id);
}
//Get the Object obtained Currency instance
Com.Zoho.Crm.API.Fields.Currency currency = field.Currency;
//Check if currency is not null
if(currency != null)
{
//Get the RoundingOption of the Currency
Console.WriteLine("Field Currency RoundingOption: " + currency.RoundingOption);
if(currency.Precision != null)
{
//Get the Precision of the Currency
Console.WriteLine("Field Currency Precision: " + currency.Precision);
}
}
//Get the ID of each Field
Console.WriteLine("Field ID: " + field.Id);
if(field.CustomField != null)
{
//Get the CustomField of each Field
Console.WriteLine("Field CustomField: " + field.CustomField);
}
//Get the Object obtained Module instance
Module lookup = field.Lookup;
//Check if lookup is not null
if(lookup != null)
{
//Get the Object obtained Layout instance
Layout layout = lookup.Layout;
//Check if layout is not null
if(layout != null)
{
//Get the ID of the Layout
Console.WriteLine("Field ModuleLookup Layout ID: " + layout.Id);
//Get the Name of the Layout
Console.WriteLine("Field ModuleLookup Layout Name: " + layout.Name);
}
//Get the DisplayLabel of the Module
Console.WriteLine("Field ModuleLookup DisplayLabel: " + lookup.DisplayLabel);
//Get the APIName of the Module
Console.WriteLine("Field ModuleLookup APIName: " + lookup.APIName);
//Get the Module of the Module
Console.WriteLine("Field ModuleLookup Module: " + lookup.Module_1);
if(lookup.Id != null)
{
//Get the ID of the Module
Console.WriteLine("Field ModuleLookup ID: " + lookup.Id);
}
//Get the ModuleName of the Module
Console.WriteLine("Field Lookup ModuleName: " + lookup.ModuleName);
}
//Get the Filterable of each Field
Console.WriteLine("Field Filterable: " + field.Filterable);
if(field.Visible != null)
{
//Get the Visible of each Field
Console.WriteLine("Field Visible: " + field.Visible);
}
List<API.Profiles.Profile> profiles = field.Profiles;
if(profiles != null)
{
foreach(API.Profiles.Profile profile in profiles)
{
//Get the PermissionType of each Profile
Console.WriteLine("Field Profile PermissionType: " + profile.PermissionType);
//Get the Name of each Profile
Console.WriteLine("Field Profile Name: " + profile.Name);
//Get the Id of each Profile
Console.WriteLine("Field Profile Id: " + profile.Id);
}
}
if(field.Length != null)
{
//Get the Length of each Field
Console.WriteLine("Field Length: " + field.Length);
}
//Get the Object obtained ViewType instance
ViewType viewType = field.ViewType;
//Check if viewType is not null
if(viewType != null)
{
//Get the View of the ViewType
Console.WriteLine("Field ViewType View: " + viewType.View);
//Get the Edit of the ViewType
Console.WriteLine("Field ViewType Edit: " + viewType.Edit);
//Get the Create of the ViewType
Console.WriteLine("Field ViewType Create: " + viewType.Create);
//Get the View of the ViewType
Console.WriteLine("Field ViewType QuickCreate: " + viewType.QuickCreate);
}
if(field.DisplayField != null)
{
//check if field is DisplayField
Console.WriteLine("Field DisplayField " + field.DisplayField);
}
//Get the PickListValuesSortedLexically of each Field
Console.WriteLine("Field PickListValuesSortedLexically: " + field.PickListValuesSortedLexically);
//Get the Sortable of each Field
Console.WriteLine("Field Sortable: " + field.Sortable);
//Get the Object obtained Module instance
Module subform = field.Subform;
//Check if Subform is not null
if (subform != null)
{
//Get the Object obtained Layout instance
Layout layout = subform.Layout;
//Check if layout is not null
if(layout != null)
{
//Get the ID of the Layout
Console.WriteLine("Field Subform Layout ID: " + layout.Id);
//Get the Name of the Layout
Console.WriteLine("Field Subform Layout Name: " + layout.Name);
}
//Get the DisplayLabel of the Module
Console.WriteLine("Field Subform DisplayLabel: " + subform.DisplayLabel);
//Get the APIName of the Module
Console.WriteLine("Field Subform APIName: " + subform.APIName);
//Get the Module of the Module
Console.WriteLine("Field Subform Module: " + subform.Module_1);
if(subform.Id != null)
{
//Get the ID of the Module
Console.WriteLine("Field Subform ID: " + subform.Id);
}
}
if(field.SequenceNumber != null)
{
//get UI type of field
Console.WriteLine("Field sequence number " + field.SequenceNumber);
}
External external = field.External;
if(external != null)
{
//Get the Show of External
Console.WriteLine("Field External Show: " + external.Show);
//Get the Type of External
Console.WriteLine("Field External Type: " + external.Type);
//Get the AllowMultipleConfig of External
Console.WriteLine("Field External AllowMultipleConfig: " + external.AllowMultipleConfig);
}
//Get the APIName of each Field
Console.WriteLine("Field APIName: " + field.APIName);
//Get the Object obtained Unique instance
Unique unique = field.Unique;
//Check if unique is not null
if(unique != null)
{
//Get the Casesensitive of the Unique
Console.WriteLine("Field Unique Casesensitive " + unique.Casesensitive);
}
if(field.HistoryTracking != null)
{
HistoryTracking historytracking = field.HistoryTracking;
//Get the Module of history tracking
Module module = historytracking.Module;
if (module != null)
{
Layout moduleLayout = module.Layout;
if (moduleLayout != null)
{
Console.WriteLine("Module layout id" + moduleLayout.Id);
}
Console.WriteLine("Module display label" + module.DisplayLabel);
Console.WriteLine("Module api name" + module.APIName);
Console.WriteLine("Module id" + module.Id);
Console.WriteLine("Module module" + module.Module_1);
Console.WriteLine("Module module name" + module.ModuleName);
}
//Get the duration configured field of each history tracking
Field durationConfigured = historytracking.DurationConfiguredField;
if(durationConfigured != null)
{
Console.WriteLine("historytracking duration configured field" + durationConfigured.Id);
}
}
//Get the DataType of each Field
Console.WriteLine("Field DataType: " + field.DataType);
//Get the Object obtained Formula instance
Formula formula = field.Formula;
//Check if foreachmula is not null
if(formula != null)
{
//Get the ReturnType of the Formula
Console.WriteLine("Field Formula ReturnType in " + formula.ReturnType);
if(formula.Expression != null)
{
//Get the Expression of the Formula
Console.WriteLine("Field Formula Expression in " + formula.Expression);
}
}
if(field.DecimalPlace != null)
{
//Get the DecimalPlace of each Field
Console.WriteLine("Field DecimalPlace: " + field.DecimalPlace);
}
//Get the MassUpdate of each Field
Console.WriteLine("Field MassUpdate: " + field.MassUpdate);
if(field.BlueprintSupported != null)
{
//Get the BlueprintSupported of each Field
Console.WriteLine("Field BlueprintSupported: " + field.BlueprintSupported);
}
//Get all entries from the MultiSelectLookup instance
MultiSelectLookup multiSelectLookup = field.Multiselectlookup;
//Check if foreachmula is not null
if(multiSelectLookup != null)
{
//Get the DisplayValue of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup DisplayLabel: " + multiSelectLookup.DisplayLabel);
//Get the LinkingModule of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup LinkingModule: " + multiSelectLookup.LinkingModule);
//Get the LookupApiname of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup LookupApiname: " + multiSelectLookup.LookupApiname);
//Get the APIName of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup APIName: " + multiSelectLookup.APIName);
//Get the ConnectedlookupApiname of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup ConnectedlookupApiname: " + multiSelectLookup.ConnectedlookupApiname);
//Get the ID of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup ID: " + multiSelectLookup.Id);
//Get the connected module of the MultiSelectLookup
Console.WriteLine("Field MultiSelectLookup connected module: " + multiSelectLookup.ConnectedModule);
}
//Get the PickListValue of each Field
List<PickListValue> pickListValues = field.PickListValues;
//Check if foreachmula is not null
if(pickListValues != null)
{
foreach(PickListValue pickListValue in pickListValues)
{
PrintPickListValue(pickListValue);
}
}
//Get the AutoNumber of each Field
AutoNumber autoNumber = field.AutoNumber;
//Check if autoNumber is not null
if(autoNumber != null)
{
//Get the Prefix of the AutoNumber
Console.WriteLine("Field AutoNumber Prefix: " + autoNumber.Prefix);
//Get the Suffix of the AutoNumber
Console.WriteLine("Field AutoNumber Suffix: " + autoNumber.Suffix);
if(autoNumber.StartNumber != null)
{
//Get the StartNumber of the AutoNumber
Console.WriteLine("Field AutoNumber StartNumber: " + autoNumber.StartNumber);
}
}
if(field.DefaultValue != null)
{
//Get the DefaultValue of each Field
Console.WriteLine("Field DefaultValue: " + field.DefaultValue);
}
//Check if ValidationRule is not null
if(field.ValidationRule != null)
{
//Get the details map
foreach(KeyValuePair<string, object> entry in field.ValidationRule)
{
//Get each value in the map
Console.WriteLine(entry.Key + ": " + entry.Value);
}
}
if(field.ConvertMapping != null)
{
//Get the ConvertMapping of each Field
Console.WriteLine("Transition Fields ConvertMapping: ");
//Get the details map
foreach (KeyValuePair<string, object> entry in field.ConvertMapping)
{
//Get each value in the map
Console.WriteLine(entry.Key + " : " + JsonConvert.SerializeObject(entry.Value));
}
}
//get multi user lookup for field
if (field.Multiuserlookup != null)
{
MultiUserLookup multiuserlookup = field.Multiuserlookup;
//get displaylabel of multiuser lookup
Console.WriteLine("Get multiuserlookup display label" + multiuserlookup.DisplayLabel);
//get linking module of multiuser lookup
Console.WriteLine("Get multiuserlookup linking module" + multiuserlookup.LinkingModule);
//get lookup apiname of multiuser lookup
Console.WriteLine("Get multiuserlookup lookup api_name" + multiuserlookup.LookupApiname);
//get apiname of multiuser lookup
Console.WriteLine("Get multiuserlookup api name" + multiuserlookup.APIName);
//get id of multiuser lookup
Console.WriteLine("Get multiuserlookup id" + multiuserlookup.Id);
//get connected module of multiuser lookup
Console.WriteLine("Get multiuserlookup connected module" + multiuserlookup.ConnectedModule);
//get connected lookup apiname of multiuser lookup
Console.WriteLine("Get multiuserlookup connected lookup api name" + multiuserlookup.ConnectedlookupApiname);
}
}
}
//Check if the request returned an exception
else if(responseHandler is APIException)
{
//Get the received APIException instance
APIException exception = (APIException) responseHandler;
//Get the Status
Console.WriteLine("Status: " + exception.Status.Value);
//Get the Code
Console.WriteLine("Code: " + exception.Code.Value);
Console.WriteLine("Details: " );
//Get the details map
foreach(KeyValuePair<string, object> entry in exception.Details)
{
//Get each value in the map
Console.WriteLine(entry.Key + ": " + JsonConvert.SerializeObject(entry.Value));
}
//Get the Message
Console.WriteLine("Message: " + exception.Message.Value);
}
}
else
{ //If response is not as expected
//Get model object from response
Model responseObject = response.Model;
//Get the response object's class
Type type = responseObject.GetType();
//Get all declared fields of the response class
Console.WriteLine("Type is: {0}", type.Name);
PropertyInfo[] props = type.GetProperties();
Console.WriteLine("Properties (N = {0}):", props.Length);
foreach (var prop in props)
{
if (prop.GetIndexParameters().Length == 0)
{
Console.WriteLine("{0} ({1}) : {2}", prop.Name, prop.PropertyType.Name, prop.GetValue(responseObject));
}
else
{
Console.WriteLine("{0} ({1}) : <Indexed>", prop.Name, prop.PropertyType.Name);
}
}
}
}
}
}
}