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

واجهة برمجة تطبيقات QuintaDB REST

واجهة برمجة تطبيقات QuintaDB REST تم تصميمها للسماح لك بالاستغلال الكامل لإمكانيات البيانات المخزنة في قاعدة بيانات QuintaDB. باستخدام واجهة برمجة التطبيقات هذه ، يمكنك تحقيق أكثر مما تقدمه واجهة QuintaDB حاليًا. في الواقع ، نمنحك الفرصة للقيام كل ما تحتاجه مع البيانات. على سبيل المثال ، يمكنك إنشاء البرامج النصية الخاصة بك وتطبيقات الكمبيوتر و تطبيقات الجوال لمختلف الأنظمة الأساسية مثل iPhone/Android وغيرها. وسيبقى QuintaDB هناك ، حيث تقوم بتخزين وإدارة واستخدام بياناتك مع الآخرين

معلومات عامة حول استدعاءات واجهة برمجة التطبيقات

يجب أن تحتوي جميع الاستدعاءات على REST مفتاح API ، والذي يمكن العثور عليه من خلال النقر على الزر "مفاتيح API" في بداية الصفحة.
يمكن تلقي استجابة الخادم بتنسيق JSON أو XML ، حسب طلبك.
نعرض أدناه جداول مع ردود الخادم لكل طلب. سيتم عرض عناوين URL كـ /apps.json ، مما يعني أنه يجب عليك استدعاء الطريقة بالرابط https://QuintaDB.ru /apps.json في برنامجك. الرجاء ملاحظة أن جميع المكالمات يجب أن تستخدم بروتوكول https ويجب عليك التحقق من شهادة SSL للخادم للتحقق من صلاحيتها.

قاعدة البيانات

يمكن الحصول على سمات قاعدة البيانات باستخدام واجهة برمجة تطبيقات REST.

id

معرف قاعدة البيانات الفريد

name

اسم

created_at

الوقت الذي تم فيه إنشاء قاعدة البيانات

updated_at

الوقت الذي تم فيه تحديث قاعدة البيانات

عرض كافة قواعد البيانات

المعلمات
rest_api_key

مفتاح API الخاص بك

page

يتم عرض قواعد البيانات 20 لكل صفحة ، بحيث يمكن أن تكون الصفحة 1..5

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps.json

محتوى الطلب

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

الجواب: returns your current databases.

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps.xml

محتوى الطلب

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

الجواب: returns your current databases.

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

تقوم بإرجاع المعلومات حول قاعدة البيانات

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps/APP_ID.json

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب: returns database information

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps/APP_ID.xml

محتوى الطلب

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

الجواب: returns database information

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>
             

احصل على قاعدة البيانات بالاسم

المعلمات
rest_api_key

مفتاح API الخاص بك

اسم

يجب أن تعرف اسم قاعدة البيانات. يمكنك الحصول على الاسم عن طريق تشغيل الاستعلام الحصول على جميع قواعد البيانات ..

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps/search.json

محتوى الطلب

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

الجواب: returns database information

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps/search.xml

محتوى الطلب

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

الجواب: returns database information

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>
             

قم بتحديث قاعدة البيانات

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

name

اسم قاعدة بيانات جديد

Making request (JSON)
التنسيق

JSON

الطريقة

PUT

URL

/apps/APP_ID.json

محتوى الطلب

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

الجواب: returns database information

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

Making request (XML)
التنسيق

XML

الطريقة

PUT

URL

/apps/APP_ID.xml

محتوى الطلب

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

الجواب: returns database information

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>New database name</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>
             

حذف قاعدة البيانات

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)
التنسيق

JSON

الطريقة

DELETE

URL

/apps/APP_ID.json

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

DELETE

URL

/apps/APP_ID.xml

محتوى الطلب

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

الجواب

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

After removing database this call returns all databases which were left.

إنشاء تطبيق

المعلمات
rest_api_key

مفتاح API الخاص بك

database_name

اسم قاعدة البيانات

form_name

اسم النموذج. لا يمكنك إنشاء قاعدة بيانات بدون نموذج لأنه لا توجد نقطة في قاعدة بيانات بدون نموذج.

