Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

Scala SDK Samples - Fields Operations

Get Fields (Metadata)
Get Field (Metadata)
              
              
package com.zoho.crm.sample.fields

import java.util
import com.zoho.crm.api.ParameterMap
import com.zoho.crm.api.fields.APIException
import com.zoho.crm.api.fields.AssociationDetails
import com.zoho.crm.api.fields.AutoNumber
import com.zoho.crm.api.fields.Crypt
import com.zoho.crm.api.fields.Currency
import com.zoho.crm.api.fields.Field
import com.zoho.crm.api.fields.FieldsOperations
import com.zoho.crm.api.fields.FieldsOperations.GetFieldsParam
import com.zoho.crm.api.fields.Formula
import com.zoho.crm.api.fields.LookupField
import com.zoho.crm.api.fields.Module
import com.zoho.crm.api.fields.MultiSelectLookup
import com.zoho.crm.api.fields.PickListValue
import com.zoho.crm.api.fields.ResponseHandler
import com.zoho.crm.api.fields.ResponseWrapper
import com.zoho.crm.api.fields.ToolTip
import com.zoho.crm.api.fields.Unique
import com.zoho.crm.api.fields.ViewType
import com.zoho.crm.api.layouts.Layout
import com.zoho.crm.api.util.APIResponse
import com.zoho.crm.api.util.Model


