Увійти

Увійти

 

QuintaDB REST API



QuintaDB REST API Створено для того, щоб ви змогли оцінити весь потенціал даних, що зберігаються в вашій QuintaDB базі даних. Використовуючи цей API, ви зможете досягти більшого, ніж пропонує на даний момент інтерфейс QuintaDB. Фактично, ми надаємо вам можливість робити з вашими даними все, що вам необхідно. Наприклад, ви можете створювати свої власні скрипти, настільні та мобільні додатки для різних платформ, таких як iPhone/Android і багато іншого. І QuintaDB буде залишатися місцем, де ви зберігаєте, керуєте і використовуєте ваші дані разом з іншими.

Як поєднати QuintaDB та сервіс Thunkable, дивіться за цим посиланням (англійська мова).

У QuintaDB є власний додаток на сервісі Zapier.




Загальна інформація про виклики API

Всі виклики повинні містити REST API ключ, який можна знайти в меню 'API' згори праворуч сторінки.
Відповідь з сервера може бути отримана в форматі JSON або XML, в залежності від вашого запиту.
Нижче ми покажемо таблиці з відповідями сервера для кожного запиту. URL будуть показані у вигляді /apps.json. Це означає, що ви повинні викликати метод з посиланням https://QuintaDB.ru/apps.json в вашій програмі. Будь ласка, зверніть увагу на те, що всі виклики повинні використовувати протокол https і вам необхідно перевіряти SSL-сертифікат на валідність.

База даних

Отримати всі бази даних
Отримати базу даних за ID
Отримати базу даних за Іменем
Поновити базу даних
Видалити базу даних
Створити проект

Запис

Отримати записи
Отримати записи з звіта
Отримати запис
Поновити запис
Поновити комірку даних
Видалити запис
Створити запис
Зв'язки
Отримати посилання на файл

Форма

Отримати всі форми
Отримати форму за ID
Отримати форму за Назвою
Поновити форму
Видалити форму
Створити форму

Поле

Отримати поля форми
Отримати поле
Отримати поле за Іменем
Поновити поле
Видалити поле
Створити поле

Приклад на Ruby ~ Приклад на Javascript (jQuery)


База даних

Такі атрибути бази даних можуть бути отримані при використанні REST API.
Атрибут Опис
id Унікальний ідентифікатор бази даних
name Назва
created_at Час, коли база даних була створена
updated_at Час, коли база даних була поновлена
dtypes_count Кількість записів в базі даних
entities_count Кількість таблиць в базі даних
properties_count Кількість колонок в базі даних
Отримати всі бази даних - повертає всі бази даних
Параметр Опис
rest_api_key ваш API-ключ
page Бази даних показуються по 20 на сторінку, тобто page может бути 1..5
Формат URL Метод Тіло запросу Відповідь
JSON /apps.json GET {"page":1,"rest_api_key":"API_KEY"}

{"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
} ]}
         
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>

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

Отримати базу даних за ID - повертає інформацію про базу даних
Параметр Опис
rest_api_key ваш API-ключ
ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/ID.json GET {"rest_api_key":"API_KEY"}

{"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
 }
}
         
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>

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

Отримати базу даних за Іменем - повертає інформацію про базу даних
Параметр Опис
rest_api_key ваш API-ключ
Назва Вам потрібно знати назву бази даних. Назву можна отримати, виконавши запит Отримати всі бази даних .
Формат URL Метод Тіло запросу Відповідь
JSON /apps/search.json GET {"rest_api_key":"API_KEY", "name":"Database Name 1"}

{"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
  }
}
         
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>

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

Поновити базу даних - ви можете поновити назву бази даних
Параметр Опис
rest_api_key ваш API-ключ
name Нова назва бази даних
ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/ID.json PUT {"rest_api_key":"API_KEY",
"name":"New database name"}

{"database":{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "New database name",
 "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
 }
}
         
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>

<?xml version="1.0" encoding="UTF-8"?>
<database>
  <id>aOWO_dVXHdHie1WeGFE8k2</id>
  <name>New database name</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>

Видалити базу даних - видаляє базу даних
Параметр Опис
rest_api_key ваш API-ключ
ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/ID.json DELETE {"rest_api_key":"API_KEY"}