Making request (JSON)
التنسيق

JSON

الطريقة

POST

URL

/apps.json

محتوى الطلب

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

الجواب: returns database information

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

Making request (XML)
التنسيق

XML

الطريقة

POST

URL

/apps.xml

محتوى الطلب

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

الجواب: returns database information

    
  <?xml version="1.0" encoding="UTF-8"?>
    <database>
      <id>aOWO_dVXHdHie1WeGFE8k2</id>
      <name>Database name 1</name>
      <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
      <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
      <dtypes-count type="integer">0</dtypes-count>
      <entities-count type="integer">1</entities-count>
      <properties-count type="integer">0</properties-count>
    </database>
             

في حالة حدوث خطأ. ستظهر لك رسالة خطأ ، مثل اسم التطبيق هذا موجود بالفعل

النموذج

يمكن الحصول على سمات الشكل هذه من خلال REST API.

id

المعرف الفريد للنموذج

name

اسم

desc

الوصف

post_action

قائمة مستلمي رسائل البريد الإلكتروني

احصل على أي أشكال

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps/APP_ID/entities.json

محتوى الطلب

{rest_api_key":"API_KEY"}

الجواب: احصل على جميع نماذج قاعدة البيانات

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps/APP_ID/entities.xml

محتوى الطلب

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

الجواب: احصل على جميع نماذج قاعدة البيانات

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

إرجاع معلومات حول النماذج

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps/APP_ID/entities/ID.json

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب: returns form information

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps/APP_ID/entities/ID.xml

محتوى الطلب

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

الجواب: returns form information

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

احصل على النموذج بالاسم

المعلمات
rest_api_key

مفتاح API الخاص بك

database_name

يجب أن تعرف اسم قاعدة البيانات. يمكنك الحصول على الاسم عن طريق تشغيل الاستعلام الحصول على جميع قواعد البيانات ..

form_name

يجب أن تعرف اسم النموذج. يمكنك الحصول عليه عن طريق ربط الحصول على جميع النماذج .

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps/search/entities/search.json

محتوى الطلب

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

الجواب: returns form information

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps/search/entities/search.xml

محتوى الطلب

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

الجواب: returns form information

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

تحديث النموذج

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

name

اسم النموذج الجديد. راجع جميع الخيارات المتاحة هنا

Making request (JSON)
التنسيق

JSON

الطريقة

PUT

URL

/apps/APP_ID/entities/ID.json

محتوى الطلب

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

الجواب: returns form information

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

Making request (XML)
التنسيق

XML

الطريقة

PUT

URL

/apps/APP_ID/entities/ID.xml

محتوى الطلب

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

الجواب: returns form information

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

حذف النموذج

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

يجب أن تعرف معرف النموذج الذي تريد حذفه. يمكنك العثور على رقم التعريف بعد تلقي جميع النماذج . بمعرفة معرف النموذج ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID /entities/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)
التنسيق

JSON

الطريقة

DELETE

URL

/apps/APP_ID/entities/ID.json

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

DELETE

URL

/apps/APP_ID/entities/ID.xml

محتوى الطلب

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

الجواب

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

إنشاء نموذج

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

name

اسم النموذج

Making request (JSON)
التنسيق

JSON

الطريقة

POST

URL

/apps/APP_ID/entities.json

محتوى الطلب

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

الجواب: returns form information

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

Making request (XML)
التنسيق

XML

الطريقة

POST

URL

/apps/APP_ID/entities.xml

محتوى الطلب

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

الجواب: returns form information

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

الحقل

يمكن الحصول على سمات الحقل هذه من خلال REST API.

id

المعرف الفريد للحقل

entity_id

Field's form identifier.

name

اسم

type_name

نوع الحقل. يمكن: string, text, integer, float, select, radio button, check box, date, dob, datetime, file, image, boolean, language, states, table, country, time_zone, note, divider, formula, autoincrement, login, password, signature, linked_column, rel, subform

الحصول على حقول النموذج

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

