Class Hierarchy - Node JS SDK

Class Hierarchy - Node JS SDK

All Zoho CRM entities are modelled as modules having classes, methods and instance variables applicable to that particular entity. ZCRMRestClient is the base class of the Python SDK. ZCRMRestClient has methods to get instances of various other Zoho CRM entities.
  • zcrmsdk is the base class of the SDK.
  • This class has, methods to get instances of various other Zoho CRM entities.
  • The class relations and hierarchy of the SDK follows the entity hierarchy inside Zoho CRM.
  • Each class entity has functions to fetch its own properties and to fetch data of its immediate child entities through an API call.For example: a Zoho CRM module object will have member functions to get a module’s properties like display name, module Id, etc, and will also have functions to fetch all its child objects.
The class relations and hierarchy of the SDK follows the entity hierarchy inside Zoho CRM. The class hierarchy of various Zoho CRM entities are given below:

zcrmsdk
      API
            ORG
                  get
            MODULES
                  get
                  post
                  put
                  delete
                  getAllDeletedRecords
                  getRecycleBinRecords
                  getPermanentlyDeletedRecords
                  search
            SETTINGS
                  getFields
                  getLayouts
                  getCustomViews
                  updateCustomViews
                  getModules
                  getRoles
                  getProfiles
                  getRelatedLists
            ACTIONS
                  convert
            USERS
                  get
            ATTACHMENTS
                  uploadFile
                  deleteFile
                  downloadFile
                  uploadLink
                  uploadPhoto
                  downloadPhoto
                  deletePhoto
            FUNCTIONS
                  executeFunctionsInGet
                  executeFunctionsInPost

As appearing in the hierarchy, zcrmsdk class will have instance variables to fetch its own properties and to fetch data of its immediate child entities through an API call.

For example, to call an API to get module data, the request should be 
zcrmsdk.API.MODULES.{operation_type}

The operation types can be GET, POST, PUT, DELETE or CREATE.

Accessing record properties

Since record properties are dynamic across modules, we have only given the common fields like createdTime, createdBy, owner etc, as ZCRMRecord’s default members. All other record properties are available as a map in ZCRMRecord object.

To access the individual field values of a record, use the getter and setter methods available. The keys of the record properties map are the API names of the module’s fields. API names of all fields of all modules are available under,

Setup → Marketplace → APIs → CRM API → API Names

    • Related Articles

    • Node JS SDK - An Overview

      Node JS SDK offers a way to create client node js applications that can be integrated with Zoho CRM. This SDK makes the access and use of necessary CRM APIs with ease. In other words, it serves as a wrapper for the REST APIs, making it easier to use ...

    • Class Hierarchy - C# SDK

      All Zoho CRM entities are modelled as modules having classes, methods and instance variables applicable to that particular entity. ZCRMRestClient is the base class of the C# SDK. ZCRMRestClient has methods to get instances of various other Zoho CRM ...

    • Class Hierarchy - Java SDK

      All Zoho CRM entities are modelled as classes having members and methods applicable to that particular entity. ZCRMRestClient is the base class of the SDK. This class has, methods to get instances of various other Zoho CRM entities. The class ...

    • Class Hierarchy - PHP SDK

      All Zoho CRM entities are modelled as classes having members and methods applicable to that particular entity. ZCRMRestClient is the base class of the SDK. This class has, methods to get instances of various other Zoho CRM entities. The class ...

    • Installation - Node JS SDK

      Node JS SDK will be installed and a package named 'zcrmsdk' will be created in the local machine. The package can be added using the following code: var ZCRMRestClient = require('zcrmsdk') Installing the SDK Run the command below to install the Node ...