Data Storage APIs
Sometimes, the extensions you create might require data storage and retrieval capabilities. To help you in such cases, we provide a data store for extensions to set (store) and get (retrieve) data. The data can be deleted when it is no longer required.
The following APIs provide database management functionalities to extensions.
Get data: Fetch data from the connected database.
Request:
- ZOHODESK.get('database',{'key': '3', 'queriableValue':'test'}).then(function(response){
- //response returns the value, based on the key specified
- }).catch(function(err){
- // Error handling
- })
Note: Both key and queriableValue are optional parameters, but at least one of them must be included in this API request.
Response:
- {
- "database.get": {
- "data": [
- {
- "value": {
- "test": "testid"
- },
- "queriableValue": "test",
- "key": "3"
- }
- ]
- },
- "status": "success"
- }
Set data: Asynchronously set data in the connected database.
Request:
- ZOHODESK.set('database',{'key':'3','value': {'test':'testid'}, 'queriableValue':'test'}).then(function(response){
- // response returns the value saved
- }).catch(function(err){
- // Error handling
- })
Note: All three parameters--key, value, and queriableValue--must be passed in this API request. The conditions for each parameter are as follows:
- The value passed by key can have a maximum length of 50 characters. The only special characters allowed are comma (,), underscore (_), and colon (:). The value of this parameter cannot be NULL.
- The data passed by value must be a JSON object whose size does not exceed 1 KB. Empty JSON objects can be passed too.
- The value passed by queriableValue can have a maximum length of 50 characters. The only special characters allowed are comma (,), underscore (_), and colon (:). The value of this parameter can be NULL.
Response:
- {
- "database.set": {
- "value": {
- "test": "testid"
- },
- "queriableValue": "test",
- "key": "3"
- },
- "status": "success"
- }
Delete data: Delete data from the connected database.
Request:
- ZOHODESK.delete('database',{'key':'3'}).then(function(response){
- // response returns the status of deletion
- }).catch(function(err){
- // Error handling
- })
Note: key is a mandatory parameter in this API request. Response:
- {
- "database.delete": {
- "delete": "success"
- },
- "status": "success
- }
However, these APIs come with the following limitations:
- Scope of data storage varies according to the extension and the installation done.
- Data stored by one extension cannot be accessed by another
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Data APIs
Zoho Desk provides a set of APIs that facilitate interaction between your extension and your help desk portal. The APIs available are listed below: Ticket Object Contact Object Account Object Current Call Object User Object Portal Object Department ...Event APIs
The following APIs help you incorporate custom functionalities in your extension when certain events occur in your help desk portal. Ticket Events You can configure extensions to receive information when an event, such as adding a comment to a ticket ...Storage API
Extensions can make use of Storage API to access & modify data from the extension's DB storage. The available storage API 's are, Add data to storage Get data from storage Delete data from storage #STORAGE_DATA_OBJECT Every storage object has the ...Extension APIs
These APIs fetch or set information related to the extension. Get extension config variable: Fetch the installation parameters of the extension. In production mode, only those parameters that have the value of the secure key set to false are ...Data Storage Add-on in Vertical Solutions
Within Vertical Solutions, the storage space is divided into two key categories - Data and File. These categories are further classified into Storage and Usage details. In this section, let us see in detail about Data Storage, and how you can buy ...
New to Zoho LandingPage?
Zoho LandingPage Resources