{rest_api_key":"API_KEY"}

الجواب: احصل على جميع حقول النموذج

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب: احصل على جميع حقول النموذج

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

احصل على حقل

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب

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

             

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

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

احصل على حقل بالاسم

المعلمات
rest_api_key

مفتاح API الخاص بك

database_name

يجب أن تعرف اسم قاعدة البيانات. يمكنك الحصول على الاسم عن طريق تشغيل الاستعلام الحصول على جميع قواعد البيانات ..

form_name

يجب أن تعرف اسم النموذج. يمكنك الحصول عليه عن طريق ربط الحصول على جميع النماذج .

field_name

يجب أن تعرف اسم الحقل. يمكنك الحصول عليه عن طريق ربط الحصول على جميع حقول النموذج .

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

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

تحديث الحقل

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

name

اسم حقل جديد. يمكن العثور على جميع السمات المتاحة هنا

Making request (JSON)
التنسيق

JSON

الطريقة

PUT

URL

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

محتوى الطلب

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

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

PUT

URL

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

محتوى الطلب

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

الجواب

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

حذف الحقل

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Making request (JSON)
التنسيق

JSON

الطريقة

DELETE

URL

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

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

DELETE

URL

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

محتوى الطلب

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

الجواب

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

إنشاء حقل

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

name

اسم الحقل

type_name

نوع الحقل. يمكن: string, text, integer, float, select, radio button, check box, date, dob, datetime, file, image, boolean, language, states, table, country, time_zone, note, divider, formula, autoincrement, login, password, rel, linked_column, signature, subform

Making request (JSON)
التنسيق

JSON

الطريقة

POST

URL

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

محتوى الطلب

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

الجواب: returns form information

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

Making request (XML)
التنسيق

XML

الطريقة

POST

URL

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

محتوى الطلب

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

الجواب: returns form information

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

احصل على المجاميع في العمود

المعلمات
rest_api_key

مفتاح API الخاص بك

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

view

للحصول على السجلات ، يجب أن تعرف معرف التقرير. (ليس بالضرورة)

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/search/sum/ENTITY_ID/ID.json

محتوى الطلب

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

الجواب

    
{total: 3}
             

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/search/sum/ENTITY_ID/ID.xml

محتوى الطلب

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

الجواب

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

تسجيل

يمكن الحصول على سمات التسجيل هذه من خلال REST API.

id

المعرف الفريد للسجل.

app_id

معرّف التطبيق

entity_id

معرف نموذج التسجيل

values

Record values hash. Where key is field id and value is this field value.

rel_values

تجزئة قيمة ارتباط السجل. حيث يكون المفتاح معرف الحقل والقيمة هي معرف السجل المرتبط.

الحصول على السجلات

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

view

للحصول على السجلات ، يجب أن تعرف معرف التقرير. (ليس بالضرورة)

page

رقم الصفحة مع السجلات. من 1 إلى عدد السجلات/ per_page .

name_value

استخدم المعلمة للحصول على سجلات بالشكل: "اسم الحقل": "القيمة" ، "معرف الحقل": "اسم الحقل"

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

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

احصل على رقم قياسي

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

يجب أن تعرف معرّف السجل. يمكن العثور على المعرّف بعد استلام جميع السجلات . عندما تعرف المعرّف ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

استخدم المعلمة للحصول على سجلات بالشكل: "اسم الحقل": "القيمة" ، "معرف الحقل": "اسم الحقل"

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

/apps/APP_ID/dtypes/ID.json

محتوى الطلب

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

الجواب

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

             

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

/apps/APP_ID/dtypes/ID.xml

محتوى الطلب

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

الجواب

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

تحديث السجل

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

يجب أن تعرف معرّف السجل. يمكن العثور على المعرّف بعد استلام جميع السجلات . عندما تعرف المعرّف ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

values

تجزئة قيم السجلات ، حيث يكون المفتاح هو معرف حقل النموذج

json_values

إذا كنت تستخدم jQuery أو Ruby أو لغة برمجة أخرى ، فالرجاء إدخال قيم السجل كتجزئة مشفرة في معلمة القيم . ولكن إذا كان إطارك لا يسمح لك بذلك ، فيمكنك إرسال قيم السجل ، JSON ، على سبيل المثال: " {"aNW4nkW5bdUjldO8oKuSku ": "2 "، "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". ولكن استخدم بعد ذلك اسم المعلمة json_values ​​.

subforms_values / subforms_json_values

لإنشاء النماذج الفرعية أو تحديثها ، بالمثل ، استخدم subforms_values ​​أو 'json_subforms_values'.
التنسيق التالي:
"{property1_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: {كيان_معرف: subform2_id ، subform2_record1_id: {subform2_field1_id: "4 " ، subform2_field2_id: "bb "} ، subform2_record2_id: {subform2_field1_id: "5 "، subform2_field2_id: "dd "}}} ".

حيث property1_id و property2_id هو معرف حقول النموذج الفرعي في الجدول الرئيسي.
subform1_id، subform2_id - معرف النموذج ، الذي يشير إليه الحقلان property1_id و property2_id.
subform1_record1_id و subform1_record2_id - هذا هو معرف سجلات النماذج الفرعية الجديدة أو الحالية.
subform1_field1_id، subform1_field2_id - معرف الحقول في النموذج subform1_id.
subform2_field1_id، subform2_field2_id - معرف الحقول في نموذج subform2_id.

جميع المعرّفات عبارة عن أكواد أساسية 64 عنوان URL مؤمنة مكونة من 22 حرفًا ، ويمكنك أخذها من واجهات برمجة تطبيقات الاتصال الأخرى أو إنشاء معرفات خاصة بك لمعرفات السجلات الجديدة.

Making request (JSON)
التنسيق

JSON

الطريقة

PUT

URL

/apps/APP_ID/dtypes/ID.json

محتوى الطلب

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

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

PUT

URL

/apps/APP_ID/dtypes/ID.xml

محتوى الطلب

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

الجواب

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

تحديث بيانات الخلية

المعلمات
rest_api_key

مفتاح API الخاص بك

PROPERTY_ID

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

DTYPE_ID

يجب أن تعرف معرّف السجل. يمكن العثور على المعرّف بعد استلام جميع السجلات . عندما تعرف المعرّف ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

val

القيمة الجديدة لخلية البيانات

Making request (JSON)
التنسيق

JSON

الطريقة

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

محتوى الطلب

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

الجواب

    
{"new_value": "John Smith"}
             

Making request (XML)
التنسيق

XML

الطريقة

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

محتوى الطلب

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

الجواب

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

حذف السجل

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ID

يجب أن تعرف معرّف السجل. يمكن العثور على المعرّف بعد استلام جميع السجلات . عندما تعرف المعرّف ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Making request (JSON)
التنسيق

JSON

الطريقة

DELETE

URL

/apps/APP_ID/dtypes/ID.json

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب

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

Making request (XML)
التنسيق

XML

الطريقة

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

محتوى الطلب

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

الجواب

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

رقم قياسي جديد

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID

إذا كنت بحاجة إلى استخدام معرّفك الشخصي ، فيمكنك إنشاء UUID (معرّف فريد) 22 حرفًا بطول URL آمن base64. على سبيل المثال ، في Ruby . بعد ذلك ، ستحتاج إلى تمريرها إلى تجزئة 'القيم' ، على سبيل المثال: القيم => {' id '=> ID} ، غيّر إلى: القيم => {'id' => '22adadVXHdHie1WeGFE8k2'} ، وإلا فسيقوم النظام بإنشاء معرف فريد لك.

values / json_values

إذا كنت تستخدم jQuery أو Ruby أو لغة برمجة أخرى ، فالرجاء إدخال قيم السجل كتجزئة مشفرة في معلمة القيم . ولكن إذا كان إطارك لا يسمح لك بذلك ، فيمكنك إرسال قيم السجل ، JSON ، على سبيل المثال: " {"aNW4nkW5bdUjldO8oKuSku ": "2 "، "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". ولكن استخدم بعد ذلك اسم المعلمة json_values ​​.

subforms_values / subforms_json_values

لإنشاء النماذج الفرعية أو تحديثها ، بالمثل ، استخدم subforms_values ​​أو 'json_subforms_values'.
التنسيق التالي:
"{property1_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: {كيان_معرف: subform2_id ، subform2_record1_id: {subform2_field1_id: "4 " ، subform2_field2_id: "bb "} ، subform2_record2_id: {subform2_field1_id: "5 "، subform2_field2_id: "dd "}}} ".

حيث property1_id و property2_id هو معرف حقول النموذج الفرعي في الجدول الرئيسي.
subform1_id، subform2_id - معرف النموذج ، الذي يشير إليه الحقلان property1_id و property2_id.
subform1_record1_id و subform1_record2_id - هذا هو معرف سجلات النماذج الفرعية الجديدة أو الحالية.
subform1_field1_id، subform1_field2_id - معرف الحقول في النموذج subform1_id.
subform2_field1_id، subform2_field2_id - معرف الحقول في نموذج subform2_id.

جميع المعرّفات عبارة عن أكواد أساسية 64 عنوان URL مؤمنة مكونة من 22 حرفًا ، ويمكنك أخذها من واجهات برمجة تطبيقات الاتصال الأخرى أو إنشاء معرفات خاصة بك لمعرفات السجلات الجديدة.

Making request (JSON)
التنسيق

JSON

الطريقة

POST

URL

/apps/APP_ID/dtypes.json

محتوى الطلب

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

الجواب: returns form information

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

Making request (XML)
التنسيق

XML

الطريقة

POST

URL

/apps/APP_ID/dtypes.xml

محتوى الطلب

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

الجواب: returns form information

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

حث

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . عندما تعرف معرف النموذج ، يلزمك إدراج ENTITY_ID في عنوان URL ، على سبيل المثال:/apps/APP_ID/كيانات. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

view

للحصول على السجلات ، يجب أن تعرف معرف التقرير. (ليس بالضرورة)

search

هل ترغب في نقرة على الطاولة؟ "SEARCH_TERM"، "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - معرف الحقل خلف الياك ، يتم تنفيذ كزة ( -ALL - - لكزة على جميع الأعمدة) ،
SEARCH_TERM - معنى ، yake shukaєmo ،
SEARCH_CRITERIA - معيار لرسالة ، ربما واحد منهم:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

لأرقام والتواريخ العادية : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

للحصول على موعد لمدة ساعة تقريبًا : before, after, this_day_and_before, this_day_and_after, yesterday, today, tomorrow, today_or_later, last_7_days, last_30_days,
last_60_days, last_90_days, last_120_days, next_7_days, next_30_days, next_60_days, next_90_days, next_120_days, next_n_days, last_n_days,
last_week, this_week, next_week, current_and_prev_week, current_and_next_week, next_n_weeks, last_n_weeks, last_month, this_month, next_month,
current_and_prev_month, current_and_next_month, next_n_months, last_n_months, last_year, this_year, last_2_years, next_2_years, current_and_prev_year,
current_and_next_year, next_n_years, last_n_years.

أعمدة النظام : added_by, created_at, updated_at, ip.

إذا كنت تريد البحث في عدة أعمدة بمعيار موحد "AND" ، فيجب وضع هذه المعايير في مصفوفة واحدة ، إذا كان "OR" ، ثم في حالة منفصلة ، على سبيل المثال:
[[{"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"}]]

ستكون صيغة البحث: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

عدد التسجيلات في نتائج البحث ، الحد الأقصى 200.

Making request (JSON)
التنسيق

JSON

الطريقة

POST

URL

/search/APP_ID.json

محتوى الطلب

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

الجواب

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

             

العلاقة

كيفية ربط السجلات:

لإنشاء علاقة بين السجلات ، يجب إرسال تجزئة منفصلة في الاستعلام إنشاء أو تحديث السجل.

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

Hash must كن في النموذج 'rel' => {rel_id => RECORD_ID} أو 'rel' => {rel_id => [RECORD_ID، RECORD_ID2]} إذا كانت لديك علاقة أطراف بأطراف. حيث RECORD_ID هو معرف السجل حيث تريد دمج الحالي سجل. إليك كيفية الحصول على rel_id.

المعلمات
rest_api_key

مفتاح API الخاص بك

PROPERTY_ID

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ENTITY_ID

يجب أن تعرف معرف النموذج. يمكنك العثور على ENTITY_ID بعد تلقي جميع النماذج . بمعرفة معرف النموذج ، ستحتاج إلى استبدال ENTITY_ID في عنوان URL ، على سبيل المثال /apps/APP_ID/entities/ENTITY_ID/properties.json بـ /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

11842         

التقارير

يمكن الوصول إلى سمات التقرير عبر واجهة برمجة تطبيقات REST.

id

ID

name

اسم

احصل على التقارير

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

معرّف التطبيق

ENTITY_ID

معرف الجدول (FORM)

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

{"rest_api_key":"API_KEY"}

الجواب: إرجاع جميع تقارير الجدول.

    
{"reports":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Report Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "entity_id"    : 'aEWQZdIXfahOqWvcvwrGTP',
 "app_id"  : 'ddIbpcNSncW5xcHxpdHCoW'
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Report Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "entity_id"       : 'RtWQZdIXfahOqWvcvwrGTP',
 "app_id"          : 'ddIbpcNSncW5xcHxpdHCoW'
} ]}
             

