Custom Views Meta Data
Purpose
To get the custom views data of a particular module.
Request Details
Request URL
{api-domain}/crm/v2/settings/custom_views?module={module_api_name}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Activities
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.custom_views.READ
(or)
scope=ZohoCRM.settings.custom_views.ALL
(or)
scope=ZohoCRM.settings.ALL
Parameters
- modulestring, mandatory
Specify the API name of the required module. For example, Leads, Contacts, Accounts, Deals, and so on.
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/settings/custom_views?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copied//Get instance of CustomViewOperations Class that takes moduleAPIName as parameter
let customViewsOperations = new ZCRM.CustomView.Operations(moduleAPIName);
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Possible parameters of Get CustomViews operation
paramInstance.add(ZCRM.CustomView.Model.GetCustomViewsParam.PAGE, 1);
paramInstance.add(ZCRM.CustomView.Model.GetCustomViewsParam.PER_PAGE, 20);
//Call getCustomViews method that takes ParameterMap instance as parameter
let response = await customViewsOperations.getCustomViews(paramInstance);
Copiedvar listener = 0;
class CustomViewsMetaData {
async getCustomViews() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/custom_views"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new CustomViewsMetaData().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
parameters.set("module", "Leads")
parameters.set("page", "1")
parameters.set("per_page", "4")
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new CustomViewsMetaData().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getCustomView() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/custom_views/347706187501"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new CustomViewsMetaData().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
parameters.set("module", "Leads")
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new CustomViewsMetaData().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getToken(token) {
if(listener == 0) {
window.addEventListener("storage", function(reponse) {
if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
location.reload();
}
if(reponse.key === "access_token"){
sessionStorage.removeItem("__auth_process");
}
}, false);
listener = 1;
if(sessionStorage.getItem("__auth_process")) {
sessionStorage.removeItem("__auth_process");
}
}
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists) {
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
var valueInStore = sessionStorage.getItem("access_token");
var tokenInit = sessionStorage.getItem("__token_init");
if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
valueInStore = null;
sessionStorage.removeItem("access_token");
}
var auth_process = sessionStorage.getItem("__auth_process");
if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
var accountsUrl = "https://zylkercorp.zohoplatform.com/oauth/v2/auth"
var clientId;
var scope;
var redirectUrl;
if(token != null) {
clientId = token.clientId;
scope = token.scope;
redirectUrl = token.redirectUrl;
}
var fullGrant = sessionStorage.getItem("full_grant");
var grantedForSession = sessionStorage.getItem("granted_for_session");
if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
accountsUrl += '/refresh';
}
if (clientId && scope) {
sessionStorage.setItem("__token_init", Date.now());
sessionStorage.removeItem("access_token");
sessionStorage.setItem("__auth_process", "true");
window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists){
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
valueInStore = sessionStorage.getItem("access_token");
}
}
if(token != null && valueInStore != 'undefined'){
token.accessToken = valueInStore;
}
return token.accessToken;
}
async makeAPICall(requestDetails) {
return new Promise(function (resolve, reject) {
var body, xhr, i;
body = requestDetails.body || null;
xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.open(requestDetails.method, requestDetails.uri, true);
for (i in requestDetails.headers) {
xhr.setRequestHeader(i, requestDetails.headers[i]);
}
xhr.send(body);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
resolve(xhr);
}
}
})
}
}
Copiedresponse = invokeurl
[
url: "https://zylkercorp.zohoplatform.com/crm/v2/settings/custom_views?module=Leads"
type: GET
connection:"crm_oauth_connection"
];
info response;
Response JSON Keys
- display_valuestring
Represents the display name of the current custom view.
- offlineboolean
Represents if the current custom view is available for offline view.
true: The custom view is available offline.
false: The custom view is not available offline. - defaultboolean
Represents if the current custom view is the default view.
true: The current custom view is the default view.
false: The current custom view is not the default view. - system_namestring
Represents the system reference name of the current custom view.
- system_definedboolean
Represents if the current custom view is a system-defined view.
true: The current custom view is system-defined.
false: The current custom view is not system-defined. - namestring
Represents the name of the current custom view.
- idstring
Represents the unique ID of the current custom view.
- categorystring
Represents the category of the current custom view. The value can be: public_views, other_users_views, shared_with_me, or created_by_me.
- favoriteinteger
Represents if the current custom view is marked as favorite.
Possible Errors
- REQUIRED_PARAM_MISSINGHTTP 400
Bad Request
Resolution: You have not specified the mandatory parameter. Refer to parameters section above. - INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.custom_views.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read custom view data. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read custom views data
Resolution: The user does not have the permission to retrieve custom views data. Contact your system administrator.
Sample Response
Copied{
"custom_views": [
{
"display_value": "All Leads",
"offline": true,
"default": false,
"system_name": "ALLVIEWS",
"system_defined": true,
"name": "All Open Leads",
"id": "3652397000000087501",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Converted Leads",
"offline": true,
"default": false,
"system_name": "CONVERTEDVIEWS",
"system_defined": true,
"name": "Converted Leads",
"id": "3652397000000089005",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Email Opt Out",
"offline": true,
"default": true,
"system_name": null,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"favorite": null
},
{
"display_value": "Junk Leads",
"offline": true,
"default": false,
"system_name": "JUNKLEADVIEWS",
"system_defined": true,
"name": "Junk Leads",
"id": "3652397000000149020",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Mailing Labels",
"offline": true,
"default": false,
"system_name": "ALLVIEWS",
"system_defined": true,
"name": "Mailing Labels",
"id": "3652397000000087503",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "My Converted Leads",
"offline": true,
"default": false,
"system_name": "MYCONVERTEDVIEWS",
"system_defined": true,
"name": "My Converted Leads",
"id": "3652397000000089007",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "My Leads",
"offline": true,
"default": false,
"system_name": "MYVIEWS",
"system_defined": true,
"name": "My Leads",
"id": "3652397000000087563",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Not Qualified Leads",
"offline": true,
"default": false,
"system_name": "NOTQUALIFIEDLEADVIEWS",
"system_defined": true,
"name": "Not Qualified Leads",
"id": "3652397000000149031",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Open Leads",
"offline": true,
"default": false,
"system_name": "OPENLEADVIEWS",
"system_defined": true,
"name": "Open Leads",
"id": "3652397000000149042",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Recently Created Leads",
"offline": true,
"default": false,
"system_name": "RECENTLYCREATED",
"system_defined": true,
"name": "Recently Created Leads",
"id": "3652397000000087509",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Recently Modified Leads",
"offline": true,
"default": false,
"system_name": "RECENTLYMODIFIED",
"system_defined": true,
"name": "Recently Modified Leads",
"id": "3652397000000087511",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Today's Leads",
"offline": true,
"default": false,
"system_name": "today",
"system_defined": true,
"name": "Todays Leads",
"id": "3652397000000087507",
"category": "shared_with_me",
"favorite": null
},
{
"display_value": "Unread Leads",
"offline": true,
"default": false,
"system_name": "UNREADVIEWS",
"system_defined": true,
"name": "Unread Leads",
"id": "3652397000000087505",
"category": "shared_with_me",
"favorite": null
}
],
"info": {
"per_page": 200,
"default": "3652397000000538003",
"count": 13,
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
},
"page": 1,
"more_records": false
}
}