get field lables and api names
Name |
Type |
Description |
config |
Object
|
Configuration Object.
Name |
Type |
Description |
Entity |
String
|
SysRefName of the module. |
|
Returns:
Type |
Description |
Promise
|
Resolved with data of record matching with Entity and type |
Example
ZOHO.CRM.META.API.getFields({"Entity":"Contacts"}).then(function(data){
console.log(data);
});
//prints
[
{
"custom_field": false,
"lookup": {
},
"visible": true,
"json_type": "jsonobject",
"field_label": "Contact Owner",
"length": 120,
"column_name": "SMOWNERID",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"created_source": "default",
"show_type": 7,
"ui_type": 8,
"read_only": false,
"api_name": "Owner",
"unique": {
},
"businesscard_supported": true,
"data_type": "ownerlookup",
"formula": {
},
"currency": {
},
"id": "14000000000649",
"decimal_place": null,
"pick_list_values": [
],
"auto_number": {
}
},
{
"custom_field": false,
"lookup": {
},
"visible": true,
"json_type": "string",
"field_label": "Lead Source",
"length": 120,
"column_name": "LEADSOURCE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"created_source": "default",
"show_type": 7,
"ui_type": 2,
"read_only": false,
"api_name": "Lead_Source",
"unique": {
},
"businesscard_supported": true,
"data_type": "picklist",
"formula": {
},
"currency": {
},
"id": "14000000000651",
"decimal_place": null,
"pick_list_values": [
{
"display_value": "None",
"actual_value": "-None-"
},
{
"display_value": "Advertisement",
"actual_value": "Advertisement"
},
{
"display_value": "Cold Call",
"actual_value": "Cold Call"
},
{
"display_value": "Employee Referral",
"actual_value": "Employee Referral"
},
{
"display_value": "External Referral",
"actual_value": "External Referral"
},
{
"display_value": "Partner",
"actual_value": "Partner"
},
{
"display_value": "Public Relations",
"actual_value": "Public Relations"
},
{
"display_value": "Trade Show",
"actual_value": "Trade Show"
},
{
"display_value": "Web Form",
"actual_value": "Web Form"
},
{
"display_value": "Search Engine",
"actual_value": "Search Engine"
},
{
"display_value": "Facebook",
"actual_value": "Facebook"
},
{
"display_value": "Twitter",
"actual_value": "Twitter"
}
],
"auto_number": {
}
},
{
"custom_field": false,
"lookup": {
},
"visible": true,
"json_type": "string",
"field_label": "First Name",
"length": 40,
"column_name": "FIRSTNAME",
"view_type": {
"view": false,
"edit": true,
"quick_create": true,
"create": true
},
"created_source": "default",
"show_type": 7,
"ui_type": 27,
"read_only": false,
"api_name": "First_Name",
"unique": {
},
"businesscard_supported": false,
"data_type": "text",
"formula": {
},
"currency": {
},
"id": "14000000000653",
"decimal_place": null,
"pick_list_values": [
],
"auto_number": {
}
},
{
"custom_field": false,
"lookup": {
},
"visible": true,
"json_type": "string",
"field_label": "Last Name",
"length": 80,
"column_name": "LASTNAME",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"created_source": "default",
"show_type": 7,
"ui_type": 127,
"read_only": false,
"api_name": "Last_Name",
"unique": {
},
"businesscard_supported": false,
"data_type": "text",
"formula": {
},
"currency": {
},
"id": "14000000000655",
"decimal_place": null,
"pick_list_values": [
],
"auto_number": {
}
},
{
"custom_field": false,
"lookup": {
},
"visible": true,
"json_type": "string",
"field_label": "Full Name",
"length": 80,
"column_name": "FULLNAME",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"created_source": "default",
"show_type": 0,
"ui_type": 1,
"read_only": false,
"api_name": "Full_Name",
"unique": {
},
"businesscard_supported": false,
"data_type": "text",
"formula": {
},
"currency": {
},
"id": "14000000000657",
"decimal_place": null,
"pick_list_values": [
],
"auto_number": {
}
}
]
get Modules list
Returns:
Type |
Description |
Promise
|
Resolved with data of all modules |
Example
ZOHO.CRM.META.API.getModules().then(function(data){
console.log(data);
});
//prints
[
{
"visible": true,
"convertable": false,
"editable": false,
"deletable": false,
"profiles": [
],
"display_field": null,
"creatable": false,
"web_link": null,
"sequence_number": 2,
"singular_label": "Feeds",
"modified_time": null,
"viewable": true,
"api_supported": false,
"plural_label": "Feeds",
"api_name": "Feeds",
"modified_by": null,
"generated_type": "default",
"scoring_supported": false,
"id": "14000000000037",
"module_name": "Feeds",
"business_card_field_limit": 0,
"parent_module": {
}
},
{
"visible": true,
"convertable": true,
"editable": true,
"deletable": true,
"profiles": [
{
"name": "Administrator",
"id": "14000000029270"
},
{
"name": "Standard",
"id": "14000000029273"
}
],
"display_field": {
"api_name": "Full_Name",
"id": "14000000000827"
},
"creatable": true,
"web_link": null,
"sequence_number": 3,
"singular_label": "Lead",
"modified_time": null,
"viewable": true,
"api_supported": true,
"plural_label": "Leads",
"api_name": "Leads",
"modified_by": null,
"generated_type": "default",
"scoring_supported": true,
"id": "14000000000039",
"module_name": "Leads",
"business_card_field_limit": 5,
"parent_module": {
}
},
{
"visible": true,
"convertable": false,
"editable": true,
"deletable": true,
"profiles": [
{
"name": "Administrator",
"id": "14000000029270"
},
{
"name": "Standard",
"id": "14000000029273"
}
],
"display_field": {
"api_name": "Account_Name",
"id": "14000000000573"
},
"creatable": true,
"web_link": null,
"sequence_number": 4,
"singular_label": "Account",
"modified_time": null,
"viewable": true,
"api_supported": true,
"plural_label": "Accounts",
"api_name": "Accounts",
"modified_by": null,
"generated_type": "default",
"scoring_supported": true,
"id": "14000000000041",
"module_name": "Accounts",
"business_card_field_limit": 5,
"parent_module": {
}
},
{
"visible": true,
"convertable": false,
"editable": true,
"deletable": true,
"profiles": [
{
"name": "Administrator",
"id": "14000000029270"
},
{
"name": "Standard",
"id": "14000000029273"
}
],
"display_field": {
"api_name": "Full_Name",
"id": "14000000000657"
},
"creatable": true,
"web_link": null,
"sequence_number": 5,
"singular_label": "Contact",
"modified_time": null,
"viewable": true,
"api_supported": true,
"plural_label": "Contacts",
"api_name": "Contacts",
"modified_by": null,
"generated_type": "default",
"scoring_supported": true,
"id": "14000000000043",
"module_name": "Contacts",
"business_card_field_limit": 5,
"parent_module": {
}
}
]