{"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
} ]}

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>

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

Після видалення бази цей метод повертає всі бази даних, що залишилися.
Створити проект - Створити новий проект
Параметр Опис
rest_api_key ваш API-ключ
database_name Назва бази даних
form_name Назва форми. Ви не можете створити базу даних без форми, тому що немає сенсу в базі даних без форми.
Формат URL Метод Тіло запросу Відповідь
JSON /apps.json POST {"rest_api_key":"API_KEY", database_name: "Database 1", form_name: "Form 1"}

{"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
    }
}
         
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>

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

У разі виникнення помилки ви отримаєте повідомлення, наприклад 'Проект з таким іменем вже існує'.

Форма

Такі атрибути форми можуть бути отримані через REST API.
Атрибут Опис
id Унікальний ідентифікатор форми
name Назва
desc Опис
post_action Перелік одержувачів емейл-повідомлень
target_page URL переходу. На цю сторінку буде перенаправлений користувач, що заповнив веб форму
position Позиція форми. Показує порядок, в якому форма буде отримана в порівнянні з іншими формами бази даних
sort_by Ідентифікатор поля, за яким відсортовані записи форми
asc true або false. Що означає по зростанню або зменшенню сортовані записи
per_page Скільки записів показується на сторінці
allow_delete true або false. Коли true, користувачі зможуть видаляти записи з інтегрованої бази даних
allow_database true або false. Коли true, користувачі зможуть бачити всі записи БД в інтегрованій базі даних
send_emails true або false. Посилати чи ні емейл-сповіщення про нові записи, додані в БД
new_widget Хеш налаштувань віджета форми
records_widget Хеш налаштувань віджета БД
settings Хеш налаштувань форми
Отримати всі форми - отримати всі форми бази даних
Параметр Опис
rest_api_key ваш API-ключ
ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/ID/entities.json GET {"rest_api_key":"API_KEY"}

{"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
      } ]}
         
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>

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

Отримати форму за ID - повертає інформацію про форму
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ENTITY_ID в URL, наприклад: /apps/APP_ID/entities.json на /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ID.json GET {"rest_api_key":"API_KEY"}

{"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
      }
}
         
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>

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

Отримати форму за Назвою - повертає інформацію про форму
Параметр Опис
rest_api_key ваш API-ключ
Назва бази даних Вам потрібно знати назву бази даних. Назву можна отримати, виконавши запит Отримати всі бази даних .
Назва форми Ви повинні знати назву форми. Її можна отримати, використовуючи виклик Отримати всі форми .
Формат URL Метод Тіло запросу Відповідь
JSON /apps/search/entities/search.json GET {"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1"}

{"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
     }
}

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>

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

Поновити форму - ви можете поновити такі атрибути форми
Параметр Опис
rest_api_key ваш API-ключ
name Нова назва форми. Дивіться всі доступні параметри
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ENTITY_ID в URL, наприклад: /apps/APP_ID/entities.json на /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ID.json PUT {"rest_api_key":"API_KEY",
"name":"New form name"}

{"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
     }
}
         
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>

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

Видалити форму - видаляє форму з проекту
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ID Ви повинні знати ідентифікатор форми, яку хочете видалити. Ви можете знайти ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ID.json DELETE {"rest_api_key":"API_KEY"}

{"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
      } ]}
         
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>

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

Створити форму - додати нову форму в проект
Параметр Опис
rest_api_key ваш API-ключ
name Назва форми
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ID.json POST {"rest_api_key":"API_KEY",
"name":"New form"}

{"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
      }
}
         
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>

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

Поле

Такі атрибути поля можуть бути отримані через REST API.
Атрибут Опис
id Унікальний ідентифікатор поля
entity_id Ідентифікатор форми поля
name Назва
desc Опис
type_name Тип поля. Може бути: 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 Значення поля за замовчуванням
validate_options Опції валідації
position Позиція поля на формі
visible true або false. ППоказує, чи видима дана колонка в інтегрованій базі даних
size Розмір поля
cols Колонки поля з типом Таблиця
rows Рядки поля з типом Таблиця
Отримати поля форми - отримати всі поля форми
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ENTITY_ID в URL, наприклад: /apps/APP_ID/entities.json на /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ID/properties.json GET {"rest_api_key":"API_KEY"}

