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

QuintaDB REST API

Interfejs API REST QuintaDB Zaaplikacjaowany, abyś mógł w pełni wykorzystać potencjał danych przechowywanych w bazie danych QuintaDB. Korzystając z tego interfejsu API, możesz osiągnąć więcej niż obecnie oferuje interfejs QuintaDB. W rzeczywistości dajemy Ci możliwość robienia wszystkiego, czego potrzebujesz z danymi. Na przykład możesz tworzyć własne skrypty, aplikacje komputerowe i aplikacje mobilne na różne platformy, takie jak iPhone / Android i inne. A QuintaDB pozostanie tam, gdzie przechowujesz, zarządzasz i wykorzystujesz swoje dane razem z innymi.

Ogólne informacje o wywołaniach API


Wszystkie wywołania muszą zawierać klucz API REST, który można znaleźć, klikając przycisk „Klucze API” na początku strony.
Odpowiedź serwera może zostać odebrana w formacie JSON lub XML , w zależności od żądania.
Poniżej przedstawiamy tabele z odpowiedziami serwera dla każdego żądania. Adresy URL będą wyświetlane jako /apps.json , co oznacza, że ​​musisz wywołać metodę z linkiem https://QuintaDB.ru /apps.json w swoim programie. Pamiętaj, że wszystkie wywołania muszą używać protokołu https i musisz sprawdzić certyfikat SSL serwera pod kątem ważności.

Baza danych

Takie atrybuty bazy danych mogą być uzyskane przy użyciu REST API.

id

Unikalny identyfikator bazy danych

name

Nazwa

created_at

Czas, gdy baza danych została utworzona

updated_at

Czas, gdy baza danych została zaktualizowana

Zobacz wszystkie bazy danych

Parametry
rest_api_key

twój klucz API

page

Bazy danych są wyświetlane po 20 na stronę, czyli page może być 1..5

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps.json

Treść żądania

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

Odpowiedź: wraca wszystkie bazy danych

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps.xml

Treść żądania

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

Odpowiedź: wraca wszystkie bazy danych

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

Uzyskać bazy danych za ID

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps/APP_ID.json

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź: wraca informacje o bazie danych

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps/APP_ID.xml

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

Uzyskać bazę danych według nazwy

Parametry
rest_api_key

twój klucz API

Nazwa

Musisz znać nazwę bazy danych. Nazwę można uzyskać, wykonując zapytanie Uzyskaj wszystkie bazy danych ..

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps/search.json

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps/search.xml

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

Zaktualizować bazę danych

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

name

Nowa nazwa bazy danych

Składamy zapytanie (JSON)
Format

JSON

Metoda

PUT

URL

/apps/APP_ID.json

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

Składamy zapytanie (XML)
Format

XML

Metoda

PUT

URL

/apps/APP_ID.xml

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

Usuń bazę danych

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

DELETE

URL

/apps/APP_ID.json

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

DELETE

URL

/apps/APP_ID.xml

Treść żądania

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

Odpowiedź

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

Po usunięciu bazy ten metod wraca wszystkie bazy danych, które pozostały.

Utworzyć aplikacja

Parametry
rest_api_key

twój klucz API

database_name

Nazwa bazy danych

form_name

Nazwa formularza. Nie można utworzyć bazy danych bez formularza, ponieważ nie ma sensu w bazie danych bez formularza.

Składamy zapytanie (JSON)
Format

JSON

Metoda

POST

URL

/apps.json

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

Składamy zapytanie (XML)
Format

XML

Metoda

POST

URL

/apps.xml

Treść żądania

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

Odpowiedź: wraca informacje o bazie danych

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

W przypadku błędu. Zostanie wyświetlony komunikat o błędzie, np. 'Taka nazwa aplikacji już istnieje'.

Formularz

Takie atrybuty kształtu mogą być uzyskane przez REST API.

id

Unikalny identyfikator formularza

name

Nazwa

desc

Opis

post_action

Wykaz odbiorców e-mail wiadomości

Uzyskaj wszelkie formularzy

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps/APP_ID/entities.json

