QuintaDB REST API

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.

General information about API calls

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.

Database

Such database attributes can be accessible via REST API.

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)

Get All Databases

Parameters

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.

Making request (JSON)

Format

JSON

Method

GET

URL

/apps.json

Request body

{"page":1,"rest_api_key":"API_KEY"}

Response: returns your current databases.

    
{"databases":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2021-04-29T01:26:22-05:00",
 "updated_at"      : "2021-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

Making request (XML)

Format

XML

Method

GET

URL

/apps.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<page>1</page>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response: returns your current databases.

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
  <database>
    <id>aOWO_dVXHdHie1WeGFE8k2</id>
    <name>Database name 1</name>
    <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
    <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
    <dtypes-count type="integer">0</dtypes-count>
    <entities-count type="integer">1</entities-count>
    <properties-count type="integer">0</properties-count>
  </database>
  <database>
    <id>aOWO3eVXHdHie1WeGFE8k2</id>
    <name>Database Name 2</name>
    <created-at type="datetime">2021-04-29T01:26:22-05:00</created-at>
    <updated-at type="datetime">2021-08-16T00:47:56-05:00</updated-at>
    <dtypes-count type="integer">768</dtypes-count>
    <entities-count type="integer">6</entities-count>
    <properties-count type="integer">240</properties-count>
  </database>
</databases>

Get Database by ID

Parameters

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

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID.json

Request body

{"rest_api_key":"API_KEY"}

Response: returns database information

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response: returns database information

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

Get Database by Name

Parameters

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.

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/search.json

Request body

{"rest_api_key":"API_KEY", "name":"Database Name 1"}

Response: returns database information

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/search.xml

Request body

<?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>

Response: returns database information

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

Update database

Parameters

rest_api_key

your API key

APP_ID

name

New database name

Making request (JSON)

Format

JSON

Method

PUT

URL

/apps/APP_ID.json

Request body

{"rest_api_key":"API_KEY",
"name":"New database name"}

Response: returns database information

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "New database name",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

Format

XML

Method

PUT

URL

/apps/APP_ID.xml

Request body

<?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>

Response: returns database information

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>New database name</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

Delete Database

Parameters

rest_api_key

your API key

APP_ID

Making request (JSON)

Format

JSON

Method

DELETE

URL

/apps/APP_ID.json

Request body

{"rest_api_key":"API_KEY"}

Response

    
{"databases":[{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

Making request (XML)

Format

XML

Method

DELETE

URL

/apps/APP_ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
 <database>
   <id>aOWO_dVXHdHie1WeGFE8k2</id>
   <name>Database name 1</name>
   <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
   <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
   <dtypes-count type="integer">0</dtypes-count>
   <entities-count type="integer">1</entities-count>
   <properties-count type="integer">0</properties-count>
 </database>
 <database>
   <id>aOWO3eVXHdHie1WeGFE8k2</id>
   <name>Database Name 2</name>
   <created-at type="datetime">2011-04-29T01:26:22-05:00</created-at>
   <updated-at type="datetime">2011-08-16T00:47:56-05:00</updated-at>
   <dtypes-count type="integer">768</dtypes-count>
   <entities-count type="integer">6</entities-count>
   <properties-count type="integer">240</properties-count>
 </database>
</databases>

After removing database this call returns all databases which were left.

Create Database

Parameters

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.

Making request (JSON)

Format

JSON

Method

POST

URL

/apps.json

Request body

{"rest_api_key":"API_KEY", database_name: "Database 1", form_name: "Form 1"}

Response: returns database information

    
{"database":
   {"id"              : "aOWO_dVXHdHie1WeGFE8k2"
    "name"            : "Database Name 1",
    "created_at"      : "2011-08-16T05:42:40-05:00",
    "updated_at"      : "2011-08-16T05:42:40-05:00",
    "dtypes_count"    : 0,
    "entities_count"  : 1,
    "properties_count": 0
    }
}

Making request (XML)

Format

XML

Method

POST

URL

/apps.xml

Request body

<?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>

Response: returns database information

    
  <?xml version="1.0" encoding="UTF-8"?>
    <database>
      <id>aOWO_dVXHdHie1WeGFE8k2</id>
      <name>Database name 1</name>
      <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
      <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
      <dtypes-count type="integer">0</dtypes-count>
      <entities-count type="integer">1</entities-count>
      <properties-count type="integer">0</properties-count>
    </database>

In case of error. You'll get error message, i.e. 'Such app name already exist'.

Form

Such form attributes can be accessible via REST API.

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

Fetch all database forms

Parameters

rest_api_key

your API key

APP_ID

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/entities.json

Request body

{rest_api_key":"API_KEY"}

Response: fetch all database forms

    
{"forms":[
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
 },
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/entities.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response: fetch all database forms

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

Get Form by ID

Parameters

rest_api_key

your API key

APP_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.json

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/entities/ID.json

Request body

{"rest_api_key":"API_KEY"}

Response: returns form information

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/entities/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

Get Form by Name

Parameters

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.

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/search/entities/search.json

Request body

{"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1"}

Response: returns form information

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/search/entities/search.xml

Request body

<?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>

Response: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

Update form

Parameters

rest_api_key

your API key

APP_ID

name

New form name. See all available attributes here

Making request (JSON)

Format

JSON

Method

PUT

URL

/apps/APP_ID/entities/ID.json

Request body

{"rest_api_key":"API_KEY",
"name":"New form name"}

Response: returns form information

    
{"form":   
{   
"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
"name"            : "New form name",
"desc"            : "Form description",
"post_action"     : "email@email.com",
"position"        : 0,
"sort_by"         : null,
"asc"             : false,
"per_page"        : 10,
"allow_delete"    : false,
"new_widget"      : null,
"records_widget"  : null,
"target_page"     : null,
"allow_database"  : true,
"send_emails"     : true,
"settings"        : null
     }
}

Making request (XML)

Format

XML

Method

PUT

URL

/apps/APP_ID/entities/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New form name</name>
</api_call_params>

Response: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>New form name</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

Delete form

Parameters

rest_api_key

your API key

APP_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

Making request (JSON)

Format

JSON

Method

DELETE

URL

/apps/APP_ID/entities/ID.json

Request body

{"rest_api_key":"API_KEY"}

Response

    
{"forms":[{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
       },
      {  "id"      : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

Making request (XML)

Format

XML

Method

DELETE

URL

/apps/APP_ID/entities/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

Create Form

Parameters

rest_api_key

your API key

APP_ID

name

Form name

Making request (JSON)

Format

JSON

Method

POST

URL

/apps/APP_ID/entities.json

Request body

{"rest_api_key":"API_KEY", name: "New form"}

Response: returns form information

    
{"form":   
{   
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "New form",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

Format

XML

Method

POST

URL

/apps/APP_ID/entities.xml

Request body

<?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>

Response: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>New form</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

Field

Such field properties can be fetched via REST API.

Unique field identifier. You'll need this to access this field

entity_id

Field's form identifier.

name

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, signature, linked_column, rel, subform

Fetch all form fields

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties.json

Request body

{rest_api_key":"API_KEY"}

Response: fetch all form fields

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response: fetch all form fields

    
<?xml version="1.0" encoding="UTF-8"?>
<fields type="array">
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
<field>
  <id>ddUHDhCgzeW6HkW4NdG3vE</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test2</name>
  <desc nil="true"></desc>
  <type-name>select</type-name>
  <default>1slct2slct3slct4slct5</default>
  <validate-options></validate-options>
  <position type="integer">1</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
</fields>

Get Field by ID

Parameters

rest_api_key

your API key

APP_ID

ENTITY_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

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

Request body

{"rest_api_key":"API_KEY"}

Response

    
{"field":  
{
"id"               : "aOWO_dVXHdHie1WeGFE8k2",
"entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
"name"             : "Field Name 1",
"desc"             : "Field description",
"type_name"        : "string",
"default"          : "default value",
"validate_options" : "",
"position"         : 0,
"visible"          : true,
"size": 50,
"cols": 43,
"rows": 10
}
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
 <id>clrSoltHDdQyozW5NcLrGd</id>
 <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
 <name>test</name>
 <desc nil="true"></desc>
 <type-name>string</type-name>
 <default></default>
 <validate-options></validate-options>
 <position type="integer">0</position>
 <visible type="boolean">true</visible>
 <size type="integer">50</size>
 <cols type="integer">43</cols>
 <rows type="integer">10</rows>
</field>

Get Field by Name

Parameters

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.

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.

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/search/entities/search/properties/search.json

Request body

{"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1", "field_name": "Field Name 1"}

Response

    
{"field":  
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/search/entities/search/properties/search.xml

Request body

<?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>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>

Run action

Parameters

rest_api_key

your API key

DTYPE_ID

You have to know your record identifier. You can find ID using Fetch All Records call.

ACTION_PROPERTY_ID

You have to know your field identifier. You can find ID using Fetch All Form Fields call.

Making request (JSON)

Format

JSON

Method

GET

URL

/actions/ACTION_PROPERTY_ID.json

Request body

{"rest_api_key":"API_KEY", "dtype_id": "DTYPE_ID"}

Response

    
{\"success\":\"Done\"}

Making request (XML)

Format

XML

Method

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<dtype_id>DTYPE_ID</dtype_id>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Run actions

Parameters

rest_api_key

your API key

ACTION_PROPERTY_ID

You have to know your field identifier. You can find ID using Fetch All Form Fields call.

dtype_ids

You have to know your records identifiers. You can find ID using Fetch All Records call.

json_dtype_ids

You can send your dtype ids in JSON format. You can find ID using Fetch All Records call. (Optional)

run_by_all_table_or_report

The following parameter is available to run all actions in table or report: run_by_all_table_or_report: true.

view

You have to know your report id in order to fetch records. (Optional)

Making request (JSON)

Format

JSON

Method

GET

URL

/actions/ACTION_PROPERTY_ID.json

Request body

{"rest_api_key":"API_KEY", "dtype_ids": ["ID1","ID2"...]}

{"rest_api_key":"API_KEY", "json_dtype_ids": "[\"ID1\",\"ID2\"...]"}

{"rest_api_key":"API_KEY", "run_by_all_table_or_report": true}

Response

    
{\"success\":\"Done\"}

Making request (XML)

Format

XML

Method

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<dtype_ids>"ID1","ID2"...</dtype_ids>
</api_call_params>

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
</api_call_params>

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<run_by_all_table_or_report>true</run_by_all_table_or_report>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Update field

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

name

New field name. See all available attributes here

Making request (JSON)

Format

JSON

Method

PUT

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

Request body

{"rest_api_key":"API_KEY",
"name":"New field name"}

Response

    
{"field":  
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
"name"             : "Field Name 1",
"desc"             : "Field description",
"type_name"        : "string",
"default"          : "default value",
"validate_options" : "",
"position"         : 0,
"visible"          : true,
"size": 50,
"cols": 43,
"rows": 10
}
}

Making request (XML)

Format

XML

Method

PUT

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

Request body

<?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>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>

Delete field

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

Making request (JSON)

Format

JSON

Method

DELETE

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

Request body

{"rest_api_key":"API_KEY"}

Response

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

Making request (XML)

Format

XML

Method

DELETE

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<fields type="array">
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
<field>
  <id>ddUHDhCgzeW6HkW4NdG3vE</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test2</name>
  <desc nil="true"></desc>
  <type-name>select</type-name>
  <default>1slct2slct3slct4slct5</default>
  <validate-options></validate-options>
  <position type="integer">1</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
</fields>

Create Field

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

name

New form field name

type_name

Making request (JSON)

Format

JSON

Method

POST

URL

/apps/APP_ID/entities/ENTITY_ID/properties.json

Request body

{"rest_api_key":"API_KEY", name: "Field name 1", type_name: "string"}

Response: returns form information

    
{"field": 
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

Making request (XML)

Format

XML

Method

POST

URL

/apps/APP_ID/entities/ENTITY_ID/properties.xml

Request body

<?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>

Response: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
  <field>
    <id>clrSoltHDdQyozW5NcLrGd</id>
    <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
    <name>test</name>
    <desc nil="true"></desc>
    <type-name>string</type-name>
    <default></default>
    <validate-options></validate-options>
    <position type="integer">0</position>
    <visible type="boolean">true</visible>
    <size type="integer">50</size>
    <cols type="integer">43</cols>
    <rows type="integer">10</rows>
  </field>
</field>

Get total by column

Parameters

rest_api_key

your API key

ENTITY_ID

view

You have to know your report id in order to fetch records. (Optional)

Making request (JSON)

Format

JSON

Method

GET

URL

/search/sum/ENTITY_ID/ID.json

Request body

{"rest_api_key":"API_KEY",
view: "ImWO3eVXHdHie1WeGFE8k2"}

Response

    
{total: 3}

Making request (XML)

Format

XML

Method

GET

URL

/search/sum/ENTITY_ID/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<view>ImWO3eVXHdHie1WeGFE8k2</view>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<total>
 3
</total>

Record

Such record attributes can be accessible via REST API.

Unique record identifier. You'll need this to access this record.

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.

json_values

Record values hash. Where key is field id and value is this field value. Analogue of values_hash but in JSON format

rel_values

Record relationships values hash. Where key is field id and value is the linked record ID.

Fetch all records

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

view

You have to know your report id in order to fetch records. (Optional)

page

Records page number. From 1 to Table Records count/per_page.

name_value

Use the parameter to get data of type: "field name": "value", "field id": "field name"

fetch_all

For owners of paid accounts, the following parameter is available: fetch_all=true.
To get a specific number of posts, use the per_page parameter.
Restrictions on the maximum number of entries per_page for different plans:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Request body
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/dtypes/entity/ENTITY_ID.json

Request body

{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP'}

Response

    
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/dtypes/entity/ENTITY_ID.json

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<view>EaWQZdIXfahOqWvcvwrGTP</view>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<records type="array">
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>2</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>aaa</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>ddd</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>
<record>
<id>dcQSkdWO1odA5HAmkYWOix</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>1</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>test</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>test2</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T04:28:10-05:00</created-at>
<updated-at type="datetime">2011-09-17T04:28:10-05:00</updated-at>
</record>
</records>

Get record

Parameters

rest_api_key

your API key

APP_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

name_value

Use the parameter to get data of type: "field name": "value", "field id": "field name"

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/dtypes/ID.json

Request body

{"rest_api_key":"API_KEY", "name_value": 1}

Response

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/dtypes/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>2</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>aaa</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>ddd</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Update record

Parameters

rest_api_key

your API key

APP_ID

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.

Making request (JSON)

Format

JSON

Method

PUT

URL

/apps/APP_ID/dtypes/ID.json

Request body

{"rest_api_key":"API_KEY", "values": {"aNW4nkW5bdUjldO8oKuSku" : 3, "aMW4HKWR9bnOoGWQbpWQS4" : "b", "cMW6pcTSjbWOFdTCkBtmkN" : "c"}}

Response

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

Format

XML

Method

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Request body

<?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>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Update multiple records

Parameters

rest_api_key

your API key

confirm_action

The following parameter is required to run update in table or report: confirm_action: update.

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.

APP_ID

You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call.

dtype_ids

You have to know your records identifiers. You can find ID using Fetch All Records call.

json_dtype_ids

You can send your dtype ids in JSON format. You can find ID using Fetch All Records call. (Optional)

update_id

You have to know your field identifier. You can find ID using Fetch All Form Fields call.

update_term

New value for records

view

You have to know your report id in order to fetch records. (Optional)

Making request (JSON)

Format

JSON

Method

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Request body

{rest_api_key: "YOUR_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

{rest_api_key: "YOUR_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
dtype_ids: ["ID1","ID2"...],
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

Response

    
{\"success\":\"Done\"}

Making request (XML)

Format

XML

Method

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Request body


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <dtype_ids>"ID1","ID2"...</dtype_ids>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Update all records

Parameters

rest_api_key

your API key

confirm_action

The following parameter is required to run update of all records in table or report: confirm_action: update_all.

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.

APP_ID

You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call.

update_id

You have to know your field identifier. You can find ID using Fetch All Form Fields call.

update_term

New value for records

view

You have to know your report id in order to fetch records. (Optional)

Making request (JSON)

Format

JSON

Method

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Request body

{rest_api_key: "YOUR_KEY",
confirm_action: "update_all",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

Response

    
{\"success\":\"Done\"}

Making request (XML)

Format

XML

Method

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Request body


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update_all</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Update data cell

Parameters

rest_api_key

your API key

PROPERTY_ID

DTYPE_ID

val

New cell value

Making request (JSON)

Format

JSON

Method

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Request body

{"rest_api_key":"API_KEY", "property_id": "aNW4nkW5bdUjldO8oKuSku", "dtype_id": "cMW6pcTSjbWOFdTCkBtmkN", "val": "John Smith"}

Response

    
{"new_value": "John Smith"}

Making request (XML)

Format

XML

Method

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Request body

<?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>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<new_value>
John Smith
</new_value>

Delete record

Parameters

rest_api_key

your API key

APP_ID

Making request (JSON)

Format

JSON

Method

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Request body

{"rest_api_key":"API_KEY"}

Response

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

Format

XML

Method

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Request body

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
  <id>bYWQnuBajdBOkAW4BdMmki</id>
  <app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
  <entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
  <values>
    <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
    <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
    <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
  </values>
  <approved type="boolean">false</approved>
  <created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
  <updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Delete multiple

Parameters

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.

APP_ID

You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call.

dtype_ids

You have to know your records identifiers. You can find ID using Fetch All Records call.

json_dtype_ids

You can send your dtype ids in JSON format. You can find ID using Fetch All Records call. (Optional) (Optional)

Making request (JSON)

Format

JSON

Method

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Request body

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]"}

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
dtype_ids: ["ID1","ID2"...]}

Response

    
{\"success\":\"Done\"}

Making request (XML)

Format

XML

Method

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Request body


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
  </api_call_params>


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <dtype_ids>"ID1","ID2"...</dtype_ids>
  </api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Delete all

Parameters

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.

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.

view

You have to know your report id in order to fetch records. (Optional)

Making request (JSON)

Format

JSON

Method

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Request body

{rest_api_key: "YOUR_KEY", entity_id: "ENTITY_ID"}

Response

    
{\"success\":\"Done\"}

Making request (XML)

Format

XML

Method

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Request body


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
  </api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Create record

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

If you need to use your personal ID, you can generate UUID (unique identifier) < / a> 22 characters long URL-safe base64 For example in Ruby . Next you will need to pass it to the 'values' hash, for example: values => {' id '=> ID}, change to: values => {' id '=>' 22adadVXHdHie1WeGFE8k2 '}, otherwise the system will generate a unique identifier for you.

values / json_values

subforms_values / subforms_json_values

Making request (JSON)

Format

JSON

Method

POST

URL

/apps/APP_ID/dtypes.json

Request body

{"rest_api_key":"API_KEY", "values": {"entity_id" : ENTITY_ID, "id" : ID, "aNW4nkW5bdUjldO8oKuSku":"3", "aMW4HKWR9bnOoGWQbpWQS4":"b","cMW6pcTSjbWOFdTCkBtmkN":"c"}}

Response: returns form information

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

Format

XML

Method

POST

URL

/apps/APP_ID/dtypes.xml

Request body

<?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>

Response: returns form information

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
  <id>bYWQnuBajdBOkAW4BdMmki</id>
  <app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
  <entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
  <values>
    <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
    <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
    <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
  </values>
  <approved type="boolean">false</approved>
  <created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
  <updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Parameters

rest_api_key

your API key

APP_ID

ENTITY_ID

view

You have to know your report id in order to fetch records. (Optional)

search

Would you like a flick on the table? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - field identifier by which we are searching ( -ALL - - to search all columns),
SEARCH_TERM - the value we are looking for,
SEARCH_CRITERIA - criterion for a message, maybe one of them:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

For regular numbers and dates : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

For a date for about an hour : before, after, this_day_and_before, this_day_and_after, yesterday, today, tomorrow, today_or_later, last_7_days, last_30_days,
last_60_days, last_90_days, last_120_days, next_7_days, next_30_days, next_60_days, next_90_days, next_120_days, next_n_days, last_n_days,
last_week, this_week, next_week, current_and_prev_week, current_and_next_week, next_n_weeks, last_n_weeks, last_month, this_month, next_month,
current_and_prev_month, current_and_next_month, next_n_months, last_n_months, last_year, this_year, last_2_years, next_2_years, current_and_prev_year,
current_and_next_year, next_n_years, last_n_years.

System columns : added_by, created_at, updated_at, ip.

If you want to search in several columns with a unifying "AND" criterion, then these criteria should be placed in one array, if "OR", then into a separate one, for example:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "is"}, {"a" => "PROPERTY_ID_2", "b" => "A", "o" => "is"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

the search formula will be: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

The number of records in the search results, the maximum is 200.

Making request (JSON)

Format

JSON

Method

POST

URL

/search/APP_ID.json

Request body

{"rest_api_key":"API_KEY", "entity_id" => "ENTITY_ID", "search": [[{"a"=>"aNW4nkW5bdUjldO8oKuSku", "b"=>"value name 1", "o"=>"is"}]]}

Response

    
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}

Relationships

How to link records:

In order to update link between records your have to pass separate hash into CREATE or UPDATE record call.

curl -H 'Content-Type: application/json' -X PUT -d '{"rel":{REL_ID:RECORD_ID}}' "https://quintadb.com/apps/APP_ID/dtypes/CURRENT_RECORD_ID.json?rest_api_key=API_KEY"

This hash should be like 'rel' => {rel_id => RECORD_ID} or 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} if you have many-to-many relationship. Where RECORD_ID it's a record's ID with which you want to link current record. Please, see below how to get rel_id.

Parameters

rest_api_key

your API key

PROPERTY_ID

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

Making request (JSON)

Format

JSON

Method

GET

URL

/entities/ENTITY_ID/get_rel_id/PROPERTY_ID.json?rest_api_key=API_KEY

Request body

{"rest_api_key":"API_KEY", {"entity_id" : ENTITY_ID, "property_id" : PROPERTY_ID}}

Response

Reports

Such report attributes can be accessible via REST API.

name

Name

Get Reports

Parameters

rest_api_key

your API key

APP_ID

App ID

ENTITY_ID

Table (Form) ID

Making request (JSON)

Format

JSON

Method

GET

URL

/apps/APP_ID/entities/ENTITY_ID/views/index.json

Request body

{"rest_api_key":"API_KEY"}

Response: returns all table reports.

    
{"reports":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Report Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "entity_id"    : 'aEWQZdIXfahOqWvcvwrGTP',
 "app_id"  : 'ddIbpcNSncW5xcHxpdHCoW'
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Report Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "entity_id"       : 'RtWQZdIXfahOqWvcvwrGTP',
 "app_id"          : 'ddIbpcNSncW5xcHxpdHCoW'
} ]}

Making request (XML)

Format

XML

Method

GET

URL

/apps/APP_ID/entities/ENTITY_ID/views/index.xml

Request body: returns all table reports.

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

Response

    
<?xml version="1.0" encoding="UTF-8"?>
<reports type="array">
<report>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>
<record>
<id>dcQSkdWO1odA5HAmkYWOix</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<created-at type="datetime">2011-09-17T04:28:10-05:00</created-at>
<updated-at type="datetime">2011-09-17T04:28:10-05:00</updated-at>
</report>
</reports>

Files

Get file URL

In order to download record files you have to fetch record values first and then you'll be able to download file using the link like this https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, where FILE_NAME - file name, which you can get from record values hash, which looks likeу PROPERTY_ID => VALUE, RECORD_ID - record ID, PROPERTY_ID - field ID.

Upload files

In order to upload a file into a record you have to make a POST request to the upload_file API method with multipart/form-data content type header and only after that you have to create or update your record. So the record ID should be generated before the calls. And also you'll have to generate the Multipart header, please, follow the Ruby example with MultipartPost class below. In example you'll learn how to upload the file into the subform too.

Ruby example

  
    require 'open-uri'
    require 'openssl'

    require 'net/http'
    require 'json'
    require 'securerandom'

    #MultipartPost
    class MultipartPost
      BOUNDARY = "-----------RubyMultipartPost"
      EOL = "\r\n"

      def initialize uri, &block
        @params = Array.new
        @uri = URI.parse uri
        instance_eval &block if block
      end

      def params_part key, value
        @params << multipart_text(key, value)
      end

      def files_part key, filename, mime_type, content
        @params << multipart_file(key, filename, mime_type, content)
      end

      def request_body
        body = @params.map{|p| "--#{BOUNDARY}#{EOL}" << p}.join ""
        body << "#{EOL}--#{BOUNDARY}--#{EOL}"
      end

      def run
        https = Net::HTTP.new @uri.host, @uri.port
        https.use_ssl = true
        https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
        request = Net::HTTP::Post.new @uri.request_uri
        request.body = request_body
        request.set_content_type "multipart/form-data", {"boundary" => BOUNDARY}
        res = https.request request
        res.body
      end

      private
      def multipart_text key, value
        content = "Content-Disposition: form-data; name=\"#{key}\"" <<
          EOL <<
          EOL <<
          "#{value}" << EOL
      end

      def multipart_file key, filename, mime_type, content
        content = "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{filename}\"#{EOL}" <<
          "Content-Type: #{mime_type}\r\n" <<
          EOL <<
          "#{content}" << EOL
      end
    end #MultipartPost

    def call_quinta(url, format, method, params={})
      uri = URI.parse(url)

      req = case method
              when "get"
                Net::HTTP::Get.new(uri.path) 
              when "post" 
                Net::HTTP::Post.new(uri.path)
              when "put"
                Net::HTTP::Put.new(uri.path)
              when "delete"
                Net::HTTP::Delete.new(uri.path)
            end

      req.body = case format
                  when "json"
                    JSON.generate(params)
                  else
                    "no"
                end
      
      req["Content-Type"] = "application/#{format}"

      https = Net::HTTP.new(uri.host, uri.port)

      https.use_ssl = (uri.scheme == 'https')
      https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)

      https.start do |htt| 
        htt.request(req)
      end
    end

    dtype_id = SecureRandom.urlsafe_base64

    app_id   = "bsx8kgWR9jWOBdUftcRXf9"
    entity_id = "arjadcLJzeWOi1WPddL8ol"
    property_id = "bwW68wWP1cSikQqSkhl04I"

    post_url = "https://localhost:3001/entities/#{app_id}/upload_file/#{property_id}.json?dtype_id=#{dtype_id}"

    # Path to your file
    file_path = "/home/igor/Pictures/Selection_001.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip


    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      files_part "dtype[#{property_id}]", "Selection_001.png",
        file_content_type, file.read
    end
    p multi_part.run

    # And below is the example of how to upload the file to Subform
    rest_api_key          = "API_KEY"
    subform_field_id      = "dcL8kXB8npd5pdRmk7BCoR"
    subform_file_field_id = "aVWR3cNtvdUikQn8o3yCo1"
    subform_form_id       = "cCcxjdWRXpWPTLWOjvWPfO"
    subform_dtype_id      = SecureRandom.urlsafe_base64

    file_path = "/home/igor/Pictures/Selection_002.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip

    post_url = "https://quintadb.com/entities/#{app_id}/upload_file/#{subform_file_field_id}.json?dtype_id=#{subform_dtype_id}"

    # upload file into subform record
    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      params_part "subform_field", subform_field_id
      params_part "property_id", subform_file_field_id
      params_part "subform_dtype_id", subform_dtype_id
      files_part "subforms[#{subform_field_id}][#{subform_dtype_id}][#{subform_file_field_id}]", "Selection_002.png",
        file_content_type, file.read
    end
    p multi_part.run

    text_field_on_a_form = "agW6rGWQHiWPvdWPL0oCoj"
    text_field_on_a_subform = "dcV8k6y8nhWP4JF0r6W5LI"
    params = { 
      :page => 1,
      :rest_api_key => rest_api_key,  
      values: {entity_id: entity_id, id: dtype_id, text_field_on_a_form =>  "Test"},
      subforms: {subform_field_id => {entity_id: subform_form_id, subform_dtype_id => { text_field_on_a_subform => "Test2"}}}
    }
    response = call_quinta "https://quintadb.com/apps/#{app_id}/dtypes.json", "json", "post", params

    puts response.body

Parameters

rest_api_key

your API key

APP_ID

property_id

dtype_id

Making request (JSON)

Format

JSON

Method

POST

URL

/entities/APP_ID/upload_file/PROPERTY_ID.json?dtype_id=DTYPE_ID

Request body

{"rest_api_key"=>API_KEY, "filedata"="your_file_here", "dtype_id"=>"fRLA83jrnAUOi5TEQLyuGw", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9"}

Response

    Uploaded

Remove files

Parameters

rest_api_key

your API key

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

File name

Making request (JSON)

Format

JSON

Method

GET

URL

/dtypes/delete_dtype_file/APP_ID/DTYPE_ID/PROPERTY_ID.json

Request body

{"rest_api_key"=>API_KEY, "single_file_name"=>"Selection_002.png", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9", "dtype_id"=>"wlS5MeyMqQiCv16FdG3ztQ", "property_id"=>"bwW68wWP1cSikQqSkhl04I"}

Response

    File removed

Examples

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

def call_mth(url, format, method, params={})
  uri = URI.parse(url)

	# Creating proper call with Method: GET/POST/PUT/DELETE
  req = case method
          when "get"
            Net::HTTP::Get.new(uri.path) 
          when "post" 
            Net::HTTP::Post.new(uri.path)
          when "put"
            Net::HTTP::Put.new(uri.path)
          when "delete"
            Net::HTTP::Delete.new(uri.path)
        end

  # Convert the parameters into JSON/XML and set the content type as application/json or application/xml Notice the XML format for parameters, the root element is api_call_params
  req.body = case format
              when "xml"
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
                  <api_call_params>
                    #{params.collect{|key, value| "<#{key}>#{value}"}.join("")}
                  </api_call_params>"
              when "json"
                JSON.generate(params)
              else
                "no"
            end
	# Setting content type
  req["Content-Type"] = "application/#{format}"

  https = Net::HTTP.new(uri.host, uri.port)

  # All calls via HTTPS and verifying SSL certificates

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# Making request
  https.start do |htt| 
    htt.request(req)
  end
end


# Make sure to set your own API_KEY here
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Response will be in response.body
puts response.body

It is well known that software development is very important these days. Having REST API for your software will increase your product popularity very much.This is a basic REST API and it should be enough to create great things. However, if you need anything else, more methods etc., please, feel free to contact us at any time. We look forward to hear from you!

QuintaDB REST API

General information about API calls

Database

Form

Field

Record

Reports

Files

QuintaDB.com uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our cookie policy.