{"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
 }
	]}
         
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>


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

Отримати поле - ви можете отримати такі атрибути поля
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ENTITY_ID в URL, наприклад: /apps/APP_ID/entities.json на /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
ID Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ENTITY_ID/properties/ID.json GET {"rest_api_key":"API_KEY"}

{"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
}
}
         
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>

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

Отримати поле за Іменем - ви можете отримати такі атрибути поля
Параметр Опис
rest_api_key ваш API-ключ
Назва бази даних Should Know Db Name For Field Html
Назва форми Ви повинні знати назву форми. Її можна отримати, використовуючи виклик Отримати всі форми .
Назва поля Ви повинні знати назву поля. Її можна отримати, використовуючи виклик Отримати всі поля форми .
Формат URL Метод Тіло запросу Відповідь
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"}

{"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
 }
}
         
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>

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

Поновити поле - ви можете поновити такі атрибути поля
Параметр Опис
rest_api_key ваш API-ключ
name Нова назва поля. Всі доступні атрибути можна знайти
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ENTITY_ID в URL, наприклад: /apps/APP_ID/entities.json на /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
ID Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ENTITY_ID/properties/ID.json PUT {"rest_api_key":"API_KEY",
"name":"New field name"}

{"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
}
}
         
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>

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

Видалити поле - видаляє поле форми
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми вам необхідно замінити ENTITY_ID в URL, наприклад /apps/APP_ID/entities/ENTITY_ID/properties.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json
ID Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ENTITY_ID/properties/ID.json DELETE {"rest_api_key":"API_KEY"}

{"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
 }
	]}

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>


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

Створити поле - додає нове поле на форму
Параметр Опис
rest_api_key ваш API-ключ
name Назва поля
type_name Тип поля. Може бути: 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 Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми вам необхідно замінити ENTITY_ID в URL, наприклад /apps/APP_ID/entities/ENTITY_ID/properties.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/entities/ENTITY_ID/properties.json POST {"rest_api_key":"API_KEY", name: "Field name 1", type_name: "string"}

{"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
 }
}
         
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>

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

Запис

Такі атрибути запису можуть бути отримані через REST API.
Атрибут Опис
id Унікальний ідентифікатор запису.
page Записи показуються посторінково по per_page записів на сторінці.
app_id ID проекту
entity_id Ідентифікатор форми запису.
values Хеш значень запису. Де ключем єідентифікатор поля, а значенням - значення поля.
approved Якщо включена модерація бази даних, то цей атрибут показує, чи доуступний запис в інтегрованій базі даних.
created_at Час, коли запис був створений.
updated_at Час, коли запис був оновлений.
Отримати записи - отримати всі записи форми
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми, вам потрібно замінити ENTITY_ID в URL, наприклад: /apps/APP_ID/entities.json на /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
page Номер сторінки з записами. Від 1 до кількість записів/per_page.
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/dtypes/entity/ENTITY_ID.json GET {"rest_api_key":"API_KEY", "page": 1}
	
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"2",
"aMW4HKWR9bnOoGWQbpWQS4":"aaa",
"cMW6pcTSjbWOFdTCkBtmkN":"ddd"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"dcQSkdWO1odA5HAmkYWOix",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"1",
"aMW4HKWR9bnOoGWQbpWQS4":"test",
"cMW6pcTSjbWOFdTCkBtmkN":"test2"},
"approved":false,
"created_at":"2011-09-17T04:28:10-05:00",
"updated_at":"2011-09-17T04:28:10-05:00"
}
]
}
	         
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>

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

Отримати записи з звіта - отримати всі записи звіта
Параметр Опис
rest_api_key ваш API-ключ
view Щоб отримати записи, ви повинні знати ID звіту.
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/dtypes/entity/ENTITY_ID.json GET {"rest_api_key":"API_KEY", "view": REPORT_ID}
		
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"2",
"aMW4HKWR9bnOoGWQbpWQS4":"aaa",
"cMW6pcTSjbWOFdTCkBtmkN":"ddd"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}
		
	
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>

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

Отримати запис - ви можете отримати доступ до таких атрибутів запису
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ID Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/dtypes/ID.json GET {"rest_api_key":"API_KEY"}