Treść żądania

{rest_api_key":"API_KEY"}

Odpowiedź: Uzyskać wszystkie formularzy bazy danych

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps/APP_ID/entities.xml

Treść żądania

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

Odpowiedź: Uzyskać wszystkie formularzy bazy danych

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

Pobierz formularz w ID

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps/APP_ID/entities/ID.json

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź: zwraca informacje o formularzach

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps/APP_ID/entities/ID.xml

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Pobierz formularz według Nazwy

Parametry
rest_api_key

twój klucz API

database_name

Musisz znać nazwę bazy danych. Nazwę można uzyskać, wykonując zapytanie Uzyskaj wszystkie bazy danych ..

form_name

Musisz znać nazwę formularza. Można ją uzyskać za pomocą połączenia Uzyskaj wszystkie formularze .

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps/search/entities/search.json

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps/search/entities/search.xml

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Zaktualizować formularz

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

name

Nowa nazwa formularza. Zobacz wszystkie dostępne opcje tutaj

Składamy zapytanie (JSON)
Format

JSON

Metoda

PUT

URL

/apps/APP_ID/entities/ID.json

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Składamy zapytanie (XML)
Format

XML

Metoda

PUT

URL

/apps/APP_ID/entities/ID.xml

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Usunąć formularz

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

Musisz znać identyfikator formularza, który chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich formularzów. Znając identyfikator formularze, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

DELETE

URL

/apps/APP_ID/entities/ID.json

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

DELETE

URL

/apps/APP_ID/entities/ID.xml

Treść żądania

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

Odpowiedź

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

Stworzyć formularz

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

name

Nazwa formularza

Składamy zapytanie (JSON)
Format

JSON

Metoda

POST

URL

/apps/APP_ID/entities.json

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Składamy zapytanie (XML)
Format

XML

Metoda

POST

URL

/apps/APP_ID/entities.xml

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Pole

Takie atrybuty pola mogą być uzyskane przez REST API.

id

Unikalny identyfikator pola

entity_id

Identyfikator pola formularza

name

Nazwa

type_name

Typ pola. Może być: 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

Otrzymaj pola formularza

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

{rest_api_key":"API_KEY"}

Odpowiedź: Otrzymaj wszystkie pola formularza

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź: Otrzymaj wszystkie pola formularza

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

Uzyskaj pole

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź

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

             

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

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

Uzyskaj pole z Nazwą

Parametry
rest_api_key

twój klucz API

database_name

Musisz znać nazwę bazy danych. Nazwę można uzyskać, wykonując zapytanie Uzyskaj wszystkie bazy danych ..

form_name

Musisz znać nazwę formularza. Można ją uzyskać za pomocą połączenia Uzyskaj wszystkie formularze .

field_name

Musisz znać nazwę pola. Można ją uzyskać za pomocą połączenia Uzyskaj wszystkie pola formularza .

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

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

Zaktualizować pole

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

name

Nowa nazwa pola. Wszystkie dostępne atrybuty można znaleźć tutaj

Składamy zapytanie (JSON)
Format

JSON

Metoda

PUT

URL

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

Treść żądania

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

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

PUT

URL

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

Treść żądania

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

Odpowiedź

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

Usuń pole

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

DELETE

URL

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

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

DELETE

URL

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

Treść żądania

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

Odpowiedź

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

Stworzyć pole

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

name

Nazwa pola

type_name

Typ pola. Może być: 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

Składamy zapytanie (JSON)
Format

JSON

Metoda

POST

URL

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

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Składamy zapytanie (XML)
Format

XML

Metoda

POST

URL

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

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Uzyskaj sumy w kolumnie

Parametry
rest_api_key

twój klucz API

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

view

Aby uzyskać rekordy, należy wiedzieć ID raportu. ( Niekoniecznie)

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/search/sum/ENTITY_ID/ID.json

Treść żądania

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

Odpowiedź

    
{total: 3}
             

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/search/sum/ENTITY_ID/ID.xml

Treść żądania

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

Odpowiedź

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

Rekord

Takie atrybuty nagrywania mogą być uzyskane przez REST API.

id

Unikalny identyfikator rekordu.

app_id

ID aplikacjau

entity_id

Identyfikator formularza rekord.

values

Hash wartości zapisu. Gdzie kluczem jest identyfikator pola, a wartością - wartość pola.

rel_values

Hash wartości związku zapisu. Gdzie kluczem jest identyfikator pola, a wartością - identyfikator powiązanego rekordu.

Uzyskaj rekordy

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

view

Aby uzyskać rekordy, należy wiedzieć ID raportu. ( Niekoniecznie)

page

Numer strony z rekordami. Od 1 do liczby rekordów/per_page.

name_value

Użyj parametru, aby uzyskać rekordy w postaci: "nazwa pola": "wartość", "id pola": "nazwa pola"

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

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

Uzyskaj rekord

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

Musisz znać identyfikator rekordu. ID można znaleźć po otrzymaniu wszystkich rekordów. Znając identyfikator, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Użyj parametru, aby uzyskać rekordy w postaci: "nazwa pola": "wartość", "id pola": "nazwa pola"

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

/apps/APP_ID/dtypes/ID.json

Treść żądania

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

Odpowiedź

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

             

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

/apps/APP_ID/dtypes/ID.xml

Treść żądania

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

Odpowiedź

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

Zaktualizować rekord

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

Musisz znać identyfikator rekordu. ID można znaleźć po otrzymaniu wszystkich rekordów. Znając identyfikator, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

values

Hash wartości rekordów, gdzie kluczem jest identyfikator pola formularza

json_values

Jeśli używasz jQuery, Ruby lub inny język programowania, więc prosimy podać wartości rekordu jak zakodowany skrót w parametrze 'values'. Ale jeśli twój framework ci na to nie pozwala, to możesz wysłać wartości rekordu, JSON, na przykład: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}". Ale wtedy użyj nazwa parametru 'json_values'.

subforms_values / subforms_json_values

Dla tworzenia lub aktualizacji podformularzy, podobnie, użyj opcji 'subforms_values' lub 'json_subforms_values'.
następujący Format:
"{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"}}}" .

