QuintaDB REST API

QuintaDB REST API QuintaDB veritabanında depolanan verilerden tam olarak yararlanmanıza izin vermek için tasarlanmıştır. Bu API'yi kullanarak, QuintaDB arayüzünün şu anda sunduğundan daha fazlasını elde edebilirsiniz. Aslında, size yapabilme becerisi veriyoruz Verilerinizle ihtiyacınız olan her şey. Örneğin, iPhone/Android ve daha fazlası gibi çeşitli platformlar için kendi komut dosyalarınızı, masaüstü uygulamalarınızı ve mobil uygulamalarınızı oluşturabilirsiniz. Ve QuintaDB orada kalacaktır, verilerinizi başkalarıyla birlikte depoladığınız, yönettiğiniz ve kullandığınız yer.

API çağrıları hakkında genel bilgiler

Tüm çağrılar, sayfanın başındaki "API anahtarları" düğmesi tıklanarak bulunabilen bir REST API anahtarı içermelidir.
Sunucu yanıtı , isteğinize bağlı olarak JSON veya XML biçiminde alınabilir.
Aşağıda, her istek için sunucu yanıtlarını içeren tablolar gösterilmektedir. URL`ler /apps.json olarak gösterilecektir, bu da yöntemi programınızda https://QuintaDB.ru /apps.json bağlantısıyla çağırmanız gerektiği anlamına gelir. Lütfen tüm aramaların https protokolünü kullanması gerektiğini ve geçerlilik için sunucunun SSL sertifikasını kontrol etmeniz gerektiğini unutmayın.

Veritabanı

Bu tür veritabanı öznitelikleri , REST API kullanılarak elde edilebilir.

Veritabanı için benzersiz tanımlayıcı

name

İsim

created_at

Veritabanının oluşturulduğu saat

updated_at

Veritabanının güncellendiği zaman

Tüm veritabanlarına bakın

Parametreler

rest_api_key

API anahtarınız

page

Veritabanları sayfa başına 20 görüntülenir, yani sayfa 1..5 olabilir

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps.json

İsteğin içeriği

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

Yanıtla: tüm veritabanlarını döndürür

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps.xml

İsteğin içeriği

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

Yanıtla: tüm veritabanlarını döndürür

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

Veritabanını kimliğe göre alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

Silmek istediğiniz veritabanının kimliğini bilmeniz gerekir. Tüm veritabanlarını aldıktan sonra kimliğini bulabilirsiniz . Veritabanı kimliğini bilerek kimliği URL'de listelemeniz gerekir, örneğin:/apps//Apps/aOWO_dVXHdHie1WeGFE8k2.json üzerinde ID.json

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps/APP_ID.json

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla: veritabanı bilgilerini döndürür

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps/APP_ID.xml

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Veritabanını ada göre alın

Parametreler

rest_api_key

API anahtarınız

İsim

Veritabanının adını bilmeniz gerekir. Ad, Tüm Veritabanlarını Al sorgusu çalıştırılarak elde edilebilir ..

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps/search.json

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps/search.xml

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Veritabanını güncelle

Parametreler

rest_api_key

API anahtarınız

APP_ID

name

Veritabanının yeni adı

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

PUT

URL

/apps/APP_ID.json

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

PUT

URL

/apps/APP_ID.xml

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Veritabanını sil

Parametreler

rest_api_key

API anahtarınız

APP_ID

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

DELETE

URL

/apps/APP_ID.json

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

DELETE

URL

/apps/APP_ID.xml

İsteğin içeriği

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

Yanıtla

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

Veritabanını sildikten sonra, bu yöntem kalan tüm veritabanlarını döndürür.

Bir uygulama oluşturun

Parametreler

rest_api_key

API anahtarınız

database_name

Veritabanının adı

form_name

Formun adı. Form olmadan veritabanında kullanım olmadığından veritabanı form olmadan oluşturulamaz.

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/apps.json

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

/apps.xml

İsteğin içeriği

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

Yanıtla: veritabanı bilgilerini döndürür

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

Hata durumunda. Hata mesajı alırsınız, yani 'Böyle bir uygulama adı zaten var'.

Form

Bu tür şekil öznitelikleri , REST API aracılığıyla elde edilebilir.

Form için benzersiz tanımlayıcı

name

İsim

desc

Tanım

post_action

E-posta alıcılarının listesi

Herhangi bir form alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps/APP_ID/entities.json

İsteğin içeriği

{rest_api_key":"API_KEY"}

Yanıtla: Tüm veritabanı formlarını alın

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps/APP_ID/entities.xml

İsteğin içeriği

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

Yanıtla: Tüm veritabanı formlarını alın

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

Kimlikteki formu alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

Form kimliğini bilmeniz gerekir. ENTITY_ID'yi tüm formları aldıktan sonra bulabilirsiniz . Form kimliğini bilerek, URL'deki ENTITY_ID'yi değiştirmeniz gerekir, örneğin:/apps/APP_ID/entities. /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json adresinde json

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps/APP_ID/entities/ID.json

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla: Formlar hakkında bilgi verir

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps/APP_ID/entities/ID.xml

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Formu Ada göre alın

Parametreler

rest_api_key

API anahtarınız

database_name

Veritabanının adını bilmeniz gerekir. Ad, Tüm Veritabanlarını Al sorgusu çalıştırılarak elde edilebilir ..

form_name

Form adını bilmeniz gerekir. Bu, Tüm Formları Al bağlantısı kullanılarak elde edilebilir.

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps/search/entities/search.json

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps/search/entities/search.xml

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Formu güncelleyin

Parametreler

rest_api_key

API anahtarınız

APP_ID

name

Formun yeni adı. Kullanılabilir tüm seçeneklerine buradan bakın

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

PUT

URL

/apps/APP_ID/entities/ID.json

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

PUT

URL

/apps/APP_ID/entities/ID.xml

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir formu silin

Parametreler

rest_api_key

API anahtarınız

APP_ID

Silmek istediğiniz formun kimliğini bilmeniz gerekir. Tüm formları aldıktan sonra kimliğini bulabilirsiniz . Formların kimliklerini bilerek, URL'de kimliği belirtmeniz gerekir, örneğin:/apps/APP_ID /entities/ID.json at /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

DELETE

URL

/apps/APP_ID/entities/ID.json

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

DELETE

URL

/apps/APP_ID/entities/ID.xml

İsteğin içeriği

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

Yanıtla

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

Bir form oluşturun

Parametreler

rest_api_key

API anahtarınız

APP_ID

name

Form Adı

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/apps/APP_ID/entities.json

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

/apps/APP_ID/entities.xml

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Alan

Bu tür alan öznitelikleri , REST API aracılığıyla elde edilebilir.

Alanın benzersiz tanımlayıcısı

entity_id

Form alanının kimliği

name

İsim

type_name

Alan türü. Olabilir: 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

Form alanlarını alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

{rest_api_key":"API_KEY"}

Yanıtla: Tüm form alanlarını alın

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla: Tüm form alanlarını alın

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

Bir alan alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

Alan kimliğini bilmeniz gerekir. kimliğini tüm form alanlarını aldıktan sonra bulabilirsiniz . Alan kimliğini bilerek, URL'de kimliği belirtmeniz gerekir, örneğin:/apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

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

Adı olan bir alan alın

Parametreler

rest_api_key

API anahtarınız

database_name

Veritabanının adını bilmeniz gerekir. Ad, Tüm Veritabanlarını Al sorgusu çalıştırılarak elde edilebilir ..

form_name

Form adını bilmeniz gerekir. Bu, Tüm Formları Al bağlantısı kullanılarak elde edilebilir.

field_name

Alan adını bilmeniz gerekir. Bu, Tüm Form Alanlarını Al bağlantısıyla elde edilebilir.

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

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

Eylemi çalıştır

Parametreler

rest_api_key

API anahtarınız

DTYPE_ID

Kayıt tanımlayıcınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz.

ACTION_PROPERTY_ID

Alan tanımlayıcınızı bilmeniz gerekir. Tüm Form Alanlarını Getir çağrısını kullanarak kimliği bulabilirsiniz.

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/actions/ACTION_PROPERTY_ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/actions/ACTION_PROPERTY_ID.xml

İsteğin içeriği

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

Yanıtla

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

Eylemleri çalıştır

Parametreler

rest_api_key

API anahtarınız

ACTION_PROPERTY_ID

Alan tanımlayıcınızı bilmeniz gerekir. Tüm Form Alanlarını Getir çağrısını kullanarak kimliği bulabilirsiniz.

dtype_ids

Kayıt tanımlayıcılarınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz.

json_dtype_ids

Kayıt tanımlayıcılarınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz.

run_by_all_table_or_report

Tablodaki veya rapordaki tüm eylemleri çalıştırmak için aşağıdaki parametre kullanılabilir: run_by_all_table_or_report=true.

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/actions/ACTION_PROPERTY_ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/actions/ACTION_PROPERTY_ID.xml

İsteğin içeriği

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

Yanıtla

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

Alanı güncelleyin

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

name

Yeni alan adı. Mevcut tüm öznitelikler burada bulunabilir

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

PUT

URL

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

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

PUT

URL

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

İsteğin içeriği

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

Yanıtla

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

Bir alanı silin

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

DELETE

URL

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

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

DELETE

URL

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

İsteğin içeriği

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

Yanıtla

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

Bir alan oluşturun

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

name

Alan Adı

type_name

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

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

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

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

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir sütundaki toplamları alır

Parametreler

rest_api_key

API anahtarınız

ENTITY_ID

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/search/sum/ENTITY_ID/ID.json

İsteğin içeriği

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

Yanıtla

    
{total: 3}

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/search/sum/ENTITY_ID/ID.xml

İsteğin içeriği

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

Yanıtla

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

Kayıt

Bu tür yazma öznitelikleri , REST API aracılığıyla elde edilebilir.

Kayıt için benzersiz tanımlayıcı.

app_id

uygulama Kimliği

entity_id

Kayıt formunun kimliği.

values

Kaydedilen değerlerin karması. Anahtar alan kimliği ve değerin alan değeridir.

json_values

Değerler karmasını kaydedin. Anahtarın alan kimliği olduğu ve değerin bu alan değeri olduğu yerde. values_hash'in analogu, ancak JSON biçiminde

rel_values

Yazma ilişkisi değerinin karması. Burada anahtar alan kimliği ve değer, ilişkili kayıt kimliğidir.

Kayıtları alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

page

Sayfa numarasını kaydedin. 1'den kayıt sayısına kadar/ sayfa başına .

name_value

Biçimdeki kayıtları almak için parametreyi kullanın: "alan adı": "değer", "alan kimliği": "alan adı"

fetch_all

Ücretli hesap sahipleri için şu parametre kullanılabilir: fetch_all=true.
Belirli sayıda gönderi almak için per_page parametresini kullanın.
Farklı planlar için per_page maksimum giriş sayısıyla ilgili kısıtlamalar:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

İstek gövdesi
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

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

Kayıt alın

Parametreler

rest_api_key

API anahtarınız

APP_ID

Kaydın kimliğini bilmeniz gerekir. Kimlik, tüm kayıtları aldıktan sonra bulunabilir . Kimliği bilerek, kimliği URL'de listelemelisiniz, örneğin:/apps/APP_ID/dtypes/ID. /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json adresinde json

name_value

Biçimdeki kayıtları almak için parametreyi kullanın: "alan adı": "değer", "alan kimliği": "alan adı"

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

/apps/APP_ID/dtypes/ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

/apps/APP_ID/dtypes/ID.xml

İsteğin içeriği

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

Yanıtla

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

Bir kaydı güncelleme

Parametreler

rest_api_key

API anahtarınız

APP_ID

values

Anahtarın form alanı kimliği olduğu kayıt değerlerinin karması

json_values

jQuery, Ruby veya başka bir programlama dili kullanıyorsanız, lütfen 'değerler' parametresinde kodlanmış bir karma gibi kayıt değerlerini sağlayın. Ancak çerçeveniz buna izin vermiyorsa, JSON gibi kayıt değerlerini gönderebilirsiniz, örneğin: " {"aNW4nkW5bdUjldO8oKuSku ": "2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". Ama sonra 'json_values' parametre adını kullanın.

subforms_values / subforms_json_values

Aynı şekilde, alt formları oluşturmak veya güncellemek için 'subforms_values' seçeneğini kullanın veya 'json_subforms_values'.
şu biçim:
"{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2 ", subform1_field2_id: "aaa "}, subform1_record2_id: {subform1_field1_id: "3 ", subform1_field2_id: "bb "}}, property2_id: {entity_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4 ", subform2_field2_id: "bb "}, subform2_record2_id: {subform2_field1_id: "5 ", subform2_field2_id: "dd "}}} ".

Property1_id ve property2_id - ana tablodaki Alt form alanlarının kimliğidir.
subform1_id, subform2_id - property1_id ve property2_id alanları tarafından belirtilen formun kimliği.
subform1_record1_id ve subform1_record2_id - bu, alt formdaki yeni veya mevcut kayıtların kimliğidir.
subform1_field1_id, subform1_field2_id - subform1_id'deki alanların kimliği.
subform2_field1_id, subform2_field2_id - subform2_id formundaki alanların kimliği.

Tüm kimlikler, 22 karakter URL güvenli base64 kodlarıdır, bunları diğer bağlantı API'lerinden alabilir veya yeni kayıtların kimlikleri için kendinizinkini oluşturabilirsiniz.

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

PUT

URL

/apps/APP_ID/dtypes/ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

PUT

URL

/apps/APP_ID/dtypes/ID.xml

İsteğin içeriği

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

Yanıtla

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

Bazı kayıtları güncelleyin

Parametreler

rest_api_key

API anahtarınız

confirm_action

Tabloda veya raporda güncellemeyi çalıştırmak için aşağıdaki parametre gereklidir: confirm_action: update.

ENTITY_ID

Alan ayarlarını güncellemek için alanınızın form tanımlayıcısını bilmeniz gerekir. ENTITY_ID'yi Tüm Formları Al çağrısını kullanarak bulabilirsiniz.

APP_ID

Veritabanı bilgilerini almak için veritabanı tanımlayıcınızı bilmeniz gerekir. Kimliği Tüm Veritabanlarını Al çağrısını kullanarak bulabilirsiniz.

dtype_ids

Kayıt tanımlayıcılarınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz.

json_dtype_ids

Kayıt tanımlayıcılarınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz.

update_id

Alan tanımlayıcınızı bilmeniz gerekir. Tüm Form Alanlarını Getir çağrısını kullanarak kimliği bulabilirsiniz.

update_term

Kayıtlar için yeni değer

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

İsteğin içeriği


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

Yanıtla

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

Tüm kayıtları güncelle

Parametreler

rest_api_key

API anahtarınız

confirm_action

Tablo veya rapordaki tüm kayıtların güncellemesini çalıştırmak için aşağıdaki parametre gereklidir: confirm_action: update_all.

ENTITY_ID

Alan ayarlarını güncellemek için alanınızın form tanımlayıcısını bilmeniz gerekir. ENTITY_ID'yi Tüm Formları Al çağrısını kullanarak bulabilirsiniz.

APP_ID

Veritabanı bilgilerini almak için veritabanı tanımlayıcınızı bilmeniz gerekir. Kimliği Tüm Veritabanlarını Al çağrısını kullanarak bulabilirsiniz.

update_id

Alan tanımlayıcınızı bilmeniz gerekir. Tüm Form Alanlarını Getir çağrısını kullanarak kimliği bulabilirsiniz.

update_term

Kayıtlar için yeni değer

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

İsteğin içeriği


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

Yanıtla

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

Hücre verilerini güncelle

Parametreler

rest_api_key

API anahtarınız

PROPERTY_ID

DTYPE_ID

val

Veri hücresinin yeni değeri

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

İsteğin içeriği

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

Yanıtla

    
{"new_value": "John Smith"}

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

İsteğin içeriği

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

Yanıtla

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

Kaydı sil

Parametreler

rest_api_key

API anahtarınız

APP_ID

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

DELETE

URL

/apps/APP_ID/dtypes/ID.json

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

İsteğin içeriği

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

Yanıtla

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

Bazı kayıtları silin

Parametreler

rest_api_key

API anahtarınız

ENTITY_ID

Alan ayarlarını güncellemek için alanınızın form tanımlayıcısını bilmeniz gerekir. ENTITY_ID'yi Tüm Formları Al çağrısını kullanarak bulabilirsiniz.

APP_ID

Veritabanı bilgilerini almak için veritabanı tanımlayıcınızı bilmeniz gerekir. Kimliği Tüm Veritabanlarını Al çağrısını kullanarak bulabilirsiniz.

dtype_ids

Kayıt tanımlayıcılarınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz.

json_dtype_ids

Kayıt tanımlayıcılarınızı bilmeniz gerekir. Kimliği Tüm Kayıtları Al çağrısını kullanarak bulabilirsiniz. (Zorunlu değil)

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

İsteğin içeriği


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

Yanıtla

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

Tümünü sil

Parametreler

rest_api_key

API anahtarınız

APP_ID

Veritabanı bilgilerini almak için veritabanı tanımlayıcınızı bilmeniz gerekir. Kimliği Tüm Veritabanlarını Al çağrısını kullanarak bulabilirsiniz.

ENTITY_ID

Alan ayarlarını güncellemek için alanınızın form tanımlayıcısını bilmeniz gerekir. ENTITY_ID'yi Tüm Formları Al çağrısını kullanarak bulabilirsiniz.

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

İsteğin içeriği

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

Yanıtla

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

İsteğin içeriği


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

Yanıtla

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

Yeni kayıt

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

Kişisel kimliğinizi kullanmanız gerekiyorsa, UUID (benzersiz tanımlayıcı) oluşturabilirsiniz 22 karakter uzunluğunda URL güvenli base64 Örneğin . Ardından bunu 'değerler' karmasına iletmeniz gerekir, örneğin: values => {'id' => ID}, şununla değiştirin: değerler => {'id' => '22adadVXHdHie1WeGFE8k2'}, aksi takdirde sistem sizin için benzersiz bir tanımlayıcı oluşturacaktır.

values / json_values

subforms_values / subforms_json_values

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/apps/APP_ID/dtypes.json

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

POST

URL

/apps/APP_ID/dtypes.xml

İsteğin içeriği

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

Yanıtla: Formlar hakkında bilgi verir

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

Arama

Parametreler

rest_api_key

API anahtarınız

APP_ID

ENTITY_ID

view

Kayıtları almak için rapor kimliğini bilmeniz gerekir. (Zorunlu değil)

search

Masaya bir fiske vurmak ister misin? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - aradığımız alan tanımlayıcısı ( -ALL - - tüm sütunları aramak için),
SEARCH_TERM - aradığımız değer,
SEARCH_CRITERIA - bir mesaj için kriter, belki bunlardan biri:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Normal sayılar ve tarihler için : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Yaklaşık bir saatlik bir randevu için : 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.

Sistem sütunları : added_by, created_at, updated_at, ip.

Birleştirici "VE" ölçütü ile birkaç sütunda arama yapmak istiyorsanız, bu ölçütler tek bir diziye yerleştirilmelidir, "VEYA" ise, ayrı bir tanesine, örneğin:
[[{"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"}]]

arama formülü olacak: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Arama sonuçlarındaki kayıt sayısı, maksimum 200'dür.

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

/search/APP_ID.json

İsteğin içeriği

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

Yanıtla

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

Kayıtlar Nasıl Bağlanır:

Kayıtlar arasında bir ilişki kurmak için, CREATE veya UPDATE kaydında ayrı bir karma göndermeniz gerekir.

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 "

Hash gerekir Çoktan çoğa bir ilişkiniz varsa 'rel' => {rel_id => RECORD_ID} veya 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} biçiminde olun Burada RECORD_ID - mevcut olanı birleştirmek istediğiniz kaydın kimliğidir rel_id nasıl alınır.

Parametreler

rest_api_key

API anahtarınız

PROPERTY_ID

ENTITY_ID

Form kimliğini bilmeniz gerekiyor. ENTITY_ID tüm formları aldıktan sonra bulabilirsiniz. Form kimliğini bilerek, URL deki ENTITY_ID yi değiştirmeniz gerekir, örneğin /apps/APP_ID/entities/ENTITY_ID/properties.json ile /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

Raporlar

Bu tür rapor özniteliklerine REST API aracılığıyla erişilebilir.

name

İsim

Raporları Al

Parametreler

rest_api_key

API anahtarınız

APP_ID

uygulama Kimliği

ENTITY_ID

Tablo (Form) Kimliği

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

{"rest_api_key":"API_KEY"}

Yanıtla: tüm tablo raporlarını döndürür.

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

Bir sorgu gönderiyoruz (XML)

Format

XML

yöntem

GET

URL

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

İsteğin içeriği: tüm tablo raporlarını döndürür.

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

Yanıtla

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

Dosyalar

Dosya bağlantısına bakın

dosyanın bağlantısını almak için, önce kayıt alanlarının değerlerini alın ve dosyayı https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME bağlantısından indirebilirsiniz, burada FILE_NAME - indirilen dosyanın adı, PROPERTY_ID => VALUE, RECORD_ID - kayıt kimliği, PROPERTY_ID - alan kimliği türündeki hashe değerleri.

Dosyaları indir

Bir kayda dosya yüklemek için, upload_file API yöntemine multipart / form-data içerik türü başlığıyla bir POST isteğinde bulunmanız ve bundan sonra kaydınızı oluşturmanız veya güncellemeniz gerekir. Yani kayıt kimliği çağrılardan önce oluşturulmalıdır. Ayrıca Multipart başlığını oluşturmanız gerekecek, lütfen aşağıdaki MultipartPost sınıfıyla Ruby örneğini izleyin. Örneğin, dosyayı alt forma nasıl yükleyeceğinizi de öğreneceksiniz.

Ruby ile ilgili bir örnek

  
    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

Parametreler

rest_api_key

API anahtarınız

APP_ID

property_id

dtype_id

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

POST

URL

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

İsteğin içeriği

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

Yanıtla

    Uploaded

Dosyaları kaldır

Parametreler

rest_api_key

API anahtarınız

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Dosya Adı

Bir sorgu gönderiyoruz (JSON)

Format

JSON

yöntem

GET

URL

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

İsteğin içeriği

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

Yanıtla

    File removed

Örnekler

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Gerekli yönteme bir çağrı oluşturun: 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

   # Parametreleri JSON/XML`e dönüştür ve içerik türünü application/json veya application/xml olarak ayarla   Kök öğenin api_call_params olduğu XML parametresinin biçimine dikkat edin  
  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
	# İçerik türünü ayarlayın
  req["Content-Type"] = "application/#{format}"

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

  # Tüm HTTPS bağlantıları ve SSL sertifikaları kontrol edilir

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# Bir sorgu gönderiyoruz
  https.start do |htt| 
    htt.request(req)
  end
end


# API_KEY'i ayarlamayı unutmayın
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Yanıt uygun olacaktır response.body
puts response.body

Bu temel bir REST API'sidir ve harika ve faydalı şeyler oluşturmak için yeterli olmalıdır. Ancak, başka bir şey istiyorsanız, örneğin daha fazla yöntem vb. Lütfen ile iletişime geçin bize her zaman. Sizden haber almaktan her zaman heyecan duyuyoruz!

QuintaDB REST API

API çağrıları hakkında genel bilgiler

Veritabanı

Form

Alan

Kayıt

Raporlar

Dosyalar

Web sitesinin gerekli işlevselliğini sağlamak için çerezler kullanıyoruz. "Kabul Et" seçeneğine tıklayarak, web sitemizde çerez kullanımına izin vermiş olursunuz.