{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"2",
"aMW4HKWR9bnOoGWQbpWQS4":"aaa",
"cMW6pcTSjbWOFdTCkBtmkN":"ddd"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}
         
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>

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

Поновити запис - ви можете поновлювати такі атрибути записів
Параметр Опис
rest_api_key ваш API-ключ
values Хеш значень запису, де ключем є ідентифікатор поля форми
json_values Якщо ви використовуєте jQuery, Ruby або іншу мову програмування тоді, будь ласка, передавайте значення запису як закодований хеш в параметрі 'values'. Але, якщо ваш фреймворк вам цього не дозволяє, то ви можете надіслати значення запису як JSON строчк, наприклад: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}". Але тоді використовуйте назву параметру 'json_values'.
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ID Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/dtypes/ID.json PUT {"rest_api_key":"API_KEY", "values": {"aNW4nkW5bdUjldO8oKuSku" : 3, "aMW4HKWR9bnOoGWQbpWQS4" : "b", "cMW6pcTSjbWOFdTCkBtmkN" : "c"}}

{"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"
}
}
         
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>

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

Поновити комірку даних - ви можете поновити комірку даних, надіславши ідентифікатор запису, поля і нове значення
Параметр Опис
rest_api_key ваш API-ключ
val Нове значення комірки даних
DTYPE_ID Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json
PROPERTY_ID Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
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"}

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>

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

Видалити запис - видаляє запис з бази даних
Параметр Опис
rest_api_key ваш API-ключ
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ID Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json
Формат URL Метод Тіло запросу Відповідь
JSON /apps/APP_ID/dtypes/ID.json DELETE {"rest_api_key":"API_KEY"}
	
{"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"
}
}
	         
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>

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

Створити запис - додає новий запис в базу даних
Параметр Опис
rest_api_key ваш API-ключ
json_values Якщо ви використовуєте jQuery, Ruby або іншу мову програмування тоді, будь ласка, передавайте значення запису як закодований хеш в параметрі 'values'. Але, якщо ваш фреймворк вам цього не дозволяє, то ви можете надіслати значення запису як JSON строчк, наприклад: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}". Але тоді використовуйте назву параметру 'json_values'.
ID Вам потрібно згенерувати UUID (унікальний ідентифікатор) довжиною 22 символи URL-безпечний base64. Наприклад, в Ruby. Далі вам потрібно буде передати його в хеш 'values', наприклад :values => {'id' => ID}, змінити на :values => {'id' => '22adadVXHdHie1WeGFE8k2'}
APP_ID Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми вам необхідно замінити ENTITY_ID в URL, наприклад /apps/APP_ID/entities/ENTITY_ID/properties.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json
Формат URL Метод Тіло запросу Відповідь
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"}}
		
{"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"
}
}
		         
	
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>

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

Зв'язки - Як пов'язувати записи

Для того, щоб встановити зв'язок між записами вам потрібно відправити окремий хеш в запиті на СТВОРЕННЯ або ПОНОВЛЕННЯ запису.

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

Хеш має бути в вигляді 'rel' => {rel_id => RECORD_ID} або 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} якщо у вас зв'зок Багато-до-багатьох. Де RECORD_ID - це ідентифікатор запису з яким ви хочете поєднати поточний запис. Нижче показано як отримати rel_id.
Параметр Опис
rest_api_key ваш API-ключ
ENTITY_ID Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми вам необхідно замінити ENTITY_ID в URL, наприклад /apps/APP_ID/entities/ENTITY_ID/properties.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json
PROPERTY_ID Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json
Формат URL Метод Тіло запросу Відповідь
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
Отримати посилання на файл - Отримати посилання на файл


Для того, щоб отримати лінк на файл, для початку отримайте значення полів запису і зможете скачати файл по посиланню у вигляді https://quintadb.com.ua/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, де FILE_NAME - назва завантаженого файлу, отримане в хеші значень вигляду PROPERTY_ID => VALUE, RECORD_ID - ID запису, PROPERTY_ID - ID поля.

Це базовий REST API і його має бути достатньо, щоб створювати класні і корисні речі. Однак, якщо вам необхідно щось ще, наприклад, більше методів і т.п. будь ласка, зв'язуйтеся з нами в будь-який час. Ми завжди раді вас чути!