QuintaDB REST API

QuintaDB REST API je navrženo tak, aby odemklo potenciál dat uložených ve vaší databázi QuintaDB. Pomocí tohoto API můžete dosáhnout více, než jaké aktuálně nabízí výchozí uživatelské rozhraní QuintaDB. Takto dáváme se svými daty můžete dělat vše, co potřebujete a způsobem, který potřebujete. Můžete si vytvořit vlastní skripty, počítače a mobilní aplikace pro různé platformy, jako jsou iPhone/Android a mnoho dalších. A QuintaDB bude místem, kde budete ukládat, sdílet a spravovat svá data.

Obecné informace o voláních API

Všechna volání by měla obsahovat REST klíč API , který najdete v nabídce "API" v pravém horním rohu stránky.
Výsledek jsou vráceny v JSON nebo XML , v závislosti na vašem požadavku.
Ukážeme tabulku s výsledkem každého hovoru. Adresa URL se zobrazí tímto způsobem /apps.json , to znamená, že byste měli ve své aplikaci volat https://QuintaDB.com /apps.json . Pamatujte, že všechna volání by měla používat https a musíte ověřit certifikát SSL serverů.

Databáze

Takové atributy databáze jsou přístupné přes REST API.

jedinečný identifikátor databáze. Toto budete potřebovat pro přístup k těmto databázovým formulářům a záznamům

name

Jméno

created_at

Čas, kdy byla databáze vytvořena

updated_at

Čas, kdy byla databáze naposledy aktualizována (změněné záznamy nebo formuláře)

Získat všechny databáze

Parametry

rest_api_key

váš klíč API

page

Databáze stránkované o 20 záznamů na stránku. Takže pokud máte 100 databází, stránka může být 1..5.

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps.json

Tělo požadavku

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

Response: vrátí vaše aktuální databáze.

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps.xml

Tělo požadavku

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

Response: vrátí vaše aktuální databáze.

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

Získat databázi podle ID

Parametry

rest_api_key

váš klíč API

APP_ID

Abyste mohli načíst informace o databázi, musíte znát svůj identifikátor databáze. ID najdete pomocí volání Načíst všechny databáze . Jakmile to budete znát, budete muset přidejte toto ID k URL v níže uvedeném odkazu, tj. změňte /apps/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2.json

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps/APP_ID.json

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response: vrací informace o databázi

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps/APP_ID.xml

Tělo požadavku

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

Response: vrací informace o databázi

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

Získat databázi podle jména

Parametry

rest_api_key

váš klíč API

Jméno

Abyste mohli načíst informace o databázi, musíte znát název své databáze. Název můžete vyhledat pomocí volání Načíst všechny databáze .

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps/search.json

Tělo požadavku

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

Response: vrací informace o databázi

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps/search.xml

Tělo požadavku

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

Response: vrací informace o databázi

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

Aktualizace databáze

Parametry

rest_api_key

váš klíč API

APP_ID

name

Nový název databáze

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

PUT

URL

/apps/APP_ID.json

Tělo požadavku

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

Response: vrací informace o databázi

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

PUT

URL

/apps/APP_ID.xml

Tělo požadavku

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

Response: vrací informace o databázi

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

Odstranit databázi

Parametry

rest_api_key

váš klíč API

APP_ID

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

DELETE

URL

/apps/APP_ID.json

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

DELETE

URL

/apps/APP_ID.xml

Tělo požadavku

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

Response

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

Po odebrání databáze toto volání vrátí všechny databáze, které zůstaly.

Vytvořit databázi

Parametry

rest_api_key

váš klíč API

database_name

Název databáze

form_name

Název formuláře. Nemůžete vytvořit databázi bez formuláře. Protože nemá smysl mít databázi bez formulářů.

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/apps.json

Tělo požadavku

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

Response: vrací informace o databázi

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

/apps.xml

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> <database_name>Database 1</database_name> <form_name>Form 1</form_name> </api_call_params>

Response: vrací informace o databázi

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

V případě chyby. Zobrazí se chybová zpráva, tj. Takový název aplikace již existuje.

Form

Takové atributy formuláře jsou přístupné přes REST API.

Jedinečný identifikátor formuláře. Budete jej potřebovat pro přístup k tomuto formuláři a záznamům formuláře