Gdzie property1_id i property2_id - to ID pól typu Podformularz w głównej tabeli.
subform1_id, subform2_id - ID formularz, na które wskazują pola property1_id i property2_id.
subform1_record1_id i subform1_record2_id - to ID nowych lub istniejących rekordów podformularz.
subform1_field1_id, subform1_field2_id - ID pól w formularzu subform1_id.
subform2_field1_id, subform2_field2_id - ID pól w formularzu subform2_id.

Wszystkie ID to 22 znakowe URL bezpieczne base64 kody, można je wziąć z innych API połączeń lub tworzyć własne dla ID nowych rekordów.

Składamy zapytanie (JSON)
Format

JSON

Metoda

PUT

URL

/apps/APP_ID/dtypes/ID.json

Treść żądania

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

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Treść żądania

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

Odpowiedź

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

Zaktualizować dane komórek

Parametry
rest_api_key

twój klucz API

PROPERTY_ID

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

DTYPE_ID

Musisz znać identyfikator rekordu. ID można znaleźć po otrzymaniu wszystkich rekordów. Znając identyfikator, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

val

Nową wartość komórki z danymi

Składamy zapytanie (JSON)
Format

JSON

Metoda

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Treść żądania

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

Odpowiedź

    
{"new_value": "John Smith"}
             

Składamy zapytanie (XML)
Format

XML

Metoda

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Treść żądania

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

Odpowiedź

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

Usuń rekord

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

Musisz znać identyfikator rekordu. ID można znaleźć po otrzymaniu wszystkich rekordów. Znając identyfikator, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź

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

Składamy zapytanie (XML)
Format

XML

Metoda

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Treść żądania

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

Odpowiedź

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

Nowy rekord

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

