English Español Deutsch Italiano Polski Nederlands Português Français 中文 日本語 हिन्दी اللغة العربية Русский Українська עִברִית Ελληνικά Türk Latvietis Dansk Norsk Íslenska 한국어 Suomen Gaeilge Bahasa Melayu Svenska Čeština
Увійти
Українська

QuintaDB REST API

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

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


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

База даних

Такі атрибути бази даних можуть бути отримані при використанні REST API.

id

Унікальний ідентифікатор бази даних

name

Назва

created_at

Час, коли база даних була створена

updated_at

Час, коли база даних була поновлена

Отримати всі бази даних

Параметри
rest_api_key

ваш API-ключ

page

Бази даних показуються по 20 на сторінку, тобто page может бути 1..5

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps.json

Тіло запросу

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

Відповідь: повертає всі бази даних

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

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

/apps.xml

Тіло запросу

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

Отримати базу даних за ID

Параметри
rest_api_key

ваш API-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps/APP_ID.json

Тіло запросу

{"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,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}
             

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

/apps/APP_ID.xml

Тіло запросу

<?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-ключ

Назва

Вам потрібно знати назву бази даних. Назву можна отримати, виконавши запит Отримати всі бази даних .

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps/search.json

Тіло запросу

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

Відповідь: повертає інформацію про базу даних

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

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

/apps/search.xml

Тіло запросу

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

Поновити базу даних

Параметри
rest_api_key

ваш API-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

name

Нова назва бази даних

Робимо запрос (JSON)
Формат

JSON

Метод

PUT

URL

/apps/APP_ID.json

Тіло запросу

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

Відповідь: повертає інформацію про базу даних

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

Робимо запрос (XML)
Формат

XML

Метод

PUT

URL

/apps/APP_ID.xml

Тіло запросу

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

Видалити базу даних

Параметри
rest_api_key

ваш API-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

Робимо запрос (JSON)
Формат

JSON

Метод

DELETE

URL

/apps/APP_ID.json

Тіло запросу

{"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)
Формат

XML

Метод

DELETE

URL

/apps/APP_ID.xml

Тіло запросу

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

Назва форми. Ви не можете створити базу даних без форми, тому що немає сенсу в базі даних без форми.

Робимо запрос (JSON)
Формат

JSON

Метод

POST

URL

/apps.json

Тіло запросу

{"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)
Формат

XML

Метод

POST

URL

/apps.xml

Тіло запросу

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

Перелік одержувачів емейл-повідомлень

Отримати всі форми

Параметри
rest_api_key

ваш API-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps/APP_ID/entities.json

Тіло запросу

{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)
Формат

XML

Метод

GET

URL

/apps/APP_ID/entities.xml

Тіло запросу

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

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps/APP_ID/entities/ID.json

Тіло запросу

{"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)
Формат

XML

Метод

GET

URL

/apps/APP_ID/entities/ID.xml

Тіло запросу

<?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-ключ

database_name

Вам потрібно знати назву бази даних. Назву можна отримати, виконавши запит Отримати всі бази даних .

form_name

Ви повинні знати назву форми. Її можна отримати, використовуючи виклик Отримати всі форми .

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps/search/entities/search.json

Тіло запросу

{"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)
Формат

XML

Метод

GET

URL

/apps/search/entities/search.xml

Тіло запросу

<?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-ключ

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

name

Нова назва форми. Дивіться всі доступні параметри тут

Робимо запрос (JSON)
Формат

JSON

Метод

PUT

URL

/apps/APP_ID/entities/ID.json

Тіло запросу

{"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)
Формат

XML

Метод

PUT

URL

/apps/APP_ID/entities/ID.xml

Тіло запросу

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

Відповідь: повертає інформацію про форму

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

Робимо запрос (JSON)
Формат

JSON

Метод

DELETE

URL

/apps/APP_ID/entities/ID.json

Тіло запросу

{"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)
Формат

XML

Метод

DELETE

URL

/apps/APP_ID/entities/ID.xml

Тіло запросу

<?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-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

name

Назва форми

Робимо запрос (JSON)
Формат

JSON

Метод

POST

URL

/apps/APP_ID/entities.json

Тіло запросу

{"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)
Формат

XML

Метод

POST

URL

/apps/APP_ID/entities.xml

Тіло запросу

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

Назва

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

Отримати поля форми

Параметри
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

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

{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)
Формат

XML

Метод

GET

URL

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

Тіло запросу

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

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

{"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)
Формат

XML

Метод

GET

URL

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

Тіло запросу

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

Отримати поле за Іменем

Параметри
rest_api_key

ваш API-ключ

database_name

Вам потрібно знати назву бази даних. Назву можна отримати, виконавши запит Отримати всі бази даних .

form_name

Ви повинні знати назву форми. Її можна отримати, використовуючи виклик Отримати всі форми .

field_name

Ви повинні знати назву поля. Її можна отримати, використовуючи виклик Отримати всі поля форми .

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

{"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)
Формат

XML

Метод

GET

URL

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

Тіло запросу

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

Поновити поле

Параметри
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

name

Нова назва поля. Всі доступні атрибути можна знайти тут

Робимо запрос (JSON)
Формат

JSON

Метод

PUT

URL

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

Тіло запросу

{"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)
Формат

XML

Метод

PUT

URL

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

Тіло запросу

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

Видалити поле

Параметри
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

Робимо запрос (JSON)
Формат

JSON

Метод

DELETE

URL

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

Тіло запросу

{"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)
Формат

XML

Метод

DELETE

URL

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

Тіло запросу

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

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

Робимо запрос (JSON)
Формат

JSON

Метод

POST

URL

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

Тіло запросу

{"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)
Формат

XML

Метод

POST

URL

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

Тіло запросу

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

ваш API-ключ

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

view

Щоб отримати записи, ви повинні знати ID звіту. (Не обов'язково)

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/search/sum/ENTITY_ID/ID.json

Тіло запросу

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

Відповідь

    
{total: 3}
             

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

/search/sum/ENTITY_ID/ID.xml

Тіло запросу

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

Відповідь

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

Запис

Такі атрибути запису можуть бути отримані через REST API.

id

Унікальний ідентифікатор запису.

app_id

ID додатку

entity_id

Ідентифікатор форми запису.

values

Хеш значень запису. Де ключем є ідентифікатор поля, а значенням - значення поля.

rel_values

Хеш значень зв'язків запису. Де ключем є ідентифікатор поля, а значенням - ідентифікатор пов'язаного запису.

Отримати записи

Параметри
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

view

Щоб отримати записи, ви повинні знати ID звіту. (Не обов'язково)

page

Номер сторінки з записами. Від 1 до кількість записів/per_page.

name_value

Використовуйте параметр для отримання записів виду: "ім`я поля": "значення", "айди поля": "ім`я поля"

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

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

Відповідь

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

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

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

Тіло запросу

<?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>
<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-ключ

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

name_value

Використовуйте параметр для отримання записів виду: "ім`я поля": "значення", "айди поля": "ім`я поля"

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

/apps/APP_ID/dtypes/ID.json

Тіло запросу

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

Відповідь

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

             

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

/apps/APP_ID/dtypes/ID.xml

Тіло запросу

<?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-ключ

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

values

Хеш значень запису, де ключем є ідентифікатор поля форми

json_values

Якщо ви використовуєте jQuery, Ruby або іншу мову програмування тоді, будь ласка, передавайте значення запису як закодований хеш в параметрі 'values'. Але, якщо ваш фреймворк вам цього не дозволяє, то ви можете надіслати значення запису як JSON строчк, наприклад: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}". Але тоді використовуйте назву параметру 'json_values'.

subforms_values / subforms_json_values

Для створення або поновлення субформ, аналогічно, використовуйте параметр 'subforms_values' або 'json_subforms_values'.
Формат наступний:
"{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"}}}" .

Де property1_id і property2_id - це ID полів з типом Субформа в основній таблиці.
subform1_id, subform2_id - ID форм, на які вказують поля property1_id і property2_id.
subform1_record1_id і subform1_record2_id - це ID нових або існуючих записів субформи.
subform1_field1_id, subform1_field2_id - ID полів в формі subform1_id.
subform2_field1_id, subform2_field2_id - ID полів в формі subform2_id.

Всі ID - це 22 символьні URL-безпечні base64 коди, їх можна взяти з інших API викликів або створити самостійно для ID нових записів.

Робимо запрос (JSON)
Формат

JSON

Метод

PUT

URL

/apps/APP_ID/dtypes/ID.json

Тіло запросу

{"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)
Формат

XML

Метод

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Тіло запросу

<?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-ключ

PROPERTY_ID

Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

DTYPE_ID

Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

val

Нове значення комірки даних

Робимо запрос (JSON)
Формат

JSON

Метод

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Тіло запросу

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

Відповідь

    
{"new_value": "John Smith"}
             

Робимо запрос (XML)
Формат

XML

Метод

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Тіло запросу

<?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"?>
<new_value>
John Smith
</new_value>
             

Видалити запис

Параметри
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

Робимо запрос (JSON)
Формат

JSON

Метод

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Тіло запросу

{"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)
Формат

XML

Метод

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Тіло запросу

<?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-ключ

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, ви можете згенерувати UUID (унікальний ідентифікатор) довжиною 22 символи URL-безпечний base64. Наприклад, в Ruby . Далі вам потрібно буде передати його в хеш 'values', наприклад: values ​​=> { 'id' => ID}, змінити на: values ​​=> { ' id '=>' 22adadVXHdHie1WeGFE8k2 '}, в іншому випадку система сама згенерує для вас унікальний ідентифікатор.

values / json_values

Якщо ви використовуєте jQuery, Ruby або іншу мову програмування тоді, будь ласка, передавайте значення запису як закодований хеш в параметрі 'values'. Але, якщо ваш фреймворк вам цього не дозволяє, то ви можете надіслати значення запису як JSON строчк, наприклад: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}". Але тоді використовуйте назву параметру 'json_values'.

subforms_values / subforms_json_values

Для створення або поновлення субформ, аналогічно, використовуйте параметр 'subforms_values' або 'json_subforms_values'.
Формат наступний:
"{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"}}}" .

Де property1_id і property2_id - це ID полів з типом Субформа в основній таблиці.
subform1_id, subform2_id - ID форм, на які вказують поля property1_id і property2_id.
subform1_record1_id і subform1_record2_id - це ID нових або існуючих записів субформи.
subform1_field1_id, subform1_field2_id - ID полів в формі subform1_id.
subform2_field1_id, subform2_field2_id - ID полів в формі subform2_id.

Всі ID - це 22 символьні URL-безпечні base64 коди, їх можна взяти з інших API викликів або створити самостійно для ID нових записів.

Робимо запрос (JSON)
Формат

JSON

Метод

POST

URL

/apps/APP_ID/dtypes.json

Тіло запросу

{"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)
Формат

XML

Метод

POST

URL

/apps/APP_ID/dtypes.xml

Тіло запросу

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

Пошук

Параметри
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

view

Щоб отримати записи, ви повинні знати ID звіту. (Не обов'язково)

search

Щоб здійснити пошук по таблиці або звіту, Вам потрібно відправити в body запиту search масив з параметрами пошуку , в форматі: [[{ "a" => "PROPERTY_ID", "b" => "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
Де PROPERTY_ID - ідентфікатор поля за яким проводимо пошук ( -ALL - - для пошуку по всіх колонках),
SEARCH_TERM - значення, яке шукаємо,
SEARCH_CRITERIA - критерій пошуку, може бути один з:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Для порівняння чисел і дат : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Для дати або часу : 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.

Системні колонки : added_by, created_at, updated_at, ip.

Якщо Ви хочете здійснити пошук за кількома колонкам з обьединяемся критерієм "І", то ці критерії повинні бути поміщені в один масив, якщо "АБО", то в окремий, наприклад:
[[{ "A" => "PROPERTY_ID_1", "b" => "А", "o" => "is"}, { "a" => "PROPERTY_ID_2", "b" => "А", "o" => "is"}],
[{ "A" => "PROPERTY_ID_3", "b" => "Б", "o" => "SEARCH_CRITERIA"}]]

формула пошуку буде: "Знайти всі записи де PROPERTY_ID_1 І PROPERTY_ID_2 рівні А ЧИ PROPERTY_ID_3 одно Б"

limit

Кількість записів в результатах пошуку, максимально - 200.

Робимо запрос (JSON)
Формат

JSON

Метод

POST

URL

/search/APP_ID.json

Тіло запросу

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

Відповідь

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

             

Зв'язки

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

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

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-ключ

PROPERTY_ID

Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ENTITY_ID

Ви повинні знати ідентифікатор форми. Ви можете знайти ENTITY_ID отримавши всі форми. Знаючи ідентифікатор форми вам необхідно замінити ENTITY_ID в URL, наприклад /apps/APP_ID/entities/ENTITY_ID/properties.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

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

Відповідь

11842         

Звіти

Такі атрибути звіту можна отримати через REST API.

id

ID

name

Назва

Отримати звіти

Параметри
rest_api_key

ваш API-ключ

APP_ID

ID додатку

ENTITY_ID

ID таблиці (форми)

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

{"rest_api_key":"API_KEY"}

Відповідь: повертає всі звіти таблиці.

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

Робимо запрос (XML)
Формат

XML

Метод

GET

URL

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

Тіло запросу: повертає всі звіти таблиці.

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

Файли

Отримати посилання на файл

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

Завантажити файли

Для того, щоб завантажити файл у запис, вам потрібно зробити запит POST до методу API upload_file з заголовком типу multipart/form-data і лише після цього вам потрібно створити або оновити свій запис. Отже, ідентифікатор запису має бути сформовано перед викликами. А також вам доведеться створити заголовок Multipart, будь ласка, дотримуйтесь прикладу Ruby з класом MultipartPost нижче. У цьому прикладі ви також дізнаєтесь, як завантажити файл у субформу.
Параметри
rest_api_key

ваш API-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

property_id

Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

dtype_id

Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Робимо запрос (JSON)
Формат

JSON

Метод

POST

URL

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

Тіло запросу

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

Відповідь

    Uploaded
             

Видалення файлів

Параметри
rest_api_key

ваш API-ключ

APP_ID

Ви повинні знати ідентифікатор бази, яку хочете видалити. Ви можете знайти ID отримавши всі бази даних. Знаючи ідентифікатор бази, вам потрібно замінити ID в URL, наприклад: /apps/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2.json

property_id

Ви повинні знати ідентифікатор поля. Ви можете знайти ID отримавши всі поля форми. Знаючи ідентифікатор поля, вам потрібно замінити ID в URL, наприклад: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json на /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

DTYPE_ID

Ви повинні знати ідентифікатор записи. ID можна знайти отримавши всі записи. Знаючи ідентифікатор, вам потрібно замінити ID в URL наприклад: /apps/APP_ID/dtypes/ID.json на /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

SINGLE_FILE_NAME

Назва файлу

Робимо запрос (JSON)
Формат

JSON

Метод

GET

URL

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

Тіло запросу

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

Відповідь

    File removed

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