object Fields {
  /**
   *  Get Field 
   * This method is used to get metadata about a single field of a module with fieldID and print the response.
   *
   * @param moduleAPIName The API Name of the field's module
   * @param fieldId       The ID of the field to be obtained
   * @throws Exception
   */
  @throws[Exception]
  def getField(moduleAPIName: String, fieldId: Long): Unit = { //example,
    //Long fieldId = 525505067912l
    val fieldOperations = new FieldsOperations(Option(moduleAPIName))
    //Call getField method which takes fieldId as parameter
    val responseOption = fieldOperations.getField(fieldId)
    if (responseOption.isDefined) {
      var response= responseOption.get
      println("Status Code: " + response.getStatusCode)
      if (util.Arrays.asList(204, 304).contains(response.getStatusCode)) {
        println(if (response.getStatusCode == 204) "No Content"
        else "Not Modified")
        return
      }
      if (response.isExpected) {
        val responseHandler = response.getObject
        if (responseHandler.isInstanceOf[ResponseWrapper]) {
          val responseWrapper = responseHandler.asInstanceOf[ResponseWrapper]
          val fields = responseWrapper.getFields
          
          for (field <- fields) {
            println("Field SystemMandatory: " + field.getSystemMandatory.toString)
            println("Field Webhook: " + field.getWebhook.toString)
            println("Field JsonType: " + field.getJsonType)
            val cryptOption = field.getCrypt
            if (cryptOption.isDefined) {
              val crypt=cryptOption.get
              println("Field Crypt Mode: " + crypt.getMode)
              println("Field Crypt Column: " + crypt.getColumn)
              println("Field Crypt Table: " + crypt.getTable)
              println("Field Crypt Status: " + crypt.getStatus.toString)
            }
            println("Field FieldLabel: " + field.getFieldLabel)
            val tooltipOption  = field.getTooltip
            if (tooltipOption.isDefined) {
              val tooltip= tooltipOption.get
              println("Field ToolTip Name: " + tooltip.getName)
              println("Field ToolTip Value: " + tooltip.getValue)
            }
            println("Field CreatedSource: " + field.getCreatedSource)
            println("Field FieldReadOnly: " + field.getFieldReadOnly.toString)
            println("Field DisplayLabel: " + field.getDisplayLabel)
            println("Field ReadOnly: " + field.getReadOnly.toString)
            val associationDetailsOption = field.getAssociationDetails
            if (associationDetailsOption.isDefined) {
              val associationDetails = associationDetailsOption.get
              val lookupFieldOption = associationDetails.getLookupField
              if (lookupFieldOption.isDefined) {
                val lookupField = lookupFieldOption.get
                println("Field AssociationDetails LookupField ID: " + lookupField.getId)
                println("Field AssociationDetails LookupField Name: " + lookupField.getName)
              }
              val relatedFieldOption= associationDetails.getRelatedField
              if (relatedFieldOption.isDefined) {
                val relatedField= relatedFieldOption.get
                println("Field AssociationDetails RelatedField ID: " + relatedField.getId)
                println("Field AssociationDetails RelatedField Name: " + relatedField.getName)
              }
            }
            if (field.getQuickSequenceNumber != null) println("Field QuickSequenceNumber: " + field.getQuickSequenceNumber.toString)
            println("Field BusinesscardSupported: " + field.getBusinesscardSupported.toString)
            if (field.getMultiModuleLookup != null) {

              field.getMultiModuleLookup.foreach(entry=>{
                println(entry._1 + ": " + entry._2)
              })
            }
            val currencyOption = field.getCurrency
            if (currencyOption.isDefined) {
              val currency = currencyOption.get
              println("Field Currency RoundingOption: " + currency.getRoundingOption)
              if (currency.getPrecision.isDefined) println("Field Currency Precision: " + currency.getPrecision.toString)
            }
            println("Field ID: " + field.getId.toString)
            if (field.getCustomField.isDefined) println("Field CustomField: " + field.getCustomField.toString)
            val lookupOption = field.getLookup
            if (lookupOption.isDefined) {
              val lookup= lookupOption.get
              val layoutOption = lookup.getLayout
              if (layoutOption.isDefined) {
                val layout = layoutOption.get
                println("Field ModuleLookup Layout ID: " + layout.getId.toString)
                println("Field ModuleLookup Layout Name: " + layout.getName)
              }
              println("Field ModuleLookup DisplayLabel: " + lookup.getDisplayLabel)
              println("Field ModuleLookup APIName: " + lookup.getAPIName)
              println("Field ModuleLookup Module: " + lookup.getModule)
              if (lookup.getId.isDefined) println("Field ModuleLookup ID: " + lookup.getId.toString)
            }
            if (field.getVisible.isDefined) println("Field Visible: " + field.getVisible.toString)
            if (field.getLength.isDefined) println("Field Length: " + field.getLength.toString)
            val viewTypeOption = field.getViewType
            if (viewTypeOption.isDefined) {
              val viewType = viewTypeOption.get
              println("Field ViewType View: " + viewType.getView.toString)
              println("Field ViewType Edit: " + viewType.getEdit.toString)
              println("Field ViewType Create: " + viewType.getCreate.toString)
              println("Field ViewType QuickCreate: " + viewType.getQuickCreate.toString)
            }
            val subformOption = field.getSubform
            if (subformOption.isDefined) {
              val subform = subformOption.get
              val layoutOption = subform.getLayout
              if (layoutOption.isDefined) {
                val layout = layoutOption.get
                println("Field Subform Layout ID: " + layout.getId.toString)
                println("Field Subform Layout Name: " + layout.getName)
              }
              println("Field Subform DisplayLabel: " + subform.getDisplayLabel)
              println("Field Subform APIName: " + subform.getAPIName)
              println("Field Subform Module: " + subform.getModule)
              if (subform.getId.isDefined) println("Field Subform ID: " + subform.getId.toString)
            }
            println("Field APIName: " + field.getAPIName.toString)
            val uniqueOption = field.getUnique
            if (uniqueOption.isDefined){
              val unique = uniqueOption.get
              println("Field Unique Casesensitive : " + unique.getCasesensitive)
            }
            if (field.getHistoryTracking.isDefined) println("Field HistoryTracking: " + field.getHistoryTracking.toString)
            println("Field DataType: " + field.getDataType.toString)
            val formulaOption = field.getFormula
            if (formulaOption.isDefined) {
              val formula = formulaOption.get
              println("Field Formula ReturnType : " + formula.getReturnType)
              if (formula.getExpression.isDefined) println("Field Formula Expression : " + formula.getExpression.toString)
            }
            if (field.getDecimalPlace.isDefined) println("Field DecimalPlace: " + field.getDecimalPlace.toString)
            println("Field MassUpdate: " + field.getMassUpdate.toString)
            if (field.getBlueprintSupported.isDefined) println("Field BlueprintSupported: " + field.getBlueprintSupported.toString)
            val multiSelectLookupOption = field.getMultiselectlookup
            if (multiSelectLookupOption.isDefined) {
              var multiSelectLookup = multiSelectLookupOption.get
              println("Field MultiSelectLookup DisplayLabel: " + multiSelectLookup.getDisplayLabel)
              println("Field MultiSelectLookup LinkingModule: " + multiSelectLookup.getLinkingModule)
              println("Field MultiSelectLookup LookupApiname: " + multiSelectLookup.getLookupApiname)
              println("Field MultiSelectLookup APIName: " + multiSelectLookup.getAPIName)
              println("Field MultiSelectLookup ConnectedlookupApiname: " + multiSelectLookup.getConnectedlookupApiname)
              println("Field MultiSelectLookup ID: " + multiSelectLookup.getId)
            }
            val pickListValues = field.getPickListValues
            if (pickListValues != null) {
              
              for (pickListValue <- pickListValues) {
                println("Field PickListValue DisplayValue: " + pickListValue.getDisplayValue)
                if (pickListValue.getSequenceNumber.isDefined) println(" Field PickListValue SequenceNumber: " + pickListValue.getSequenceNumber.toString)
                if (pickListValue.getExpectedDataType.isDefined) println("Field PickListValue ExpectedDataType: " + pickListValue.getExpectedDataType)
                println("Field PickListValue ActualValue: " + pickListValue.getActualValue)
                if (pickListValue.getMaps != null) {
                  
                  for (map <- pickListValue.getMaps) {
                    println(map)
                  }
                }
                println("Field PickListValue SysRefName: " + pickListValue.getSysRefName)
                println("Field PickListValue Type: " + pickListValue.getType)
              }
            }
            val autoNumberOption = field.getAutoNumber
            if (autoNumberOption.isDefined) {
              val autoNumber = autoNumberOption.get
              println("Field AutoNumber Prefix: " + autoNumber.getPrefix)
              println("Field AutoNumber Suffix: " + autoNumber.getSuffix)
              if (autoNumber.getStartNumber.isDefined) println("Field AutoNumber StartNumber: " + autoNumber.getStartNumber.toString)
            }
            if (field.getDefaultValue.isDefined) println("Field DefaultValue: " + field.getDefaultValue.toString)
            if (field.getSectionId.isDefined) println("Field SectionId: " + field.getSectionId.toString)
            if (field.getValidationRule != null) {

              field.getValidationRule.foreach(entry=>{
                println(entry._1 + ": " + entry._2)
              })
            }
            if (field.getConvertMapping != null) {

              field.getConvertMapping.foreach(entry=>{
                println(entry._1 + ": " + entry._2)
              })
            }
          }
        }
        else if (responseHandler.isInstanceOf[APIException]) {
          val exception = responseHandler.asInstanceOf[APIException]
          println("Status: " + exception.getStatus.getValue)
          println("Code: " + exception.getCode.getValue)
          println("Details: ")

          exception.getDetails.foreach(entry=>{
            println(entry._1 + ": " + entry._2)
          })
          println("Message: " + exception.getMessage.getValue)
        }
      }
      else {
        val responseObject = response.getModel
        val clas = responseObject.getClass
        val fields = clas.getDeclaredFields
        for (field <- fields) {
          println(field.getName + ":" + field.get(responseObject))
        }
      }
    }
  }
}