name

Jméno

desc

Description

post_action

Seznam příjemců e-mailových oznámení

Načíst všechny databázové formuláře

Parametry

rest_api_key

váš klíč API

APP_ID

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps/APP_ID/entities.json

Tělo požadavku

{rest_api_key":"API_KEY"}

Response: načíst všechny databázové formuláře

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps/APP_ID/entities.xml

Tělo požadavku

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

Response: načíst všechny databázové formuláře

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

Získejte formulář podle ID

Parametry

rest_api_key

váš klíč API

APP_ID

Abyste mohli načíst informace o formuláři, musíte znát identifikátor vašeho formuláře. ID najdete pomocí volání Fetch All Forms . Jakmile to budete vědět, budete muset přidejte toto ID k URL v níže uvedeném odkazu, tj. změňte /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps/APP_ID/entities/ID.json

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response: vrací informace o formuláři

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps/APP_ID/entities/ID.xml

Tělo požadavku

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

Response: vrací informace o formuláři

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

Získejte formulář podle jména

Parametry

rest_api_key

váš klíč API

database_name

Abyste mohli načíst informace o databázi, musíte znát název své databáze. Název můžete vyhledat pomocí volání Načíst všechny databáze .

form_name

Abyste mohli načíst informace o formuláři, musíte znát název svého formuláře. Název formuláře najdete pomocí volání Načíst všechny formuláře .

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps/search/entities/search.json

Tělo požadavku

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

Response: vrací informace o formuláři

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps/search/entities/search.xml

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<database_name>Database 21</database_name>
<form_name>Form1</form_name>
</api_call_params>

Response: vrací informace o formuláři

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

Aktualizační formulář

Parametry

rest_api_key

váš klíč API

APP_ID

name

Nový název formuláře. Zobrazit všechny dostupné atributy zde

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

PUT

URL

/apps/APP_ID/entities/ID.json

Tělo požadavku

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

Response: vrací informace o formuláři

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

PUT

URL

/apps/APP_ID/entities/ID.xml

Tělo požadavku

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

Response: vrací informace o formuláři

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

Odstranit formulář

Parametry

rest_api_key

váš klíč API

APP_ID

Musíte znát svůj databázový identifikátor. APP_ID najdete pomocí volání Načíst všechny formuláře . Jakmile to budete znát, budete muset tento APP_ID přidat na adresu URL v odkaz níže, tj. změnit /apps/APP_ID/entities.json na /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

DELETE

URL

/apps/APP_ID/entities/ID.json

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

DELETE

URL

/apps/APP_ID/entities/ID.xml

Tělo požadavku

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

Response

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

Vytvořit formulář

Parametry

rest_api_key

váš klíč API

APP_ID

name

Název formuláře

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/apps/APP_ID/entities.json

Tělo požadavku

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

Response: vrací informace o formuláři

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

/apps/APP_ID/entities.xml

Tělo požadavku

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

Response: vrací informace o formuláři

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

Takové vlastnosti pole lze načíst pomocí REST API.

Jedinečný identifikátor pole. Budete jej potřebovat pro přístup k tomuto poli

entity_id

identifikátor formuláře pole.

name

Jméno

type_name

Název typu pole. Může jedním z: 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

Načíst všechna pole formuláře

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

{rest_api_key":"API_KEY"}

Response: načíst všechna pole formuláře

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

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

Tělo požadavku

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

Response: načíst všechna pole formuláře

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

Získejte pole podle ID

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

Abyste mohli aktualizovat nastavení polí, musíte znát svůj identifikátor pole. ID najdete pomocí volání Načíst všechna pole formuláře . Jakmile to budete vědět, budete potřebovat přidat toto ID na URL v níže uvedeném odkazu, tj. změnit /apps/APP_ID/entities/ENTITY_ID/properties/ID.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasdd1Xd8

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

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

Tělo požadavku

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

Response

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

Získat pole podle jména

Parametry

rest_api_key

váš klíč API

database_name

Abyste mohli načíst informace o databázi, musíte znát název své databáze. Název můžete vyhledat pomocí volání Načíst všechny databáze .

form_name

Abyste mohli načíst informace o formuláři, musíte znát název svého formuláře. Název formuláře najdete pomocí volání Načíst všechny formuláře .

field_name

Abyste mohli aktualizovat nastavení polí, musíte znát název svého pole. Název pole najdete pomocí volání Načíst všechna pole formuláře .

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

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

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<database_name>Database 21</database_name>
<form_name>Form1</form_name>
<field_name>test</field_name>
</api_call_params>

Response

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

Spustit akci

Parametry

rest_api_key

váš klíč API

DTYPE_ID

Musíte znát svůj identifikátor záznamu. ID můžete najít pomocí volání Načíst všechny záznamy.

ACTION_PROPERTY_ID

Musíte znát identifikátor svého pole. ID můžete najít pomocí volání Načíst všechna pole formuláře.

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/actions/ACTION_PROPERTY_ID.json

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Tělo požadavku

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

Response

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

Spustit akce

Parametry

rest_api_key

váš klíč API

ACTION_PROPERTY_ID

Musíte znát identifikátor svého pole. ID můžete najít pomocí volání Načíst všechna pole formuláře.

dtype_ids

Musíte znát identifikátory svých záznamů. ID můžete najít pomocí volání Načíst všechny záznamy.

json_dtype_ids

Musíte znát identifikátory svých záznamů. ID můžete najít pomocí volání Načíst všechny záznamy.

run_by_all_table_or_report

Následující parametr je k dispozici pro spuštění všech akcí v tabulce nebo sestavě: run_by_all_table_or_report=true.

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/actions/ACTION_PROPERTY_ID.json

Tělo požadavku

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

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

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Tělo požadavku

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

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

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

Response

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

pole aktualizace

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

name

Nový název pole. Zobrazit všechny dostupné atributy zde

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

PUT

URL

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

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

PUT

URL

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

Tělo požadavku

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

Response

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

Odstranit pole

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

DELETE

URL

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

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

DELETE

URL

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

Tělo požadavku

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

Response

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

Vytvořit pole

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

name

Nový název pole formuláře

type_name

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

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

Tělo požadavku

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

Response: vrací informace o formuláři

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

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

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>Form field 1</name>
<type-name>string</type-name>
</api_call_params>

Response: vrací informace o formuláři

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

Získejte celkem podle sloupce

Parametry

rest_api_key

váš klíč API

ENTITY_ID

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/search/sum/ENTITY_ID/ID.json

Tělo požadavku

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

Response

    
{total: 3}

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/search/sum/ENTITY_ID/ID.xml

Tělo požadavku

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

Response

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

Záznam

Tyto atributy záznamu jsou přístupné přes REST API.

jedinečný identifikátor záznamu. Toto budete potřebovat pro přístup k tomuto záznamu.

app_id

ID aplikace

entity_id

Identifikátor formuláře záznamu.

values

Zaznamenejte hodnoty hash. Kde klíč je id pole a hodnota je tato hodnota pole.

json_values

Zaznamenejte hash hodnot. Kde klíč je ID pole a hodnota je hodnota tohoto pole. Analog k values_hash, ale ve formátu JSON

rel_values

Zaznamenávat hodnoty hodnot vztahů. Kde klíč je ID pole a hodnota je ID propojeného záznamu.

Načíst všechny záznamy

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

page

Zaznamenává číslo stránky. Od 1 do tabulky Počet záznamů/ na_stranu .

name_value

Použijte parametr k získání dat typu: "název pole": "hodnota", "pole id": "název pole"

fetch_all

Pro vlastníky placených účtů je k dispozici následující parametr: fetch_all=true.
Chcete-li získat konkrétní počet příspěvků, použijte parametr per_page.
Omezení maximálního počtu záznamů per_page pro různé plány:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Tělo žádosti
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

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

Tělo požadavku

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

Response

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

Získejte záznam

Parametry

rest_api_key

váš klíč API

APP_ID

Musíte znát svůj identifikátor záznamu. ID najdete pomocí volání Načíst všechny záznamy . Jakmile to víte, budete muset toto ID přidat do URL v odkaz níže, tj. změnit /apps/APP_ID/dtypes/ID.json na /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Použijte parametr k získání dat typu: "název pole": "hodnota", "pole id": "název pole"

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

/apps/APP_ID/dtypes/ID.json

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

/apps/APP_ID/dtypes/ID.xml

Tělo požadavku

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

Response

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

Aktualizovat záznam

Parametry

rest_api_key

váš klíč API

APP_ID

values

Zaznamenejte hodnoty hash, kde klíč je id pole formuláře.

json_values

Pokud používáte jQuery, Ruby nebo jiný programovací jazyk, použijte prosím k odeslání parametrů kódování parametr 'values'. Pokud to však váš rámec neumožňuje, můžete hodnoty záznamu posílat jako řetězec JSON, ale v tomto případě zadejte název svého parametru jako 'json_values'. A váš řetězec hodnot JSON bude vypadat takto: "{" aNW4nkW5bdUjldO8oKuSku ": " 2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} "

subforms_values / subforms_json_values

Chcete-li vytvořit nebo aktualizovat podformuláře stejným způsobem, použijte 'subforms_values' nebo 'json_subforms_values'.
S níže uvedeným formátem:
"{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2 ", subform1_field2_id: "aaa "}, subform1_record2_id: {subform1_field1_id: "3 ", subform1_field2_id: "bb "}}, property2_id: {entity_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4 ", subform2_field2_id: "bb "}, subform2_record2_id: {subform2_field1_id: "5 ", subform2_field2_id: "dd "}}} ".

Where property1_id and property2_id - this is Fields ID's with a Subform type in the main table.
subform1_id, subform2_id - ID formulářů, která byla nastavena v nastavení property1_id a property2_id.
subform1_record1_id и subform1_record2_id - toto je nové nebo existující ID záznamů podformuláře.
subform1_field1_id, subform1_field2_id - ID polí ve tvaru subform1_id.
subform2_field1_id, subform2_field2_id - ID polí ve tvaru subform2_id.

Všechna ID - je to 22místný kód base64 pro uložení URL, můžete je získat z jiných volání API nebo vytvořit pro nové záznamy podformulářů.

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

PUT

URL

/apps/APP_ID/dtypes/ID.json

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3, "aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values> <rest_api_key>API_KEY</rest_api_key> </api_call_params>

Response

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

Aktualizace více záznamů

Parametry

rest_api_key

váš klíč API

confirm_action

Pro spuštění aktualizace v tabulce nebo sestavě je vyžadován následující parametr: confirm_action: update.

ENTITY_ID

Abyste mohli aktualizovat nastavení pole, musíte znát identifikátor formuláře svého pole. ENTITY_ID můžete najít pomocí volání Načíst všechny formuláře.

APP_ID

Abyste mohli načíst informace o databázi, musíte znát identifikátor své databáze. ID můžete najít pomocí volání Načíst všechny databáze.

dtype_ids

Musíte znát identifikátory svých záznamů. ID můžete najít pomocí volání Načíst všechny záznamy.

json_dtype_ids

Musíte znát identifikátory svých záznamů. ID můžete najít pomocí volání Načíst všechny záznamy.

update_id

Musíte znát identifikátor svého pole. ID můžete najít pomocí volání Načíst všechna pole formuláře.

update_term

Nová hodnota pro záznamy

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Tělo požadavku

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

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Tělo požadavku


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


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

Response

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

Aktualizovat všechny záznamy

Parametry

rest_api_key

váš klíč API

confirm_action

Pro spuštění aktualizace všech záznamů v tabulce nebo sestavě je vyžadován následující parametr: confirm_action: update_all.

ENTITY_ID

Abyste mohli aktualizovat nastavení pole, musíte znát identifikátor formuláře svého pole. ENTITY_ID můžete najít pomocí volání Načíst všechny formuláře.

APP_ID

Abyste mohli načíst informace o databázi, musíte znát identifikátor své databáze. ID můžete najít pomocí volání Načíst všechny databáze.

update_id

Musíte znát identifikátor svého pole. ID můžete najít pomocí volání Načíst všechna pole formuláře.

update_term

Nová hodnota pro záznamy

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Tělo požadavku


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

Response

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

Aktualizace datové buňky

Parametry

rest_api_key

váš klíč API

PROPERTY_ID

DTYPE_ID

val

Nová hodnota buňky

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Tělo požadavku

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

Response

    
{"new_value": "John Smith"}

Vytvoření požadavku (XML)

Formát

XML

Metoda

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<val>John Smith</val> <rest_api_key>API_KEY</rest_api_key> <dtype-id>cMW6pcTSjbWOFdTCkBtmkN</dtype-id> <property-id>aNW4nkW5bdUjldO8oKuSku</property-id> </api_call_params>

Response

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

Odstranit záznam

Parametry

rest_api_key

váš klíč API

APP_ID

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Tělo požadavku

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

Response

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

Smazat více

Parametry

rest_api_key

váš klíč API

ENTITY_ID

Abyste mohli aktualizovat nastavení pole, musíte znát identifikátor formuláře svého pole. ENTITY_ID můžete najít pomocí volání Načíst všechny formuláře.

APP_ID

Abyste mohli načíst informace o databázi, musíte znát identifikátor své databáze. ID můžete najít pomocí volání Načíst všechny databáze.

dtype_ids

Musíte znát identifikátory svých záznamů. ID můžete najít pomocí volání Načíst všechny záznamy.

json_dtype_ids

Musíte znát identifikátory svých záznamů. ID můžete najít pomocí volání Načíst všechny záznamy. (nepovinné)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Tělo požadavku

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

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Tělo požadavku


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


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

Response

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

Smazat vše

Parametry

rest_api_key

váš klíč API

APP_ID

Abyste mohli načíst informace o databázi, musíte znát identifikátor své databáze. ID můžete najít pomocí volání Načíst všechny databáze.

ENTITY_ID

Abyste mohli aktualizovat nastavení pole, musíte znát identifikátor formuláře svého pole. ENTITY_ID můžete najít pomocí volání Načíst všechny formuláře.

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Tělo požadavku

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

Response

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Tělo požadavku


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

Response

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

Vytvořit záznam

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

Pokud potřebujete použít své osobní ID, můžete vygenerovat UUID (jedinečný identifikátor) 22 znaků dlouhý, bezpečný pro URL, základní 64 Například v Ruby . Dále jej budete muset předat hash 'values', například: values => {'id' => ID}, změnit to: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, jinak vám systém vygeneruje jedinečný identifikátor.

values / json_values

subforms_values / subforms_json_values

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/apps/APP_ID/dtypes.json

Tělo požadavku

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

Response: vrací informace o formuláři

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

POST

URL

/apps/APP_ID/dtypes.xml

Tělo požadavku

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3,"entity_id"=>ENTITY_ID, "id"=>ID,"aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values>< <rest_api_key>API_KEY</rest_api_key> </api_call_params>

Response: vrací informace o formuláři

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

Hledat

Parametry

rest_api_key

váš klíč API

APP_ID

ENTITY_ID

view

Abyste mohli načíst záznamy, musíte znát své ID sestavy. (nepovinné)

search

Chtěli byste švihnout po stole? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - identifikátor pole, podle kterého hledáme ( -ALL - - prohledávání všech sloupců),
SEARCH_TERM - hodnota, kterou hledáme,
SEARCH_CRITERIA - kritérium pro zprávu, možná jedno z nich:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Pro běžná čísla a data : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Pro datum přibližně hodinu : před, po, tento_den_a_před, tento_den_a_po, včera, dnes, zítra, dnes_nebo_pozdě, poslední_7_dny, poslední_30_dny,
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.

Sloupce systému : added_by, created_at, updated_at, ip.

Pokud chcete hledat ve více sloupcích se sjednocujícím kritériem "AND", měla by být tato kritéria umístěna do jednoho pole, je-li "NEBO", pak do samostatného, například:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "je"}, {"a" => "PROPERTY_ID_2", "b" => "A", "o" => "je"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

vyhledávací vzorec bude: "Najít všechny záznamy, kde PROPERTY_ID_1 A PROPERTY_ID_2 se rovnají A NEBO PROPERTY_ID_3 se rovná B"

limit

Počet záznamů ve výsledcích vyhledávání, maximum je 200.

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

/search/APP_ID.json

Tělo požadavku

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

Response

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

Vztahy

Jak propojit záznamy:

Chcete-li aktualizovat propojení mezi záznamy, musíte do volání záznamu CREATE nebo UPDATE předat samostatný hash.

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

Tento hash by měl být jako 'rel' => {rel_id => RECORD_ID} nebo 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]}, pokud máte vztah mezi mnoha. Kde RECORD_ID je ID záznamu, se kterým se chcete spojit aktuální záznam. Níže se dozvíte, jak získat rel_id.

