The QuintaDB REST API is designed to unlock the potential of the data stored within your QuintaDB database. Using this API you can achieve more than currently offered by the default QuintaDB UI. This is how we give you ability to do with your data everything you need and in the way you need. You can create your own scripts, desktop and mobile applications for different platforms like iPhone/Android and many more. And QuintaDB will be a place where you store, share and manage your data.
See how to connect Thunkable & QuintaDB online database using API by this link How to connect Thunkable & QuintaDB online database using API.
Also, QuintaDB has own application on the Zapier service.
All calls should contain REST API key, which could be found in menu "API" at the top right of the page.
Result are returned in JSON or XML, depending on your request.
We`ll show a table with a result for each call. The URL will be shown in this way /apps.json, it means that you should call https://QuintaDB.com/apps.json in your application. Please notice that all calls should use https and you have to validate servers SSL certificate.
Ruby example ~ Javascript (jQuery) example
Attribute | Description |
---|---|
id | Unique database identifier. You'll need this to access this database forms and records |
name | Name |
created_at | Time when database was created |
updated_at | Time when database was last updated (changed records or forms) |
dtypes_count | Number of entries in database |
entities_count | Number of tables in database |
properties_count | Number of columns in database |
complex_app? | Is it a complex app, i.e. the app where data caching enabled. Returns true or false |
complex_app_with_fresh_data? | Is it a complex app and the data cache is fresh. Returns true or false |
Request parameter | Description |
---|---|
rest_api_key | your API key |
page | Databases paginated by 20 records per page. So if you have 100 databases, page can be 1..5. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps.json | GET | {"page":1,"rest_api_key":"API_KEY"} |
|
XML | /apps.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<page>1</page> <rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/ID.json | GET | {"rest_api_key":"API_KEY"} |
|
XML | /apps/ID.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
Name | You have to know your database name in order to fetch database information. You can find Name using Fetch All Databases call. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/search.json | GET | {"rest_api_key":"API_KEY", "name":"Database Name 1"} |
|
XML | /apps/search.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> <name>Database Name 1</name> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
name | New database name |
ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/ID.json | PUT |
{"rest_api_key":"API_KEY", "name":"New database name"} |
|
XML | /apps/ID.xml | PUT |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <name>New database name</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/ID.json | DELETE | {"rest_api_key":"API_KEY"} |
|
XML | /apps/ID.xml | DELETE |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
database_name | Database name |
form_name | Form name. You can't create database without form. Because it doesn't make sense to have database without forms. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps.json | POST | {"rest_api_key":"API_KEY", database_name: "Database 1", form_name: "Form 1"} |
|
XML | /apps.xml | POST |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> <database_name>Database 1</database_name> <form_name>Form 1</form_name> </api_call_params> |
|
Attribute | Description |
---|---|
id | Unique form identifier. You'll need this to access this form and form records |
name | Name |
desc | Description |
post_action | List of email notifications recipients |
target_page | Redirect to URL. This is the URL form submitter will be redirected to after filling the form. |
position | Form position. It shows the order it will be fetched. |
sort_by | Form field ID by which records current sorted |
asc | true or false. Which mean DESC or ASC sort order |
per_page | How many records fetched per page. |
allow_delete | true or false. When true, web users will be able to delete records from integrated database |
allow_database | true or false. When true, web users will be able to see records on integrated database |
send_emails | true or false. Send or not to send email notifications about new submission. |
new_widget | Form widget settings Hash |
records_widget | Database widget settings Hash |
settings | Form settings Hash |
Request parameter | Description |
---|---|
rest_api_key | your API key |
ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/ID/entities.json | GET | {"rest_api_key":"API_KEY"} |
|
XML | /apps/ID/entities.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ID | You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ID.json | GET | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/entities/ID.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
Database name | You have to know your database name in order to fetch database information. You can find Name using Fetch All Databases call. |
Form name | You have to know your form name in order to fetch form information. You can find Form Name using Fetch All Forms call. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/search/entities/search.json | GET | {"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1"} |
|
XML | /apps/search/entities/search.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> <database_name>Database 21</database_name> <form_name>Form1</form_name> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
name | New form name. See all available attributes here |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ID | You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ID.json | PUT |
{"rest_api_key":"API_KEY", "name":"New form name"} |
|
XML | /apps/APP_ID/entities/ID.xml | PUT |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <name>New form name</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ID | You have to know your database identifier. You can find APP_ID using Fetch All Forms call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ID.json | DELETE | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/entities/ID.xml | DELETE |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
name | Form name |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ID.json | POST |
{"rest_api_key":"API_KEY", "name":"New form"} |
|
XML | /apps/APP_ID/entities/ID.xml | POST |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <name>New form</rest_api_key> </api_call_params> |
|
Attribute | Description |
---|---|
id | Unique field identifier. You'll need this to access this field |
entity_id | Field's form identifier. |
name | Name |
desc | Description |
type_name | Field type name. Can by one of: string, text, integer, float, select, radio button, check box, date, dob, datetime, file, image, boolean, language, states, table, country, time_zone, note, divider, formula, autoincrement, login, password |
default | Default field value |
validate_options | Field validation options |
position | Field position on form |
visible | Visible field on integrated database widget? Can be true or false |
size | Field size for |
cols | Table field columns |
rows | Table field rows |
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ID/properties.json | GET | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/entities/ID/properties.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso |
ID | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ENTITY_ID/properties/ID.json | GET | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/entities/ENTITY_ID/properties/ID.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
Database name | Should Know Db Name For Field Html |
Form name | You have to know your form name in order to fetch form information. You can find Form Name using Fetch All Forms call. |
Field name | You have to know your field name in order to update field settings. You can find field name using Fetch All Form Fields call. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/search/entities/search/properties/search.json | GET | {"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1", "field_name": "Field Name 1"} |
|
XML | /apps/search/entities/search/properties/search.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <database_name>Database 21</database_name> <form_name>Form1</form_name> <field_name>test</field_name> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
name | New field name. See all available attributes here |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso |
ID | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ENTITY_ID/properties/ID.json | PUT |
{"rest_api_key":"API_KEY", "name":"New field name"} |
|
XML | /apps/APP_ID/entities/ENTITY_ID/properties/ID.xml | PUT |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <name>New field name</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json |
ID | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ENTITY_ID/properties/ID.json | DELETE | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/entities/ENTITY_ID/properties/ID.json | DELETE |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
name | New form field name |
type_name | Field type name. Can by one of: string, text, integer, float, select, radio button, check box, date, dob, datetime, file, image, boolean, language, states, table, country, time_zone, note, divider, formula, autoincrement, login, password |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ENTITY_ID/properties.json | POST | {"rest_api_key":"API_KEY", name: "Field name 1", type_name: "string"} |
|
XML | /apps/APP_ID/entities/ENTITY_ID/properties.xml | POST |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <name>Form field 1</name> <type-name>string</type-name> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
ENTITY_ID | You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json |
ID | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
view | You have to know your report id in order to fetch records. (Optional) |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /search/sum/ENTITY_ID/ID.json?view=VIEW | GET | {"rest_api_key":"API_KEY", "ENTITY_ID": "aEWQZdIXfahOqWvcvwrGTP", "ID": "aMW4HKWR9bnOoGWQbpWQS4"} |
|
XML | /search/sum/ENTITY_ID/ID.xml?view=VIEW | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <ENTITY_ID>aEWQZdIXfahOqWvcvwrGTP</ENTITY_ID> <ID>aMW4HKWR9bnOoGWQbpWQS4</ID> </api_call_params> |
|
Attribute | Description |
---|---|
id | Unique record identifier. You'll need this to access this record. |
page | Records paginated by per_page records per page. |
app_id | App ID |
entity_id | Record's form identifier. |
values | Record values hash. Where key is field id and value is this field value. |
rel_values | Record relationships values hash. Where key is field id and value is the linked record ID. |
subform_values | Record subform's values hash. Where key is field id and value is the array with subform record's ID's. |
approved | If database moderation enabled this attributes triggers record's visibility in integrated database |
created_at | Time when record was created. |
updated_at | Time when record was last updated. |
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso |
page | Records page number. From 1 to Table Records count/per_page. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/dtypes/entity/ENTITY_ID.json | GET | {"rest_api_key":"API_KEY", "page": 1} |
|
XML | /apps/APP_ID/dtypes/entity/ENTITY_ID.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
view | You have to know your report id in order to fetch records. |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/dtypes/entity/ENTITY_ID.json | GET | {"rest_api_key":"API_KEY", "view": REPORT_ID} |
|
XML | /apps/APP_ID/dtypes/entity/ENTITY_ID.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params> <rest_api_key>API_KEY</rest_api_key> <view>EaWQZdIXfahOqWvcvwrGTP</view> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ID | You have to know your record identifier. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/dtypes/ID.json | GET | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/dtypes/ID.xml | GET |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
values | Record values hash, where key is form field id. |
json_values | If you using jQuery, Ruby or another programming language then, please, use 'values' parameter to send encoding parameters. However, if your framework doesn't allow this you can send record values as JSON string, but in this case specify your parameter name as 'json_values'. And your JSON values string will looks like this: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}" |
subforms_values / subforms_json_values |
To create or update subforms, in the same way, use 'subforms_values' or 'json_subforms_values'. With a format below: "{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2", subform1_field2_id: "aaa"}, subform1_record2_id: {subform1_field1_id: "3", subform1_field2_id: "bb"}}, property2_id: {entity_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4", subform2_field2_id: "bb"}, subform2_record2_id: {subform2_field1_id: "5", subform2_field2_id: "dd"}}}" . Where property1_id and property2_id - this is Fields ID's with a Subform type in the main table. subform1_id, subform2_id - Forms ID's, which was set in property1_id and property2_id settings. subform1_record1_id и subform1_record2_id - this is new or existent subform records ID's. subform1_field1_id, subform1_field2_id - fields ID's in the form subform1_id. subform2_field1_id, subform2_field2_id - fields ID's in the form subform2_id. All ID's - it's a 22 characters URL-save base64 code, you can get them from other API calls or create for new subform records. |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ID | You have to know your record identifier. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/dtypes/ID.json | PUT | {"rest_api_key":"API_KEY", "values": {"aNW4nkW5bdUjldO8oKuSku" : 3, "aMW4HKWR9bnOoGWQbpWQS4" : "b", "cMW6pcTSjbWOFdTCkBtmkN" : "c"}} |
|
XML | /apps/APP_ID/dtypes/ID.xml | PUT |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3, "aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values> <rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
val | New cell value |
DTYPE_ID | You have to know your record identifier. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json |
PROPERTY_ID | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json | PUT | {"rest_api_key":"API_KEY", "property_id": "aNW4nkW5bdUjldO8oKuSku", "dtype_id": "cMW6pcTSjbWOFdTCkBtmkN", "val": "John Smith"} |
|
XML | /cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml | PUT |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<val>John Smith</val> <rest_api_key>API_KEY</rest_api_key> <dtype-id>cMW6pcTSjbWOFdTCkBtmkN</dtype-id> <property-id>aNW4nkW5bdUjldO8oKuSku</property-id> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ID | You have to know your record identifier. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/dtypes/ID.json | DELETE | {"rest_api_key":"API_KEY"} |
|
XML | /apps/APP_ID/dtypes/ID.xml | DELETE |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
values / json_values | If you using jQuery, Ruby or another programming language then, please, use 'values' parameter to send encoding parameters. However, if your framework doesn't allow this you can send record values as JSON string, but in this case specify your parameter name as 'json_values'. And your JSON values string will looks like this: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}" |
subforms_values / subforms_json_values |
To create or update subforms, in the same way, use 'subforms_values' or 'json_subforms_values'. With a format below: "{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2", subform1_field2_id: "aaa"}, subform1_record2_id: {subform1_field1_id: "3", subform1_field2_id: "bb"}}, property2_id: {entity_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4", subform2_field2_id: "bb"}, subform2_record2_id: {subform2_field1_id: "5", subform2_field2_id: "dd"}}}" . Where property1_id and property2_id - this is Fields ID's with a Subform type in the main table. subform1_id, subform2_id - Forms ID's, which was set in property1_id and property2_id settings. subform1_record1_id и subform1_record2_id - this is new or existent subform records ID's. subform1_field1_id, subform1_field2_id - fields ID's in the form subform1_id. subform2_field1_id, subform2_field2_id - fields ID's in the form subform2_id. All ID's - it's a 22 characters URL-save base64 code, you can get them from other API calls or create for new subform records. |
ID | You have to generate 22 characters long URL-safe base64 UUID (Universally Unique IDentifier). For example, in Ruby. Then you'll need to pass this identifiers to 'values' hash. I.e. :values => {'id' => ID}, change to :values => {'id' => '22adadVXHdHie1WeGFE8k2'} |
APP_ID | You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json |
ENTITY_ID | You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/dtypes.json | POST | {"rest_api_key":"API_KEY", "values": {"entity_id" : ENTITY_ID, "id" : ID, "aNW4nkW5bdUjldO8oKuSku":"3", "aMW4HKWR9bnOoGWQbpWQS4":"b","cMW6pcTSjbWOFdTCkBtmkN":"c"}} |
|
XML | /apps/APP_ID/dtypes.xml | POST |
<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3,"entity_id"=>ENTITY_ID, "id"=>ID,"aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values>< <rest_api_key>API_KEY</rest_api_key> </api_call_params> |
|
Attribute | Description |
---|---|
id | Unique database identifier. You'll need this to access this database forms and records |
name | Name |
created_at | Time when database was created |
updated_at | Time when database was last updated (changed records or forms) |
app_id | App ID |
entity_id | Table (Form) ID |
Request parameter | Description |
---|---|
rest_api_key | your API key |
app_id | App ID |
entity_id | Table (Form) ID |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /apps/APP_ID/entities/ENTITY_ID/views/index.json | GET | {"rest_api_key":"API_KEY"} |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
ENTITY_ID | You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json |
PROPERTY_ID | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /entities/ENTITY_ID/get_rel_id/PROPERTY_ID.json?rest_api_key=API_KEY | GET | {"rest_api_key":"API_KEY", {"entity_id" : ENTITY_ID, "property_id" : PROPERTY_ID}} | 11842 |
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | App ID |
property_id | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
DTYPE_ID | You have to know your record identifier. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /entities/APP_ID/upload_file/PROPERTY_ID.json?dtype_id=DTYPE_ID | POST |
{"rest_api_key"=>API_KEY, "subform_field"=>"dcL8kXB8npd5pdRmk7BCoR", "property_id"=>"aVWR3cNtvdUikQn8o3yCo1", "subform_dtype_id"=>"fRLA83jrnAUOi5TEQLyuGw", "subforms"=>{"dcL8kXB8npd5pdRmk7BCoR"=>{"fRLA83jrnAUOi5TEQLyuGw"=>{"aVWR3cNtvdUikQn8o3yCo1"=># |
|
Request parameter | Description |
---|---|
rest_api_key | your API key |
APP_ID | App ID |
property_id | You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json |
DTYPE_ID | You have to know your record identifier. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json |
SINGLE_FILE_NAME | File name |
Format | URL | Method | Request body | Response |
---|---|---|---|---|
JSON | /dtypes/delete_dtype_file/APP_ID/DTYPE_ID/PROPERTY_ID.json | GET | {"rest_api_key"=>API_KEY, "single_file_name"=>"Selection_002.png", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9", "dtype_id"=>"wlS5MeyMqQiCv16FdG3ztQ", "property_id"=>"bwW68wWP1cSikQqSkhl04I"} |
|