Making request (XML)
التنسيق

XML

الطريقة

GET

URL

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

محتوى الطلب: إرجاع جميع تقارير الجدول.

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

الجواب

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

الملفات

انظر رابط الملف

للحصول على رابط الملف ، احصل أولاً على قيم حقول السجل ويمكنك تنزيل الملف من الرابط https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME ، حيث تم تحميل FILE_NAME - اسم الملف الذي تم تنزيله في تجزئات من النوع PROPERTY_ID => VALUE ، RECORD_ID - معرف السجل ، PROPERTY_ID - معرف الحقل.

تنزيل الملفات

من أجل تحميل ملف إلى سجل ، عليك تقديم طلب POST إلى طريقة upload_file API مع رأس نوع محتوى متعدد الأجزاء / بيانات النموذج وبعد ذلك فقط يجب عليك إنشاء أو تحديث السجل الخاص بك. لذا فإن معرف السجل يجب أن يتم إنشاؤه قبل المكالمات. كما سيتعين عليك إنشاء رأس Multipart ، من فضلك ، اتبع مثال Ruby مع فئة MultipartPost أدناه. في المثال ستتعلم كيفية تحميل الملف في النموذج الفرعي أيضًا.
المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

property_id

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

dtype_id

يجب أن تعرف معرّف السجل. يمكن العثور على المعرّف بعد استلام جميع السجلات . عندما تعرف المعرّف ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Making request (JSON)
التنسيق