Parametry

rest_api_key

váš klíč API

PROPERTY_ID

ENTITY_ID

Abyste mohli aktualizovat nastavení pole, musíte znát identifikátor formuláře svého pole. ENTITY_ID najdete pomocí volání Načíst všechny formuláře . Jakmile to budete vědět, budete potřebovat přidat toto ENTITY_ID na URL v níže uvedeném odkazu, tj. změnit /apps/APP_ID/entities/ENTITY_ID/properties.json na /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

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

Response

Zprávy

Tyto atributy přehledu jsou přístupné prostřednictvím rozhraní REST API.

name

Jméno

Získejte zprávy

Parametry

rest_api_key

váš klíč API

APP_ID

ID aplikace

ENTITY_ID

ID tabulky (formuláře)

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

{"rest_api_key":"API_KEY"}

Response: vrátí všechny přehledy tabulek.

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

Vytvoření požadavku (XML)

Formát

XML

Metoda

GET

URL

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

Tělo požadavku: vrátí všechny přehledy tabulek.

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

Response

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

Soubory

Získat URL souboru

Chcete-li stáhnout soubory záznamu, musíte nejprve načíst hodnoty záznamu a poté budete moci stáhnout soubor pomocí odkazu, jako je tento https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, kde FILE_NAME - název souboru, který můžete získat z hash hodnot záznamů, který vypadá jakoу PROPERTY_ID => VALUE, RECORD_ID - ID záznamu, PROPERTY_ID - ID pole.