Jeśli potrzebujesz swojego osobistego identyfikatora, możesz wygenerować UUID (unikalny identyfikator) 22 znaki, bezpieczny dla adresu URL, base64 Na przykład w Rubim . Następnie musisz przekazać go do hasha 'values', na przykład: values ​​=> {'id' => ID}, zmień na: values ​​=> {'id' => '22adadVXHdHie1WeGFE8k2'}, w przeciwnym razie system wygeneruje dla Ciebie unikalny identyfikator.

values / json_values

Jeśli używasz jQuery, Ruby lub inny język programowania, więc prosimy podać wartości rekordu jak zakodowany skrót w parametrze 'values'. Ale jeśli twój framework ci na to nie pozwala, to możesz wysłać wartości rekordu, JSON, na przykład: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}". Ale wtedy użyj nazwa parametru 'json_values'.

subforms_values / subforms_json_values

Dla tworzenia lub aktualizacji podformularzy, podobnie, użyj opcji 'subforms_values' lub 'json_subforms_values'.
następujący Format:
"{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"}}}" .

Gdzie property1_id i property2_id - to ID pól typu Podformularz w głównej tabeli.
subform1_id, subform2_id - ID formularz, na które wskazują pola property1_id i property2_id.
subform1_record1_id i subform1_record2_id - to ID nowych lub istniejących rekordów podformularz.
subform1_field1_id, subform1_field2_id - ID pól w formularzu subform1_id.
subform2_field1_id, subform2_field2_id - ID pól w formularzu subform2_id.

Wszystkie ID to 22 znakowe URL bezpieczne base64 kody, można je wziąć z innych API połączeń lub tworzyć własne dla ID nowych rekordów.

Składamy zapytanie (JSON)
Format

JSON

Metoda

POST

URL

/apps/APP_ID/dtypes.json

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Składamy zapytanie (XML)
Format

XML

Metoda

POST

URL

/apps/APP_ID/dtypes.xml

Treść żądania

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

Odpowiedź: zwraca informacje o formularzach

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

Szukaj

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz znać identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkie formularze. Znając identyfikator formularza, trzeba wymienić ENTITY_ID w adresie URL, na przykład: /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

view

Aby uzyskać rekordy, należy wiedzieć ID raportu. ( Niekoniecznie)

search

Chciałbyś machnąć ręką na stole? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - identyfikator pola, po którym szukamy ( -ALL - - aby przeszukać wszystkie kolumny),
SEARCH_TERM - wartość, której szukamy,
SEARCH_CRITERIA - kryterium wiadomości, może jedno z nich:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Dla zwykłych numerów i dat : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Na randkę przez około godzinę : 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.

Kolumny systemowe : added_by, created_at, updated_at, ip.

Jeśli chcesz wyszukiwać w kilku kolumnach za pomocą ujednolicającego kryterium „I”, kryteria te należy umieścić w jednej tablicy, jeśli „LUB”, to w osobnym, na przykład:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "is"}, {"a" => "PROPERTY_ID_2", "b" => "A", "o" => "is"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

formuła wyszukiwania będzie: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Liczba rekordów w wynikach wyszukiwania, maksymalna to 200.

Składamy zapytanie (JSON)
Format

JSON

Metoda

POST

URL

/search/APP_ID.json

Treść żądania

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

Odpowiedź

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

             

Związek

Jak powiązać rekordy:

Do tego, aby nawiązać związek pomiędzy rekordami trzeba wysłać osobny hash w zapytaniu na TWORZENIA lub AKTUALIZACJI rekordu.

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"

Hash musi być w postaci 'rel' => {rel_id => RECORD_ID} lub 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} jeśli masz związek Wiele-do-wielu. Gdzie RECORD_ID - to identyfikator rekordu w którym chcesz połączyć bieżący rekord. Poniżej pokazano jak uzyskać rel_id.

Parametry
rest_api_key

twój klucz API

PROPERTY_ID

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ENTITY_ID

Musisz wiedzieć identyfikator formularza. Możesz znaleźć ENTITY_ID po otrzymaniu wszystkich formularzy. Znając identyfikator formularza trzeba wymienić ENTITY_ID w adresie URL, na przykład /apps/APP_ID/entities/ENTITY_ID/properties.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

