zcrmsdk
Version:
Node JS SDK for Zoho CRM
1,524 lines • 228 kB
JSON
{
"core/com/zoho/crm/api/record/api_exception": {
"code": {
"values": [
"FEATURE_NOT_SUPPORTED",
"CONVERTED_RECORD",
"NOT_FOUND",
"NO_RECORDS_FOUND",
"NOT_APPROVED",
"LIMIT_EXCEEDED",
"ALREADY_SCHEDULED",
"CANNOT_PERFORM_ACTION",
"CANNOT_PROCESS",
"INTERNAL_ERROR",
"INVALID_TOKEN",
"INVALID_DATA",
"MANDATORY_NOT_FOUND",
"NO_PERMISSION",
"INVALID_MODULE",
"NOT_SUPPORTED",
"PATTERN_NOT_MATCHED",
"OAUTH_SCOPE_MISMATCH",
"DUPLICATE_DATA",
"INVALID_QUERY",
"MAPPING_MISMATCH",
"ID_ALREADY_CONVERTED",
"FILE_SIZE_MORE_THAN_ALLOWED_SIZE",
"RECORD_IN_BLUEPRINT",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"Not Modified",
"AUTHENTICATION_FAILURE",
"CANNOT_DELETE",
"REQUIRED_PARAM_MISSING",
"DATA_MISMATCH",
"RECORD_LOCKED"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "permissions",
"type": "List"
},
{
"name": "param_name",
"type": "String"
},
{
"name": "api_name",
"type": "String"
},
{
"name": "id",
"type": "Long"
},
{
"name": "module",
"type": "String"
},
{
"name": "expected_data_type",
"type": "String"
},
{
"name": "index",
"type": "Integer"
},
{
"name": "maximum_length",
"type": "String"
},
{
"name": "mapped_field",
"type": "String"
},
{
"name": "reason",
"type": "String"
},
{
"name": "operator",
"type": "String"
},
{
"name": "allowed_count",
"type": "Integer"
},
{
"name": "limit",
"type": "Integer"
},
{
"name": "json_path",
"type": "String"
},
{
"name": "parent_api_name",
"type": "String"
},
{
"name": "param",
"type": "String"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"the id given seems to be invalid.",
"Already an Mass Action scheduler is runing for the given cvid",
"Scheduled Mass Operation feature is not available in your edition",
"can't update the converted record",
"Field cannot be updated in Scheduled Mass Update",
"Field is not visible",
"Field cannot be updated as it is associated with a validation rule.",
"Field cannot be updated as it is associated with a layout rule.This field cannot be updated in the Mass Update",
"Max field limit exceeded",
"Maximum lookup field limit in criteria exceeded",
"No field found",
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"The module name given seems to be invalid",
"Territory is not supported for the given module",
"Please check whether the input values are correct",
"invalid data",
"permission denied",
"Internal server error occurred.",
"duplicate data",
"required field not found",
"Layout doesn't contain the Pipeline",
"Pipeline doesn't contain the Stage",
"the id given seems to be invalid",
"record not deleted",
"record not deletable",
"Authentication failed",
"One of the expected parameter is missing",
"mandatory param missing",
"invalid query formed",
"id already converted",
"body",
"given id is invalid",
"Already a Mass Action scheduler is running for the given cvid",
"The record is in stop processing",
"The record is in blue print",
"no permission to perform an action on this record",
"Record count exceeded",
"record not approved",
"no record found to update",
"Field Edit Permission not given",
"Customview not accessible",
"Empty response",
"give contact id is mismatched with the data",
"give account id is mismatched with the data"
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/related_lists/response_handler": {
"classes": [
"core/com/zoho/crm/api/related_lists/response_wrapper",
"core/com/zoho/crm/api/related_lists/api_exception"
],
"interface": true
},
"core/com/zoho/crm/api/variables/action_handler": {
"classes": [
"core/com/zoho/crm/api/variables/api_exception",
"core/com/zoho/crm/api/variables/action_wrapper"
],
"interface": true
},
"core/com/zoho/crm/api/query/response_wrapper": {
"data": {
"structure_name": "core/com/zoho/crm/api/record/record",
"name": "data",
"type": "List"
},
"info": {
"structure_name": "core/com/zoho/crm/api/record/info",
"name": "info",
"type": "core/com/zoho/crm/api/record/info"
}
},
"core/com/zoho/crm/api/modules/get_modules_header": {
"IfModifiedSince": {
"name": "If-Modified-Since",
"type": "DateTime"
}
},
"core/com/zoho/crm/api/attachments/file_body_wrapper": {
"file": {
"name": "file",
"type": "utils/util/stream_wrapper",
"required": true
}
},
"core/com/zoho/crm/api/notification/success_response": {
"code": {
"values": [
"SUCCESS"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"structure_name": "core/com/zoho/crm/api/notification/notification",
"name": "events",
"type": "List"
},
{
"name": "resource_uri",
"type": "String"
},
{
"name": "resource_id",
"type": "String"
},
{
"name": "channel_id",
"type": "Long"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"Successfully subscribed for actions-watch of the given module",
"Successfully un-subscribed from actions-watch",
"Successfully updated the subscribe details",
"Successfully removed the subscribe details"
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"success"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/roles/role": {
"displayLabel": {
"name": "display_label",
"type": "String"
},
"forecastManager": {
"structure_name": "core/com/zoho/crm/api/users/user",
"name": "forecast_manager",
"type": "core/com/zoho/crm/api/users/user"
},
"adminUser": {
"name": "admin_user",
"type": "Boolean"
},
"shareWithPeers": {
"name": "share_with_peers",
"type": "Boolean"
},
"name": {
"name": "name",
"type": "String"
},
"description": {
"name": "description",
"type": "String"
},
"id": {
"name": "id",
"type": "Long",
"primary": true
},
"reportingTo": {
"structure_name": "core/com/zoho/crm/api/users/user",
"name": "reporting_to",
"type": "core/com/zoho/crm/api/users/user"
}
},
"core/com/zoho/crm/api/record/convert_action_wrapper": {
"data": {
"structure_name": "core/com/zoho/crm/api/record/convert_action_response",
"name": "data",
"type": "List"
}
},
"core/com/zoho/crm/api/fields/get_field_param": {
"module": {
"name": "module",
"type": "String"
}
},
"core/com/zoho/crm/api/notes/body_wrapper": {
"data": {
"structure_name": "core/com/zoho/crm/api/notes/note",
"name": "data",
"max-length": 100,
"type": "List",
"required": true,
"min-length": 1
}
},
"core/com/zoho/crm/api/record/deleted_records_wrapper": {
"data": {
"structure_name": "core/com/zoho/crm/api/record/deleted_record",
"name": "data",
"type": "List"
},
"info": {
"structure_name": "core/com/zoho/crm/api/record/info",
"name": "info",
"type": "core/com/zoho/crm/api/record/info"
}
},
"core/com/zoho/crm/api/related_records/response_handler": {
"classes": [
"core/com/zoho/crm/api/related_records/api_exception",
"core/com/zoho/crm/api/related_records/response_wrapper",
"core/com/zoho/crm/api/related_records/file_body_wrapper"
],
"interface": true
},
"core/com/zoho/crm/api/modules/argument": {
"name": {
"name": "name",
"type": "String"
},
"value": {
"name": "value",
"type": "String"
}
},
"core/com/zoho/crm/api/notes/note": {
"owner": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/users/user",
"name": "Owner",
"type": "core/com/zoho/crm/api/users/user"
},
"modifiedTime": {
"name": "Modified_Time",
"type": "DateTime"
},
"noteTitle": {
"name": "Note_Title",
"type": "String"
},
"noteContent": {
"name": "Note_Content",
"type": "String",
"required": true
},
"attachments": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/attachments/attachment",
"name": "$attachments",
"type": "List"
},
"voiceNote": {
"name": "$voice_note",
"type": "Boolean"
},
"editable": {
"name": "$editable",
"type": "Boolean"
},
"isSharedToClient": {
"name": "$is_shared_to_client",
"type": "Boolean"
},
"parentId": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/record/record",
"name": "Parent_Id",
"type": "core/com/zoho/crm/api/record/record",
"required": true
},
"seModule": {
"name": "$se_module",
"type": "String",
"required": true
},
"size": {
"name": "$size",
"type": "String"
},
"createdBy": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/users/user",
"name": "Created_By",
"type": "core/com/zoho/crm/api/users/user"
},
"createdTime": {
"name": "Created_Time",
"type": "DateTime"
},
"modifiedBy": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/users/user",
"name": "Modified_By",
"type": "core/com/zoho/crm/api/users/user"
},
"state": {
"name": "$state",
"type": "String"
},
"id": {
"name": "id",
"type": "Long",
"primary": true
}
},
"core/com/zoho/crm/api/taxes/action_wrapper": {
"taxes": {
"structure_name": "core/com/zoho/crm/api/taxes/action_response",
"name": "taxes",
"type": "List"
}
},
"core/com/zoho/crm/api/users/customize_info": {
"bcView": {
"name": "bc_view",
"type": "String"
},
"showDetailView": {
"name": "show_detail_view",
"type": "Boolean"
},
"showHome": {
"name": "show_home",
"type": "Boolean"
},
"showRightPanel": {
"name": "show_right_panel",
"type": "String"
},
"notesDesc": {
"name": "notes_desc",
"type": "Boolean"
},
"unpinRecentItem": {
"name": "unpin_recent_item",
"type": "String"
}
},
"core/com/zoho/crm/api/contact_roles/api_exception": {
"code": {
"values": [
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"INVALID_MODULE",
"DUPLICATE_DATA",
"LIMIT_EXCEEDED",
"MANDATORY_NOT_FOUND",
"INVALID_DATA",
"INTERNAL_ERROR"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "api_name",
"type": "String"
},
{
"name": "id",
"type": "Long"
},
{
"name": "limit",
"type": "Integer"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"the module name given seems to be invalid",
"duplicate data",
"Contact Role feature limit exceeded",
"required field not found",
"invalid data",
"contact role not deleted",
"Internal server error occurred."
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/related_records/api_exception": {
"code": {
"values": [
"NO_PERMISSION",
"CANNOT_BE_UPDATED",
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"INVALID_DATA",
"INTERNAL_ERROR"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "permissions",
"type": "List"
},
{
"name": "id",
"type": "Long"
},
{
"name": "param_name",
"type": "String"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"invalid data",
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"record not deleted",
"the related id given seems to be invalid",
"Internal server error occurred.",
"The relation name given seems to be invalid"
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/notification/disable_notifications_param": {
"channelIds": {
"name": "channel_ids",
"type": "Long"
}
},
"core/com/zoho/crm/api/record/get_mass_update_status_param": {
"jobId": {
"name": "job_id",
"type": "String"
}
},
"core/com/zoho/crm/api/fields/unique": {
"casesensitive": {
"name": "casesensitive",
"type": "String"
}
},
"core/com/zoho/crm/api/related_lists/related_list": {
"displayLabel": {
"name": "display_label",
"type": "String"
},
"sequenceNumber": {
"name": "sequence_number",
"type": "String"
},
"apiName": {
"name": "api_name",
"type": "String"
},
"module": {
"name": "module",
"type": "String"
},
"name": {
"name": "name",
"type": "String"
},
"action": {
"name": "action",
"type": "String"
},
"id": {
"name": "id",
"type": "Long",
"primary": true
},
"href": {
"name": "href",
"type": "String"
},
"type": {
"name": "type",
"type": "String"
},
"connectedmodule": {
"name": "connectedmodule",
"type": "String"
},
"linkingmodule": {
"name": "linkingmodule",
"type": "String"
}
},
"core/com/zoho/crm/api/variables/response_handler": {
"classes": [
"core/com/zoho/crm/api/variables/response_wrapper",
"core/com/zoho/crm/api/variables/api_exception"
],
"interface": true
},
"core/com/zoho/crm/api/fields/response_wrapper": {
"fields": {
"structure_name": "core/com/zoho/crm/api/fields/field",
"name": "fields",
"type": "List"
}
},
"core/com/zoho/crm/api/layouts/response_wrapper": {
"layouts": {
"structure_name": "core/com/zoho/crm/api/layouts/layout",
"name": "layouts",
"type": "List"
}
},
"core/com/zoho/crm/api/bulk_write/upload_file_header": {
"feature": {
"values": [
"bulk-write"
],
"name": "feature",
"type": "String"
},
"XCRMORG": {
"name": "X-CRM-ORG",
"type": "String"
}
},
"core/com/zoho/crm/api/users/api_exception": {
"code": {
"values": [
"ID_ALREADY_DELETED",
"CANNOT_UPDATE_DELETED_USER",
"AUTHORIZATION_FAILED",
"PATTERN_NOT_MATCHED",
"INVALID_REQUEST",
"LICENSE_LIMIT_EXCEEDED",
"DUPLICATE_DATA",
"INVALID_DATA",
"UNAPPROVABLE",
"MANDATORY_NOT_FOUND",
"INTERNAL_ERROR",
"EMAIL_UPDATE_NOT_ALLOWED",
"ID_ALREADY_DEACTIVATED",
"ID_ALREADY_ACTIVE",
"FEATURE_PERMISSION",
"OAUTH_SCOPE_MISMATCH",
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "api_name",
"type": "String"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"Internal server error occurred.",
"Cannot add user under CRM Plus account. Kindly use CRMPlus URL to add user",
"Request exceeds your license limit. Need to upgrade in order to add",
"Failed to add user since same email id is already present",
"Email Id should not contain @skydesk.jp. Please choose a different email id",
"Invalid Email Id. Please choose a different email id",
"Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus",
"Company Name is required",
"Error occurred in resending the invitation of CRMPLUS user in CRM account",
"Cannot update the time_zone of another User",
"Either trial has expired or user does not have sufficient privilege to perform this action",
"Error occurred while updating CRMPlus User in CRM Account",
"invalid_data",
"Deleted user cannot be updated",
"Re-invite is not allowed for a confirmed user",
"Cannot update email of a confirmed CRM User",
"User with same email id is already in CRM Plus",
"User is already deactivated",
"Primary Contact cannot be deactivated",
"User is already active",
"Share among Subordinates Feature is not available",
"Profile and Role cannot be Updated by the user.",
"the_id_given_seems_to_be_invalid",
"Primary contact cannot be deleted",
"User is already deleted",
"User does not have sufficient privilege to delete users"
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/tags/api_exception": {
"code": {
"values": [
"REQUIRED_PARAM_MISSING",
"MANDATORY_NOT_FOUND",
"INVALID_MODULE",
"DUPLICATE_DATA",
"TAG_ID_NOT_FOUND",
"FAILURE",
"INTERNAL_ERROR",
"NO_PERMISSION",
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"INVALID_DATA",
"LICENSE_LIMIT_EXCEEDED"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "api_name",
"type": "String"
},
{
"name": "id",
"type": "Long"
},
{
"name": "param",
"type": "String"
},
{
"name": "permissions",
"type": "List"
},
{
"name": "maximum_length",
"type": "Integer"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"tags not found",
"special characters found in the given name",
"One of the expected parameter is missing",
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"record not deleted",
"the related id given seems to be invalid",
"Internal server error occurred.",
"The relation name given seems to be invalid",
"duplicate data",
"tag edition limit exceeded",
"invalid data",
"tags not updated successfully"
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/currencies/api_exception": {
"code": {
"values": [
"OAUTH_SCOPE_MISMATCH",
"ALREADY_ENABLED",
"FEATURE_NOT_ENABLED",
"NOT_ALLOWED",
"ACTIVE_STATE_LIMIT_EXCEEDED",
"INTERNAL_ERROR",
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"DUPLICATE_DATA",
"LIMIT_EXCEEDED",
"MANDATORY_NOT_FOUND",
"INVALID_DATA",
"CURRENCIES_NOT_ENABLED",
"FEATURE_NOT_SUPPORTED",
"No Content"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "api_name",
"type": "String"
},
{
"name": "json_path",
"type": "String"
},
{
"name": "expected_data_type",
"type": "String"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"invalid oauth token",
"Please check if the URL trying to access is a correct one.",
"The http request method type is not a valid one",
"The module name given seems to be invalid",
"The multi-currency is already enabled",
"Currency name is invalid.",
"ISO code is invalid.",
"Currency symbol is invalid.",
"The multi-currency feature is not available except the Enterprise and higher editions.",
"Required field not found.",
"unable to process your request. please verify whether you have entered proper method name",
" parameter and parameter values.",
"Currency symbol is invalid.",
"Multi currency is not enabled",
"No Content",
"Internal server error occurred."
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/blue_print/response_wrapper": {
"blueprint": {
"structure_name": "core/com/zoho/crm/api/blue_print/blue_print",
"name": "blueprint",
"type": "core/com/zoho/crm/api/blue_print/blue_print"
}
},
"core/com/zoho/crm/api/blue_print/process_info": {
"apiName": {
"name": "api_name",
"type": "String"
},
"fieldName": {
"name": "field_name",
"type": "String"
},
"escalation": {
"name": "escalation",
"type": "String"
},
"continuous": {
"name": "continuous",
"type": "Boolean"
},
"fieldLabel": {
"name": "field_label",
"type": "String"
},
"name": {
"name": "name",
"type": "String"
},
"isContinuous": {
"name": "is_continuous",
"type": "Boolean"
},
"id": {
"name": "id",
"type": "Long"
},
"fieldValue": {
"name": "field_value",
"type": "String"
},
"fieldId": {
"name": "field_id",
"type": "String"
},
"columnName": {
"name": "column_name",
"type": "String"
}
},
"core/com/zoho/crm/api/record/criteria": {
"comparator": {
"values": [
"equal",
"not_equal",
"in",
"not_in",
"less_than",
"less_equal",
"greater_than",
"greater_equal",
"contains",
"not_contains",
"starts_with",
"ends_with",
"between",
"not_between"
],
"name": "comparator",
"type": "utils/util/choice"
},
"groupOperator": {
"values": [
"and",
"or"
],
"name": "group_operator",
"type": "utils/util/choice"
},
"field": {
"name": "field",
"type": "String"
},
"value": {
"name": "value",
"type": "Object"
},
"group": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/record/criteria",
"name": "group",
"type": "List"
}
},
"core/com/zoho/crm/api/bulk_read/api_exception": {
"code": {
"values": [
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"INVALID_SERVICE_NAME",
"INVALID_BULK_OPERATION",
"RESOURCE_NOT_FOUND",
"MEDIA_TYPE_NOT_SUPPORTED",
"REQUEST_BODY_NOT_READABLE",
"REQUEST_BODY_IS_EMPTY",
"MODULE_NOT_AVAILABLE",
"NOT_SUPPORTED_FEATURE",
"NO_PERMISSION",
"MODULE_NOT_SUPPORTED",
"JOB_NOT_SUPPORTED",
"QUERY_NOT_SUPPORTED",
"INVALID_CALLBACK_URL",
"INVALID_CALLBACK_METHOD",
"JOIN_LIMIT_EXCEEDED",
"CRITERIA_NOT_SUPPORTED",
"INVALID_CRITERIA",
"AMBIGUOUS_CRITERIA",
"AMBIGUOUS_GROUP_IN_CRITERIA",
"CRITERIA_LIMIT_EXCEEDED",
"FIELD_IN_CRITERIA_NOT_SUPPORTED",
"FIELD_AND_COMPARATOR_IN_CRITERIA_NOT_COMPATIBLE",
"FIELD_IN_CRITERIA_NOT_AVAILABLE",
"FIELD_COMPARATOR_IN_CRITERIA_NOT_SUPPORTED",
"VALUE_IN_CRITERIA_NOT_SUPPORTED",
"FIELD_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE",
"COMPARATOR_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE",
"COMPARATOR_AND_ENCRYPTED_VALUE_IN_CRITERIA_NOT_COMPATIBLE",
"GROUP_OPERATOR_NOT_SUPPORTED",
"FIELD_NOT_AVAILABLE",
"FIELD_NOT_SUPPORTED",
"VALUE_LIMIT_EXCEEDED_IN_CRITERIA",
"PAGE_NOT_SUPPORTED",
"PAGE_RANGE_EXCEEDED",
"TOO_MANY_REQUESTS",
"CALLBACK_FAILURE",
"INTERNAL_SERVER_ERROR",
"INTERNAL_ERROR"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "resource",
"type": "String"
},
{
"name": "message",
"type": "String"
},
{
"name": "expected_data_type",
"type": "String"
},
{
"name": "info_message",
"type": "String"
},
{
"name": "parent_api_name",
"type": "String"
},
{
"name": "comparator",
"type": "String"
},
{
"name": "value",
"type": "String"
},
{
"name": "api_name",
"type": "String"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"Provided service name %s is not valid/not supported",
"Requested operation is an invalid bulk operation",
"record not in process",
"The requested resource doesn't exist.",
"Media type is not supported.",
"Unable to parse the request body.",
"Request body is empty.",
"Requested module '%s' is not available.",
"Feature is not supported",
" permission denied",
"Invalid module for the query. Module '%s' is not supported.",
"Invalid bulk %s job.",
"Invalid query for bulk %s job. Query '%s' is not supported.",
"Invalid URL '%s' for callback.",
"Invalid request method %s for callback.",
"Join limit exceeded for the query. Maximum number of joins supported in a query is %d",
"Invalid criteria for the query. Criteria %s is not supported.",
"Invalid criteria %s for the query.",
"Ambiguous criteria %s. Criteria can have either {group",
" group_operator} or {api_name",
" comparator",
" value}.",
"Ambiguous group in criteria %s. Group should be used only when there are more than one criteria",
"Number of criteria exceeded the maximum limit of %d",
"Field api name '%s' for criteria %s is not supported.",
"Field api name '%s' is not supported with comparator '%s' for criteria %s.",
"Field api name '%s' is not available for criteria %s. Check visibility and permission for the field",
"Field api name '%s' doesn't support this comparator '%s' for criteria %s.",
"Value '%s' is not supported for criteria %s.",
"Field '%s' is not supported with value '%s' for criteria %s.",
"Comparator '%s' is not supported with value '%s' for criteria %s.",
"Comparator '%s' is not supported with value '%s' for criteria %s as the value is encrypted.",
"Criteria %s doesn't support this logical group operator '%s'. Supported operators are 'and'",
" 'or'.",
"Requested field api name '%s' is not available for the module '%s'. Check permission or visibility for the field.",
"Invalid field for the module provided in fields. Field api name '%s' is not supported for this module '%s'.",
"Value exceeded limit %d",
"Invalid page number for query. Page %s is not supported for the query.",
"Invalid page number for query. Page %s is not supported for the query. Page range is from %d to %d.",
"Many requests fired in concurrent than the allowed limit",
"Callback failed after %d attempts.",
"Internal server error occurred."
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/modules/action_response": {
"classes": [
"core/com/zoho/crm/api/modules/api_exception",
"core/com/zoho/crm/api/modules/success_response"
],
"interface": true
},
"core/com/zoho/crm/api/related_records/action_response": {
"classes": [
"core/com/zoho/crm/api/related_records/api_exception",
"core/com/zoho/crm/api/related_records/success_response"
],
"interface": true
},
"core/com/zoho/crm/api/custom_views/api_exception": {
"code": {
"values": [
"NO_PERMISSION",
"INVALID_TOKEN",
"INVALID_URL_PATTERN",
"INVALID_REQUEST_METHOD",
"REQUIRED_PARAM_MISSING",
"INVALID_MODULE",
"INTERNAL_ERROR",
"INVALID_DATA"
],
"name": "code",
"type": "utils/util/choice"
},
"details": {
"keys": [
{
"name": "permissions",
"type": "List"
},
{
"name": "expected_data_type",
"type": "String"
},
{
"name": "api_name",
"type": "String"
},
{
"structure_name": "core/com/zoho/crm/api/custom_views/range",
"name": "range",
"type": "core/com/zoho/crm/api/custom_views/range"
},
{
"name": "json_path",
"type": "String"
},
{
"name": "resource_path_index",
"type": "Integer"
}
],
"name": "details",
"type": "Map"
},
"message": {
"values": [
"invalid oauth token",
"Please check if the URL trying to access is a correct one",
"The http request method type is not a valid one",
"The module name given seems to be invalid",
"The given module is not supported in API",
"invalid data",
"Invalid ID",
"Internal server error occurred."
],
"name": "message",
"type": "utils/util/choice"
},
"status": {
"values": [
"error"
],
"name": "status",
"type": "utils/util/choice"
}
},
"core/com/zoho/crm/api/bulk_write/resource": {
"file": {
"structure_name": "core/com/zoho/crm/api/bulk_write/file",
"name": "file",
"type": "core/com/zoho/crm/api/bulk_write/file"
},
"module": {
"name": "module",
"type": "String",
"required": true
},
"ignoreEmpty": {
"name": "ignore_empty",
"type": "Boolean"
},
"findBy": {
"name": "find_by",
"type": "String"
},
"fieldMappings": {
"structure_name": "core/com/zoho/crm/api/bulk_write/field_mapping",
"name": "field_mappings",
"type": "List"
},
"type": {
"values": [
"data"
],
"name": "type",
"type": "utils/util/choice",
"required": true
},
"status": {
"values": [
"ADDED",
"IN PROGRESS",
"COMPLETED",
"SKIPPED",
"FAILED"
],
"name": "status",
"type": "utils/util/choice"
},
"fileId": {
"name": "file_id",
"type": "String",
"required": true
}
},
"core/com/zoho/crm/api/variables/variable": {
"apiName": {
"required_in_update": false,
"name": "api_name",
"type": "String",
"primary": true
},
"variableGroup": {
"structure_name": "core/com/zoho/crm/api/variable_groups/variable_group",
"name": "variable_group",
"type": "core/com/zoho/crm/api/variable_groups/variable_group",
"skip_mandatory": true,
"required": true
},
"name": {
"name": "name",
"type": "String",
"required": true
},
"description": {
"name": "description",
"type": "String"
},
"id": {
"name": "id",
"type": "Long",
"primary": true
},
"type": {
"name": "type",
"type": "String",
"required": true
},
"value": {
"name": "value",
"type": "Object"
}
},
"core/com/zoho/crm/api/record/recurring_activity": {
"rrule": {
"name": "RRULE",
"type": "String",
"required": true
}
},
"core/com/zoho/crm/api/attachments/delete_attachments_param": {
"ids": {
"name": "ids",
"type": "Long",
"required": true
}
},
"core/com/zoho/crm/api/record/update_records_header": {
"XEXTERNAL": {
"name": "X-EXTERNAL",
"type": "String"
}
},
"core/com/zoho/crm/api/currencies/base_currency_wrapper": {
"baseCurrency": {
"structure_name": "core/com/zoho/crm/api/currencies/currency",
"name": "base_currency",
"type": "core/com/zoho/crm/api/currencies/currency",
"required": true
}
},
"core/com/zoho/crm/api/record/body_wrapper": {
"process": {
"name": "process",
"type": "List"
},
"data": {
"structure_name": "core/com/zoho/crm/api/record/record",
"name": "data",
"max-length": 100,
"type": "List",
"required": true,
"min-length": 1
},
"larId": {
"name": "lar_id",
"type": "String"
},
"wfTrigger": {
"name": "wf_trigger",
"type": "String"
},
"trigger": {
"name": "trigger",
"type": "List"
},
"duplicateCheckFields": {
"name": "duplicate_check_fields",
"type": "List"
}
},
"core/com/zoho/crm/api/related_records/action_handler": {
"classes": [
"core/com/zoho/crm/api/related_records/api_exception",
"core/com/zoho/crm/api/related_records/action_wrapper"
],
"interface": true
},
"core/com/zoho/crm/api/taxes/body_wrapper": {
"taxes": {
"structure_name": "core/com/zoho/crm/api/taxes/tax",
"name": "taxes",
"max-length": 100,
"type": "List",
"required": true,
"min-length": 1
}
},
"core/com/zoho/crm/api/layouts/properties": {
"maximumRows": {
"name": "maximum_rows",
"type": "Integer"
},
"tooltip": {
"structure_name": "core/com/zoho/crm/api/fields/tool_tip",
"name": "tooltip",
"type": "core/com/zoho/crm/api/fields/tool_tip"
},
"reorderRows": {
"name": "reorder_rows",
"type": "Boolean"
}
},
"core/com/zoho/crm/api/modules/body_wrapper": {
"modules": {
"structure_name": "core/com/zoho/crm/api/modules/module",
"name": "modules",
"max-length": 1,
"type": "List",
"min-length": 1
}
},
"core/com/zoho/crm/api/taxes/response_handler": {
"classes": [
"core/com/zoho/crm/api/taxes/api_exception",
"core/com/zoho/crm/api/taxes/response_wrapper"
],
"interface": true
},
"core/com/zoho/crm/api/taxes/action_response": {
"classes": [
"core/com/zoho/crm/api/taxes/success_response",
"core/com/zoho/crm/api/taxes/api_exception"
],
"interface": true
},
"core/com/zoho/crm/api/contact_roles/response_handler": {
"classes": [
"core/com/zoho/crm/api/contact_roles/response_wrapper",
"core/com/zoho/crm/api/contact_roles/api_exception"
],
"interface": true
},
"core/com/zoho/crm/api/currencies/response_wrapper": {
"currencies": {
"structure_name": "core/com/zoho/crm/api/currencies/currency",
"name": "currencies",
"type": "List"
}
},
"core/com/zoho/crm/api/tags/record_action_response": {
"classes": [
"core/com/zoho/crm/api/tags/success_response",
"core/com/zoho/crm/api/tags/api_exception"
],
"interface": true
},
"core/com/zoho/crm/api/taxes/response_wrapper": {
"preference": {
"structure_name": "core/com/zoho/crm/api/taxes/preference",
"name": "preference",
"type": "core/com/zoho/crm/api/taxes/preference"
},
"taxes": {
"structure_name": "core/com/zoho/crm/api/taxes/tax",
"name": "taxes",
"type": "List"
}
},
"core/com/zoho/crm/api/bulk_write/request_wrapper": {
"resource": {
"structure_name": "core/com/zoho/crm/api/bulk_write/resource",
"name": "resource",
"type": "List",
"required": true
},
"callback": {
"structure_name": "core/com/zoho/crm/api/bulk_write/call_back",
"name": "callback",
"type": "core/com/zoho/crm/api/bulk_write/call_back"
},
"characterEncoding": {
"name": "character_encoding",
"type": "String"
},
"operation": {
"values": [
"insert",
"update",
"upsert"
],
"name": "operation",
"type": "utils/util/choice",
"required": true
}
},
"core/com/zoho/crm/api/file/body_wrapper": {
"file": {
"name": "file",
"max-length": 10,
"type": "List",
"required": true,
"min-length": 1
}
},
"core/com/zoho/crm/api/notification/response_wrapper": {
"watch": {
"structure_name": "core/com/zoho/crm/api/notification/notification",
"name": "watch",
"type": "List"
},
"info": {
"structure_name": "core/com/zoho/crm/api/notification/info",
"name": "info",
"type": "core/com/zoho/crm/api/notification/info"
}
},
"core/com/zoho/crm/api/share_records/share_record": {
"shareRelatedRecords": {
"name": "share_related_records",
"type": "Boolean"
},
"sharedThrough": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/share_records/shared_through",
"name": "shared_through",
"type": "core/com/zoho/crm/api/share_records/shared_through"
},
"sharedTime": {
"name": "shared_time",
"type": "DateTime"
},
"sharedBy": {
"lookup": true,
"structure_name": "core/com/zoho/crm/api/users/user",
"name": "shared_by",
"type": "core/com/zoho/crm/api/users/user"
},
"permission": {
"