SETTINGS Methods
ZOHO.BIGIN.SETTINGS.getCustomViews(config) → {Promise}
Use this method for retrieving custom views of a module.
| Name | Type | Description |
|---|---|---|
config | Object | Configuration Object |
Entity | String | SysRefName of the module |
Id | String | (optional) layout ID |
Returns
| Type | Description |
|---|---|
| Promise | Resolved with data of Assignment rules matching with Entity |
Example
Request 1
CopiedZOHO.BIGIN.SETTINGS.getCustomViews({"Entity":"Contacts"}).then(function(data){
console.log(data);
});Response
Copied{
"categories": [
{
"display_value": "Created By Me",
"actual_value": "created_by_me"
},
{
"display_value": "Shared With Me",
"actual_value": "shared_with_me"
}
],
"custom_views": [
{
"display_value": "All Contacts",
"offline": true,
"default": true,
"system_name": "ALLVIEWS",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "All Contacts",
"id": "3000000028135",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Mailing Labels",
"offline": true,
"default": false,
"system_name": "ALLVIEWS",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "Mailing Labels",
"id": "3000000028144",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "My Contacts",
"offline": true,
"default": false,
"system_name": "MYVIEWS",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "My Contacts",
"id": "3000000028333",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "New Last Week",
"offline": true,
"default": false,
"system_name": "lastweek",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "New Last Week",
"id": "3000000028183",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "New This Week",
"offline": true,
"default": false,
"system_name": "thisweek",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "New This Week",
"id": "3000000028171",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Recently Created Contacts",
"offline": true,
"default": false,
"system_name": "RECENTLYCREATED",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "Recently Created Contacts",
"id": "3000000028195",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Recently Modified Contacts",
"offline": true,
"default": false,
"system_name": "RECENTLYMODIFIED",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "Recently Modified Contacts",
"id": "3000000028207",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Unread Contacts",
"offline": true,
"default": false,
"system_name": "UNREADVIEWS",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"name": "Unread Contacts",
"id": "3000000028156",
"category": "shared_with_me",
"favorite": null
}
],
"info": {
"per_page": 8,
"default": "3000000028135",
"count": 8,
"page": 1,
"more_records": false
}
}Request 2
CopiedZOHO.BIGIN.SETTINGS.getCustomViews({"Entity":"Contacts","Id":"3000000028135"}).then(function(data){
console.log(data);
});Response
Copied{
"categories": [
{
"display_value": "Created By Me",
"actual_value": "created_by_me"
},
{
"display_value": "Shared With Me",
"actual_value": "shared_with_me"
}
],
"custom_views": [
{
"display_value": "All Contacts",
"criteria": null,
"system_name": "ALLVIEWS",
"module": {
"api_name": "Contacts",
"id": "3000000000045"
},
"sort_by": null,
"offline": true,
"default": true,
"name": "All Contacts",
"id": "3000000028135",
"category": "shared_with_me",
"fields": [
{
"api_name": "Full_Name",
"id": "3000000000681"
},
{
"api_name": "Account_Name",
"id": "3000000000683"
},
{
"api_name": "Email",
"id": "3000000000687"
},
{
"api_name": "Phone",
"id": "3000000000695"
},
{
"api_name": "Owner",
"id": "3000000000673"
}
],
"favorite": null,
"sort_order": null
}
]
}ZOHO.BIGIN.SETTINGS.getFields(config) → {Promise}
Use this method for retrieving field labels and API names.
Name | Type | Description |
|---|---|---|
config | Object | Configuration Object |
Entity | String | SysRefName of the module |
Returns
Type | Description |
|---|---|
Promise | Resolved with data of record matching with Entity and type |
Example
Request
CopiedZOHO.BIGIN.SETTINGS.getFields({"Entity":"Contacts"}).then(function(data){
console.log(data);
});Response
Copied{
fields:[
{
"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": {
}
}
]
}ZOHO.BIGIN.SETTINGS.getLayouts(config) → {Promise}
Use this method for retrieving layout details of a module.
Name | Type | Description |
|---|---|---|
config | Object | Configuration Object |
Entity | String | SysRefName of the module |
Id | String | (optional) layout ID |
Returns
Type | Description |
|---|---|
Promise | Resolved with data of Assignment rules matching with Entity |
Examples
Request 1
CopiedZOHO.BIGIN.SETTINGS.getLayouts({"Entity":"Contacts"}).then(function(data){
console.log(data);
});Request 2
CopiedZOHO.BIGIN.SETTINGS.getLayouts({"Entity":"Contacts","LayoutId":"5000000000169"}).then(function(data){
console.log(data);
});Response
Copied{
"layouts": [
{
"created_time": null,
"modified_time": null,
"visible": true,
"name": "Standard",
"modified_by": null,
"profiles": [
{
"default": true,
"name": "Administrator",
"id": "3000000029725"
},
{
"default": true,
"name": "Standard",
"id": "3000000029728"
}
],
"id": "3000000000169",
"created_by": null,
"sections": [
{
"display_label": "Contact Information",
"sequence_number": 1,
"column_count": 2,
"name": "Contact Information",
"fields": [
{
"json_type": "jsonobject",
"field_label": "Contact Owner",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 8,
"read_only": false,
"currency": {},
"id": "3000000000673",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "SMOWNERID",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 1,
"show_type": 7,
"api_name": "Owner",
"unique": {},
"data_type": "ownerlookup",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Lead Source",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 2,
"read_only": false,
"currency": {},
"id": "3000000000675",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "LEADSOURCE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 2,
"show_type": 7,
"api_name": "Lead_Source",
"unique": {},
"data_type": "picklist",
"formula": {},
"decimal_place": null,
"pick_list_values": [
{
"display_value": "-None-",
"sequence_number": 1,
"maps": [],
"actual_value": "-None-"
},
{
"display_value": "Advertisement",
"sequence_number": 2,
"maps": [],
"actual_value": "Advertisement"
},
{
"display_value": "Cold Call",
"sequence_number": 3,
"maps": [],
"actual_value": "Cold Call"
},
{
"display_value": "Employee Referral",
"sequence_number": 4,
"maps": [],
"actual_value": "Employee Referral"
},
{
"display_value": "External Referral",
"sequence_number": 5,
"maps": [],
"actual_value": "External Referral"
},
{
"display_value": "Partner",
"sequence_number": 6,
"maps": [],
"actual_value": "Partner"
},
{
"display_value": "Public Relations",
"sequence_number": 7,
"maps": [],
"actual_value": "Public Relations"
},
{
"display_value": "Trade Show",
"sequence_number": 8,
"maps": [],
"actual_value": "Trade Show"
},
{
"display_value": "Web Form",
"sequence_number": 9,
"maps": [],
"actual_value": "Web Form"
},
{
"display_value": "Search Engine",
"sequence_number": 10,
"maps": [],
"actual_value": "Search Engine"
},
{
"display_value": "Facebook",
"sequence_number": 11,
"maps": [],
"actual_value": "Facebook"
},
{
"display_value": "Twitter",
"sequence_number": 12,
"maps": [],
"actual_value": "Twitter"
}
],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "First Name",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 27,
"read_only": false,
"currency": {},
"id": "3000000000677",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 40,
"column_name": "FIRSTNAME",
"view_type": {
"view": false,
"edit": true,
"quick_create": true,
"create": true
},
"default_value": null,
"sequence_number": 3,
"show_type": 7,
"api_name": "First_Name",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Last Name",
"tooltip": null,
"created_source": "default",
"required": true,
"ui_type": 127,
"read_only": false,
"currency": {},
"id": "3000000000679",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 80,
"column_name": "LASTNAME",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"default_value": null,
"sequence_number": 4,
"show_type": 7,
"api_name": "Last_Name",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Full Name",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000681",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 80,
"column_name": "FULLNAME",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"default_value": null,
"sequence_number": 5,
"show_type": 0,
"api_name": "Full_Name",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "jsonobject",
"field_label": "Account Name",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 4,
"read_only": false,
"currency": {},
"id": "3000000000683",
"custom_field": false,
"lookup": {
"display_label": "Contacts",
"api_name": "Contacts",
"module": {
"api_name": "Accounts",
"id": "3000000000043"
},
"id": "3000000003935"
},
"visible": true,
"length": 120,
"column_name": "ACCOUNTID",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"default_value": null,
"sequence_number": 6,
"show_type": 7,
"api_name": "Account_Name",
"unique": {},
"data_type": "lookup",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "jsonobject",
"field_label": "Vendor Name",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 9,
"read_only": false,
"currency": {},
"id": "3000000000685",
"custom_field": false,
"lookup": {
"display_label": "Contacts",
"api_name": "Contacts",
"module": {
"api_name": "Vendors",
"id": "3000000000099"
},
"id": "3000000012263"
},
"visible": true,
"length": 120,
"column_name": "VENDORID",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 7,
"show_type": 7,
"api_name": "Vendor_Name",
"unique": {},
"data_type": "lookup",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Email",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 25,
"read_only": false,
"currency": {},
"id": "3000000000687",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 100,
"column_name": "EMAIL",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"default_value": null,
"sequence_number": 8,
"show_type": 7,
"api_name": "Email",
"unique": {},
"data_type": "email",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Title",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000691",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 100,
"column_name": "TITLE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 10,
"show_type": 7,
"api_name": "Title",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Department",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000693",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 50,
"column_name": "DEPARTMENT",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 11,
"show_type": 7,
"api_name": "Department",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Phone",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 33,
"read_only": false,
"currency": {},
"id": "3000000000695",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 50,
"column_name": "PHONE",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"default_value": null,
"sequence_number": 12,
"show_type": 7,
"api_name": "Phone",
"unique": {},
"data_type": "phone",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Home Phone",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 33,
"read_only": false,
"currency": {},
"id": "3000000000697",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "HOMEPHONE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 13,
"show_type": 7,
"api_name": "Home_Phone",
"unique": {},
"data_type": "phone",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Other Phone",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 33,
"read_only": false,
"currency": {},
"id": "3000000000699",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "OTHERPHONE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 14,
"show_type": 7,
"api_name": "Other_Phone",
"unique": {},
"data_type": "phone",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Fax",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 35,
"read_only": false,
"currency": {},
"id": "3000000000701",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "FAX",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 15,
"show_type": 7,
"api_name": "Fax",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Mobile",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 33,
"read_only": false,
"currency": {},
"id": "3000000000703",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "MOBILE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 16,
"show_type": 7,
"api_name": "Mobile",
"unique": {},
"data_type": "phone",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Date of Birth",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 24,
"read_only": false,
"currency": {},
"id": "3000000000705",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 20,
"column_name": "BIRTHDAY",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 17,
"show_type": 7,
"api_name": "Date_of_Birth",
"unique": {},
"data_type": "date",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Assistant",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000707",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 50,
"column_name": "ASSISTANT",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 18,
"show_type": 7,
"api_name": "Assistant",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Asst Phone",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 33,
"read_only": false,
"currency": {},
"id": "3000000000709",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "ASSISTANTPHONE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 19,
"show_type": 7,
"api_name": "Asst_Phone",
"unique": {},
"data_type": "phone",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Reports To",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000711",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 50,
"column_name": "REPORTSTO",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 20,
"show_type": 7,
"api_name": "Reports_To",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "boolean",
"field_label": "Email Opt Out",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 301,
"read_only": false,
"currency": {},
"id": "3000000000713",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 5,
"column_name": "EMAILOPTOUT",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": false,
"sequence_number": 21,
"show_type": 7,
"api_name": "Email_Opt_Out",
"unique": {},
"data_type": "boolean",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Skype ID",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 37,
"read_only": false,
"currency": {},
"id": "3000000000715",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 50,
"column_name": "SKYPEIDENTITY",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 22,
"show_type": 7,
"api_name": "Skype_ID",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "jsonobject",
"field_label": "Created By",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 20,
"read_only": false,
"currency": {},
"id": "3000000000717",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "SMCREATORID",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"default_value": null,
"sequence_number": 23,
"show_type": 7,
"api_name": "Created_By",
"unique": {},
"data_type": "ownerlookup",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "jsonobject",
"field_label": "Modified By",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 20,
"read_only": false,
"currency": {},
"id": "3000000000719",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "MODIFIEDBY",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"default_value": null,
"sequence_number": 24,
"show_type": 7,
"api_name": "Modified_By",
"unique": {},
"data_type": "ownerlookup",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Created Time",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 200,
"read_only": false,
"currency": {},
"id": "3000000000721",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "CREATEDTIME",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"default_value": null,
"sequence_number": 25,
"show_type": 7,
"api_name": "Created_Time",
"unique": {},
"data_type": "datetime",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Modified Time",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 200,
"read_only": false,
"currency": {},
"id": "3000000000723",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "MODIFIEDTIME",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"default_value": null,
"sequence_number": 26,
"show_type": 7,
"api_name": "Modified_Time",
"unique": {},
"data_type": "datetime",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Salutation",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 2,
"read_only": false,
"currency": {},
"id": "3000000000727",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "SALUTATION",
"view_type": {
"view": false,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 28,
"show_type": 8,
"api_name": "Salutation",
"unique": {},
"data_type": "picklist",
"formula": {},
"decimal_place": null,
"pick_list_values": [
{
"display_value": "-None-",
"sequence_number": 1,
"maps": [],
"actual_value": "-None-"
},
{
"display_value": "Mr.",
"sequence_number": 2,
"maps": [],
"actual_value": "Mr."
},
{
"display_value": "Mrs.",
"sequence_number": 3,
"maps": [],
"actual_value": "Mrs."
},
{
"display_value": "Ms.",
"sequence_number": 4,
"maps": [],
"actual_value": "Ms."
}
],
"auto_number": {}
},
{
"json_type": "boolean",
"field_label": "Add to QuickBooks",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 301,
"read_only": false,
"currency": {},
"id": "3000000000729",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 5,
"column_name": "ADDTOQUICKBOOKS",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": false,
"sequence_number": 29,
"show_type": 7,
"api_name": "Add_to_QuickBooks",
"unique": {},
"data_type": "boolean",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Secondary Email",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 25,
"read_only": false,
"currency": {},
"id": "3000000000731",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 100,
"column_name": "ADDN_EMAIL",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 30,
"show_type": 7,
"api_name": "Secondary_Email",
"unique": {},
"data_type": "email",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Last Activity Time",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 786,
"read_only": false,
"currency": {},
"id": "3000000000737",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 120,
"column_name": "LASTACTIVITYTIME",
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"default_value": null,
"sequence_number": 33,
"show_type": 8,
"api_name": "Last_Activity_Time",
"unique": {},
"data_type": "datetime",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Twitter",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 22,
"read_only": false,
"currency": {},
"id": "3000000000739",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 50,
"column_name": "TWITTER",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 34,
"show_type": 7,
"api_name": "Twitter",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
}
]
},
{
"display_label": "Address Information",
"sequence_number": 2,
"column_count": 2,
"name": "Address Information",
"fields": [
{
"json_type": "string",
"field_label": "Mailing Street",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000747",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 250,
"column_name": "MAILINGSTREET",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 1,
"show_type": 7,
"api_name": "Mailing_Street",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Other Street",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000749",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 250,
"column_name": "OTHERSTREET",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 2,
"show_type": 7,
"api_name": "Other_Street",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Mailing City",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000751",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "MAILINGCITY",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 3,
"show_type": 7,
"api_name": "Mailing_City",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Other City",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000753",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "OTHERCITY",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 4,
"show_type": 7,
"api_name": "Other_City",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Mailing State",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000755",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "MAILINGSTATE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 5,
"show_type": 7,
"api_name": "Mailing_State",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Other State",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000757",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "OTHERSTATE",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 6,
"show_type": 7,
"api_name": "Other_State",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Mailing Zip",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000759",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "MAILINGZIP",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 7,
"show_type": 7,
"api_name": "Mailing_Zip",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Other Zip",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000761",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "OTHERZIP",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 8,
"show_type": 7,
"api_name": "Other_Zip",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Mailing Country",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000763",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "MAILINGCOUNTRY",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 9,
"show_type": 7,
"api_name": "Mailing_Country",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
},
{
"json_type": "string",
"field_label": "Other Country",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 1,
"read_only": false,
"currency": {},
"id": "3000000000765",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "OTHERCOUNTRY",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 10,
"show_type": 7,
"api_name": "Other_Country",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
}
]
},
{
"display_label": "Description Information",
"sequence_number": 3,
"column_count": 1,
"name": "Description Information",
"fields": [
{
"json_type": "string",
"field_label": "Description",
"tooltip": null,
"created_source": "default",
"required": false,
"ui_type": 3,
"read_only": false,
"currency": {},
"id": "3000000000767",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 1000,
"column_name": "DESCRIPTION",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"default_value": null,
"sequence_number": 1,
"show_type": 7,
"api_name": "Description",
"unique": {},
"data_type": "textarea",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"auto_number": {}
}
]
},
{
"display_label": "Score Summary",
"sequence_number": 4,
"column_count": 2,
"name": "Score Summary",
"fields": []
}
],
"status": 0
}
]
}ZOHO.BIGIN.SETTINGS.getModules() → {Promise}
Use this method for retrieving the list of modules.
Returns
Type | Description |
|---|---|
Promise | Resolved with data of all modules |
Example
Request
CopiedZOHO.BIGIN.SETTINGS.getModules().then(function(data){
console.log(data);
});Response
Copied{
"modules": [{
"global_search_supported": false,
"deletable": false,
"creatable": false,
"modified_time": null,
"plural_label": "Home",
"presence_sub_menu": false,
"id": "457154000000000123",
"visible": true,
"visibility": 1,
"convertable": false,
"editable": false,
"profiles": [{
"name": "Administrator",
"id": "457154000000015972"
},
{
"name": "Standard",
"id": "457154000000015975"
}
],
"filter_supported": false,
"web_link": null,
"sequence_number": 1,
"singular_label": "Home",
"viewable": true,
"api_supported": false,
"api_name": "Home",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": false,
"arguments": [],
"module_name": "Home",
"business_card_field_limit": 0,
"parent_module": {}
},
{
"global_search_supported": false,
"deletable": false,
"creatable": false,
"modified_time": null,
"plural_label": "SalesInbox",
"presence_sub_menu": false,
"id": "457154000000129001",
"visible": true,
"visibility": 1,
"convertable": false,
"editable": false,
"profiles": [{
"name": "Administrator",
"id": "457154000000015972"
},
{
"name": "Standard",
"id": "457154000000015975"
}
],
"filter_supported": false,
"web_link": null,
"sequence_number": 2,
"singular_label": "SalesInbox",
"viewable": true,
"api_supported": false,
"api_name": "SalesInbox",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": false,
"arguments": [],
"module_name": "SalesInbox",
"business_card_field_limit": 0,
"parent_module": {}
},
{
"global_search_supported": false,
"deletable": false,
"creatable": false,
"modified_time": null,
"plural_label": "Feeds",
"presence_sub_menu": false,
"id": "457154000000059001",
"visible": true,
"visibility": 1,
"convertable": false,
"editable": false,
"profiles": [],
"filter_supported": false,
"web_link": null,
"sequence_number": 3,
"singular_label": "Feeds",
"viewable": true,
"api_supported": false,
"api_name": "Feeds",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": false,
"arguments": [],
"module_name": "Feeds",
"business_card_field_limit": 0,
"parent_module": {}
},
{
"global_search_supported": true,
"deletable": true,
"creatable": true,
"modified_time": "2018-10-23T11:39:36+05:30",
"plural_label": "Contacts",
"presence_sub_menu": true,
"id": "457154000000000125",
"visible": true,
"visibility": 1,
"convertable": true,
"editable": true,
"profiles": [{
"name": "Administrator",
"id": "457154000000015972"
},
{
"name": "Standard",
"id": "457154000000015975"
}
],
"filter_supported": true,
"web_link": null,
"sequence_number": 4,
"singular_label": "Contact",
"viewable": true,
"api_supported": true,
"api_name": "Contacts",
"quick_create": true,
"modified_by": {
"name": "NareshAutomation",
"id": "457154000000148011"
},
"generated_type": "default",
"feeds_required": false,
"scoring_supported": true,
"arguments": [],
"module_name": "Contacts",
"business_card_field_limit": 5,
"parent_module": {}
},
{
"global_search_supported": true,
"deletable": true,
"creatable": true,
"modified_time": null,
"plural_label": "Accounts",
"presence_sub_menu": true,
"id": "457154000000000127",
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"profiles": [{
"name": "Administrator",
"id": "457154000000015972"
},
{
"name": "Standard",
"id": "457154000000015975"
}
],
"filter_supported": true,
"web_link": null,
"sequence_number": 5,
"singular_label": "Account",
"viewable": true,
"api_supported": true,
"api_name": "Accounts",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": true,
"arguments": [],
"module_name": "Accounts",
"business_card_field_limit": 5,
"parent_module": {}
}
]
}ZOHO.BIGIN.SETTINGS.getRelatedList(config) → {Promise}
Use this method for retrieving the meta information of related lists in a module.
Name | Type | Description |
|---|---|---|
config | Object | Configuration Object |
Entity | String | SysRefName of the module |
Returns
Type | Description |
|---|---|
Promise | Resolved with data of Assignment rules matching with Entity |
Example
Request
CopiedZOHO.BIGIN.SETTINGS.getRelatedList({"Entity":"Contacts"}).then(function(data){
console.log(data);
});Response
Copied{
"related_lists": [
{
"display_label": "Attachments",
"visible": true,
"api_name": "Attachments",
"module": {
"api_name": "Attachments",
"id": "3000000000111"
},
"name": "Attachments",
"id": "3000000003968",
"href": "Contacts/{ENTITYID}/Attachments",
"type": "default"
},
{
"display_label": "Deals",
"visible": true,
"api_name": "Deals",
"module": {
"api_name": "Deals",
"id": "3000000000047"
},
"name": "Deals",
"id": "3000000003974",
"href": "Contacts/{ENTITYID}/Deals",
"type": "default"
},
{
"display_label": "Notes",
"visible": true,
"api_name": "Notes",
"module": {
"api_name": "Notes",
"id": "3000000000069"
},
"name": "Notes",
"id": "3000000003971",
"href": "Contacts/{ENTITYID}/Notes",
"type": "default"
},
{
"display_label": "Open Activities",
"visible": true,
"api_name": "Activities",
"module": {
"api_name": "Activities",
"id": "3000000000049"
},
"name": "Activities",
"id": "3000000003965",
"href": "Contacts/{ENTITYID}/Activities",
"type": "default"
},
{
"display_label": "Closed Activities",
"visible": true,
"api_name": "Activities_History",
"module": {
"api_name": "Activities",
"id": "3000000000049"
},
"name": "Activities History",
"id": "3000000003962",
"href": "Contacts/{ENTITYID}/Activities_History",
"type": "default"
},
{
"display_label": "Products",
"visible": true,
"api_name": "Products",
"module": {
"api_name": "Products",
"id": "3000000000097"
},
"name": "Products",
"id": "3000000003977",
"href": "Contacts/{ENTITYID}/Products",
"type": "default"
},
{
"display_label": "Invited Events",
"visible": true,
"api_name": "Invited_Events",
"module": {
"api_name": "Events",
"id": "3000000000065"
},
"name": "Invited Events",
"id": "3000000004001",
"href": "Contacts/{ENTITYID}/Invited_Events",
"type": "default"
},
{
"display_label": "Cases",
"visible": true,
"api_name": "Cases",
"module": {
"api_name": "Cases",
"id": "3000000000093"
},
"name": "Cases",
"id": "3000000003980",
"href": "Contacts/{ENTITYID}/Cases",
"type": "default"
},
{
"display_label": "Quotes",
"visible": true,
"api_name": "Quotes",
"module": {
"api_name": "Quotes",
"id": "3000000000103"
},
"name": "Quotes",
"id": "3000000003983",
"href": "Contacts/{ENTITYID}/Quotes",
"type": "default"
},
{
"display_label": "Sales Orders",
"visible": true,
"api_name": "SalesOrders",
"module": {
"api_name": "Sales_Orders",
"id": "3000000000105"
},
"name": "SalesOrders",
"id": "3000000003986",
"href": "Contacts/{ENTITYID}/SalesOrders",
"type": "default"
},
{
"display_label": "Purchase Orders",
"visible": true,
"api_name": "PurchaseOrders",
"module": {
"api_name": "Purchase_Orders",
"id": "3000000000107"
},
"name": "PurchaseOrders",
"id": "3000000003989",
"href": "Contacts/{ENTITYID}/PurchaseOrders",
"type": "default"
},
{
"display_label": "Invoices",
"visible": true,
"api_name": "Invoices",
"module": {
"api_name": "Invoices",
"id": "3000000000109"
},
"name": "Invoices",
"id": "3000000003995",
"href": "Contacts/{ENTITYID}/Invoices",
"type": "default"
},
{
"display_label": "Campaigns",
"visible": true,
"api_name": "Campaigns",
"module": {
"api_name": "Campaigns",
"id": "3000000000055"
},
"name": "Campaigns",
"id": "3000000003998",
"href": "Contacts/{ENTITYID}/Campaigns",
"type": "default"
},
{
"display_label": "Social",
"visible": true,
"api_name": "Social",
"module": {
"api_name": "Social",
"id": "3000000000087"
},
"name": "Social",
"id": "3000000004067",
"href": null,
"type": "default"
}
]
}ZOHO.BIGIN.SETTINGS.getPipelines({"LayoutID":"xxxxxxxxxx34"}) → {Promise}
Use this method for retrieving Team Pipelines.
Name | Type | Description |
|---|---|---|
Id | String | (optional) layout ID |
Returns
Type | Description |
|---|---|
Promise | Resolved with data of Assignment rules matching with Entity |
Example
Request 1
CopiedZOHO.BIGIN.SETTINGS.getPipelines().then(function(data){
console.log(data);
});Response
Copied[
{
"sequence_number": 1,
"singular_label": "Deal",
"template": "sales_pipeline",
"layout": {
"name": "Sales Pipeline",
"id": "2056852000000095023"
},
"plural_label": "Deals",
"profiles": [
{
"default": true,
"name": "Administrator",
"id": "2056852000000015972",
"_default_view": {
"name": "Sales Pipeline",
"id": "2056852000000095023",
"type": "layout"
}
},
{
"default": true,
"name": "Standard",
"id": "2056852000000015975",
"_default_view": {
"name": "Sales Pipeline",
"id": "2056852000000095023",
"type": "layout"
}
}
],
"name": "Sales Pipeline",
"generated_type": "system",
"id": "2056852000000095023",
"sub_pipelines": [
{
"display_value": "Sales Pipeline Standard",
"actual_value": "Sales Pipeline Standard",
"id": "2056852000000459501"
},
{
"display_value": "newsubpipeline",
"actual_value": "newsubpipeline",
"id": "2056852000000481127"
}
]
},
{
"sequence_number": 2,
"singular_label": "NewPipe",
"layout": {
"name": "NewPipes",
"id": "2056852000000469006"
},
"plural_label": "NewPipes",
"profiles": [
{
"default": false,
"name": "Administrator",
"id": "2056852000000015972",
"_default_view": {
"name": "NewPipes",
"id": "2056852000000469006",
"type": "layout"
}
},
{
"default": false,
"name": "Standard",
"id": "2056852000000015975",
"_default_view": {
"name": "NewPipes",
"id": "2056852000000469006",
"type": "layout"
}
}
],
"name": "NewPipes",
"icon": "sales_pipeline",
"generated_type": "custom",
"id": "2056852000000469006",
"sub_pipelines": [
{
"display_value": "NewPipes Standard",
"actual_value": "NewPipes Standard",
"id": "2056852000000469184"
}
]
}
]Request 2
CopiedZOHO.BIGIN.SETTINGS.getPipelines({"PipelineId":"2056852000000095023"}).then(function(data){
console.log(data);
});Response
Copied[
{
"sequence_number": 1,
"singular_label": "Deal",
"template": "sales_pipeline",
"layout": {
"name": "Sales Pipeline",
"id": "2056852000000095023"
},
"plural_label": "Deals",
"profiles": [
{
"default": true,
"name": "Administrator",
"id": "2056852000000015972",
"_default_view": {
"name": "Sales Pipeline",
"id": "2056852000000095023",
"type": "layout"
}
},
{
"default": true,
"name": "Standard",
"id": "2056852000000015975",
"_default_view": {
"name": "Sales Pipeline",
"id": "2056852000000095023",
"type": "layout"
}
}
],
"name": "Sales Pipeline",
"generated_type": "system",
"id": "2056852000000095023",
"sub_pipelines": [
{
"display_value": "Sales Pipeline Standard",
"actual_value": "Sales Pipeline Standard",
"id": "2056852000000459501"
},
{
"display_value": "newsubpipeline",
"actual_value": "newsubpipeline",
"id": "2056852000000481127"
}
]
}
]ZOHO.BIGIN.SETTINGS.getSubPipelines({"SubPipelineId":"xxxxxxxxxx14","LayoutID":"xxxxxxxxxx34"}) → {Promise}
Use this method for retrieving Sub-pipelines.
Name | Type | Description |
|---|---|---|
Id | String | Layout ID |
Id | String | (optional) Sub-pipeline ID |
Returns
Type | Description |
|---|---|
Promise | Resolved with data of record matching with Entity and Type |
Example
Request 1
CopiedZOHO.BIGIN.SETTINGS.getSubPipelines({"LayoutId":"2056852000000095023"}).then(function(data){
console.log(data);
});Response
Copied[
{
"display_value": "Sales Pipeline Standard",
"default": true,
"stages": [
{
"display_value": "Qualification",
"sequence_number": 1,
"actual_value": "Qualification",
"id": "2056852000000007104",
"forecast_type": "Open"
},
{
"display_value": "Needs Analysis",
"sequence_number": 2,
"actual_value": "Needs Analysis",
"id": "2056852000000007106",
"forecast_type": "Open"
},
{
"display_value": "Proposal/Price Quote",
"sequence_number": 3,
"actual_value": "Proposal/Price Quote",
"id": "2056852000000007112",
"forecast_type": "Open"
},
{
"display_value": "NewStage3",
"sequence_number": 4,
"actual_value": "NewStage3",
"id": "2056852000000471008",
"forecast_type": "Open"
},
{
"display_value": "NewStahe04",
"sequence_number": 5,
"actual_value": "NewStahe04",
"id": "2056852000000471018",
"forecast_type": "Open"
},
{
"display_value": "Negotiation/Review",
"sequence_number": 6,
"actual_value": "Negotiation/Review",
"id": "2056852000000007114",
"forecast_type": "Open"
},
{
"display_value": "Closed Won",
"sequence_number": 7,
"actual_value": "Closed Won",
"id": "2056852000000007116",
"forecast_type": "Closed Won"
},
{
"display_value": "Closed Lost",
"sequence_number": 8,
"actual_value": "Closed Lost",
"id": "2056852000000007118",
"forecast_type": "Closed Lost"
}
],
"actual_value": "Sales Pipeline Standard",
"id": "2056852000000459501"
},
{
"display_value": "newsubpipeline",
"stages": [
{
"display_value": "Needs Analysis",
"sequence_number": 1,
"actual_value": "Needs Analysis",
"id": "2056852000000007106",
"forecast_type": "Open"
},
{
"display_value": "NewStage3",
"sequence_number": 2,
"actual_value": "NewStage3",
"id": "2056852000000471008",
"forecast_type": "Open"
},
{
"display_value": "Closed Won",
"sequence_number": 3,
"actual_value": "Closed Won",
"id": "2056852000000007116",
"forecast_type": "Closed Won"
},
{
"display_value": "Closed Lost",
"sequence_number": 4,
"actual_value": "Closed Lost",
"id": "2056852000000007118",
"forecast_type": "Closed Lost"
}
],
"actual_value": "newsubpipeline",
"id": "2056852000000481127"
}
]Request 2
CopiedZOHO.BIGIN.SETTINGS.getSubPipelines({"SubPipelineId":"2056852000000481127", "LayoutId":"2056852000000095023"}).then(function(data){
console.log(data);
});Response
Copied[
{
"display_value": "newsubpipeline",
"stages": [
{
"display_value": "Needs Analysis",
"sequence_number": 1,
"actual_value": "Needs Analysis",
"id": "2056852000000007106",
"forecast_type": "Open"
},
{
"display_value": "NewStage3",
"sequence_number": 2,
"actual_value": "NewStage3",
"id": "2056852000000471008",
"forecast_type": "Open"
},
{
"display_value": "Closed Won",
"sequence_number": 3,
"actual_value": "Closed Won",
"id": "2056852000000007116",
"forecast_type": "Closed Won"
},
{
"display_value": "Closed Lost",
"sequence_number": 4,
"actual_value": "Closed Lost",
"id": "2056852000000007118",
"forecast_type": "Closed Lost"
}
],
"actual_value": "newsubpipeline",
"id": "2056852000000481127"
}
]