upload souborů

Abyste mohli nahrát soubor do záznamu, musíte udělat POST požadavek na metodu API upload_file s hlavičkou typu obsahu multipart/form-data a teprve poté musíte vytvořit nebo aktualizovat svůj záznam. Takže ID záznamu by měla být vygenerována před hovory. A také budete muset vygenerovat záhlaví Multipart, postupujte podle příkladu Ruby s třídou MultipartPost níže. V příkladu se naučíte, jak také nahrát soubor do podformuláře.

Rubínový příklad

  
    require 'open-uri'
    require 'openssl'

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    dtype_id = SecureRandom.urlsafe_base64

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

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

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


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

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

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

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

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

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

    puts response.body

Parametry

rest_api_key

váš klíč API

APP_ID

property_id

dtype_id

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

POST

URL

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

Tělo požadavku

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

Response

    Uploaded

Odebrat soubory

Parametry

rest_api_key

váš klíč API

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Název souboru

Vytvoření požadavku (JSON)

Formát

JSON

Metoda

GET

URL

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

Tělo požadavku

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

Response

    File removed

Příklady

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Vytváření správného volání pomocí metody: GET/POST/PUT/DELETE
  req = case method
          when "get"
            Net::HTTP::Get.new(uri.path) 
          when "post" 
            Net::HTTP::Post.new(uri.path)
          when "put"
            Net::HTTP::Put.new(uri.path)
          when "delete"
            Net::HTTP::Delete.new(uri.path)
        end

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

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

  # Všechna volání přes HTTPS a ověřování certifikátů SSL

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# Vytvoření požadavku
  https.start do |htt| 
    htt.request(req)
  end
end


# Zde nezapomeňte nastavit vlastní API_KEY
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Odpověď bude v response.body
puts response.body

Je dobře známo, že vývoj softwaru je v dnešní době velmi důležitý. Mít REST API pro váš software velmi zvýší popularitu vašeho produktu. Toto je základní REST API a mělo by to stačit k vytváření skvělých věcí. Pokud však potřebujete něco jiného, více metod atd., neváhejte nás kdykoli kontaktovat . Těšíme se, až se vám ozveme!

QuintaDB REST API

Obecné informace o voláních API

Databáze

Form

Pole

Záznam

Zprávy

Soubory

QuintaDB.com používá soubory cookie k zajištění nezbytné funkčnosti stránek a zlepšení vašich zkušeností. Používáním našich webových stránek souhlasíte s našimi zásadami používání cookies.