11842         

Raporty

Takie atrybuty raportu mogą być dostępne za pośrednictwem REST API.

id

ID

name

Nazwa

Pobierz raporty

Parametry
rest_api_key

twój klucz API

APP_ID

ID aplikacjau

ENTITY_ID

Identyfikator tabeli (formularza)

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

{"rest_api_key":"API_KEY"}

Odpowiedź: zwraca wszystkie raporty tabeli.

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

Składamy zapytanie (XML)
Format

XML

Metoda

GET

URL

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

Treść żądania: zwraca wszystkie raporty tabeli.

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

Odpowiedź

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

Pliki

Zobacz link do pliku

aby uzyskać link do pliku, na początek uzyskaj wartości pól rekordu i możesz pobrać plik z linku https://quintadb.com.ua/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, gdzie FILE_NAME - nazwa pobranego pliku, otrzymaną w hashe wartości rodzaju PROPERTY_ID => VALUE, RECORD_ID - ID rekordu, PROPERTY_ID - ID pola.

Pobierz pliki

Aby załadować plik do rekordu, musisz wysłać żądanie POST do metody API upload_file z nagłówkiem typu treści multipart / form-data, a dopiero potem musisz utworzyć lub zaktualizować swój rekord. Więc identyfikator rekordu powinien zostać wygenerowany przed wywołaniami. Musisz także wygenerować nagłówek Multipart, postępuj zgodnie z przykładem Ruby z klasą MultipartPost poniżej. W przykładzie nauczysz się również, jak załadować plik do podformularza.
Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

property_id

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

dtype_id

Musisz znać identyfikator rekordu. ID można znaleźć po otrzymaniu wszystkich rekordów. Znając identyfikator, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Składamy zapytanie (JSON)
Format

JSON

Metoda

POST

URL

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

Treść żądania

{"rest_api_key"=>API_KEY, "subform_field"=>"dcL8kXB8npd5pdRmk7BCoR", "property_id"=>"aVWR3cNtvdUikQn8o3yCo1", "subform_dtype_id"=>"fRLA83jrnAUOi5TEQLyuGw", "subforms"=>{"dcL8kXB8npd5pdRmk7BCoR"=>{"fRLA83jrnAUOi5TEQLyuGw"=>{"aVWR3cNtvdUikQn8o3yCo1"=>#, @original_filename="Selection_002.png", @content_type="image/png", @headers="Content-Disposition: form-data; name=\"subforms[dcL8kXB8npd5pdRmk7BCoR][fRLA83jrnAUOi5TEQLyuGw][aVWR3cNtvdUikQn8o3yCo1]\"; filename=\"Selection_002.png\"\r\nContent-Type: image/png\r\n">}}}, "dtype_id"=>"fRLA83jrnAUOi5TEQLyuGw", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9"}

Odpowiedź

    Uploaded
             

Usuń pliki

Parametry
rest_api_key

twój klucz API

APP_ID

Musisz znać identyfikator bazy, którą chcesz usunąć. Możesz znaleźć ID po otrzymaniu wszystkich baz danych. Znając identyfikator bazy, trzeba wymienić ID w URL, na przykład: /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

property_id

Musisz znać identyfikator pola. Możesz znaleźć ID po otrzymaniu wszystkie pola formularza. Znając identyfikator pola, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

DTYPE_ID

Musisz znać identyfikator rekordu. ID można znaleźć po otrzymaniu wszystkich rekordów. Znając identyfikator, trzeba wymienić ID w URL, na przykład: /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

SINGLE_FILE_NAME

Nazwa pliku

Składamy zapytanie (JSON)
Format

JSON

Metoda

GET

URL

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

Treść żądania

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

Odpowiedź

    File removed

Przykłady
To jest podstawowy REST API i jego musi być na tyle, aby stworzyć fajne i przydatne rzeczy. Jednak, jeśli chcesz coś jeszcze, na przykład, więcej metod, itp. Prosimy skontaktować się z nami w każdej chwili. Zawsze jesteśmy podekscytowani, aby usłyszeć od ciebie!