JSON

الطريقة

POST

URL

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

محتوى الطلب

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

الجواب

    Uploaded
             

إزالة الملفات

المعلمات
rest_api_key

مفتاح API الخاص بك

APP_ID

يجب أن تعرف معرف قاعدة البيانات التي تريد حذفها. يمكنك العثور على معرف بعد تلقي جميع قواعد البيانات . مع العلم بمعرف قاعدة البيانات ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/ID.json on /apps/aOWO_dVXHdHie1WeGFE8k2.json

property_id

يجب أن تعرف معرف الحقل. يمكنك العثور على رقم التعريف بعد تلقي جميع حقول النموذج . بمعرفة معرف الحقل ، تحتاج إلى استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/لكيانات/ENTITY_ID/properties/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

DTYPE_ID

يجب أن تعرف معرّف السجل. يمكن العثور على المعرّف بعد استلام جميع السجلات . عندما تعرف المعرّف ، يلزمك استبدال المعرّف في عنوان URL ، على سبيل المثال:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

SINGLE_FILE_NAME

اسم الملف

Making request (JSON)
التنسيق

JSON

الطريقة

GET

URL

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

محتوى الطلب

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

الجواب

    File removed

أمثلة
هذه هي واجهة برمجة تطبيقات REST الأساسية ويجب أن تكون كافية لإنشاء أشياء رائعة ومفيدة. ومع ذلك ، إذا كنت تريد شيئًا آخر ، على سبيل المثال ، المزيد من الطرق ، وما إلى ذلك ، يُرجى الاتصال لنا في أي وقت. يسعدنا دائمًا أن نسمع منك!