QuintaDB-REST-API

QuintaDB-REST-API Damit können Sie das Potenzial der in der QuintaDB-Datenbank gespeicherten Daten voll ausschöpfen. Mit dieser API können Sie mehr erreichen, als die QuintaDB-Schnittstelle derzeit bietet. Tatsächlich bieten wir Ihnen die Möglichkeit dazu Alles, was Sie mit den Daten benötigen. Sie können beispielsweise Ihre eigenen Skripte, Computeranwendungen und mobilen Anwendungen für verschiedene Plattformen wie iPhone/Android und andere erstellen. Und QuintaDB bleibt dort. wo Sie Ihre Daten speichern, verwalten und mit anderen verwenden.

Allgemeine Informationen zu API-Aufrufen

Alle Aufrufe müssen einen REST API-Schlüssel enthalten, den Sie durch Klicken auf die Schaltfläche "API-Schlüssel" am Anfang der Seite finden.
Serverantwort kann je nach Anforderung im Format JSON oder XML empfangen werden.
Unten zeigen wir Tabellen mit Serverantworten für jede Anfrage. URLs werden als /apps.json angezeigt. Dies bedeutet, dass Sie die Methode mit dem Link https://QuintaDB.ru /apps.json in Ihrem Programm aufrufen müssen. Bitte beachten Sie, dass alle Anrufe das Protokoll https verwenden müssen und Sie das SSL-Zertifikat des Servers auf Gültigkeit überprüfen müssen.

Datenbank

Solche Datenbankattribute können mit der REST-API abgerufen werden.

Die eindeutige Datenbankkennung

name

Name

created_at

Zeitpunkt, zu dem die Datenbank erstellt wurde

updated_at

Zeitpunkt, zu dem die Datenbank aktualisiert wurde

Alle Datenbanken anzeigen

Parameter

rest_api_key

Ihr API-Schlüssel

page

Datenbanken werden 20 pro Seite angezeigt, sodass die Seite 1..5 sein kann

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps.json

Inhalt der Anfrage

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

Antwort: 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
} ]}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps.xml

Inhalt der Anfrage

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

Antwort: 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>

Ruft die Datenbank für die ID ab

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Sie müssen die ID der Datenbank kennen, die Sie löschen möchten. Sie können die ID nach Erhalt aller Datenbanken finden. Wenn Sie die Datenbank-ID kennen, müssen Sie die ID in der URL ersetzen, zum Beispiel:/apps/ID.json auf /apps/aOWO_dVXHdHie1WeGFE8k2.json

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps/APP_ID.json

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort: Gibt Informationen zur Datenbank zurück

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps/APP_ID.xml

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Ruft die Datenbank nach Namen ab

Parameter

rest_api_key

Ihr API-Schlüssel

Name

Sie müssen den Datenbanknamen kennen. Sie können den Namen abrufen, indem Sie die Abfrage ausführen. Alle Datenbanken abrufen .

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps/search.json

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps/search.xml

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Aktualisieren Sie die Datenbank

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

name

Neuer Datenbankname

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

PUT

URL

/apps/APP_ID.json

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

PUT

URL

/apps/APP_ID.xml

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Löscht die Datenbank

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

DELETE

URL

/apps/APP_ID.json

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

DELETE

URL

/apps/APP_ID.xml

Inhalt der Anfrage

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

Antwort

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

Erstellen Sie ein App

Parameter

rest_api_key

Ihr API-Schlüssel

database_name

Der Name der Datenbank

form_name

Der Name des Formulars. Sie können keine Datenbank ohne Formular erstellen, da eine Datenbank ohne Formular keinen Sinn hat.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/apps.json

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

/apps.xml

Inhalt der Anfrage

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

Antwort: Gibt Informationen zur Datenbank zurück

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

Im Fehlerfall. Sie erhalten eine Fehlermeldung, d. h. 'Ein solcher App-Name existiert bereits'.

Formular

Diese -Formattribute können von der REST-API abgerufen werden.

Die eindeutige Kennung für das Formular

name

Name

desc

Beschreibung

post_action

Liste der Empfänger von E-Mail-Nachrichten

Holen Sie sich alle Formulare

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps/APP_ID/entities.json

Inhalt der Anfrage

{rest_api_key":"API_KEY"}

Antwort: Ruft alle Datenbankformulare ab

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps/APP_ID/entities.xml

Inhalt der Anfrage

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

Antwort: Ruft alle Datenbankformulare ab

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

Gibt Informationen zu Formularen zurück

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Sie müssen die Formular-ID kennen. Sie finden ENTITY_ID nach Erhalt aller Formulare . Wenn Sie die Formular-ID kennen, müssen Sie ENTITY_ID in der URL auflisten, zum Beispiel:/apps/APP_ID/entity. json on /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps/APP_ID/entities/ID.json

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort: 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
      }
}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps/APP_ID/entities/ID.xml

Inhalt der Anfrage

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

Antwort: 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>

Ruft das Formular nach Name ab

Parameter

rest_api_key

Ihr API-Schlüssel

database_name

Sie müssen den Datenbanknamen kennen. Sie können den Namen abrufen, indem Sie die Abfrage ausführen. Alle Datenbanken abrufen .

form_name

Sie müssen den Namen des Formulars kennen. Sie können ihn erhalten, indem Sie Alle Formulare abrufen verbinden.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps/search/entities/search.json

Inhalt der Anfrage

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

Antwort: 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
      }
}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps/search/entities/search.xml

Inhalt der Anfrage

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

Antwort: 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>

Aktualisieren Sie das Formular

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

name

Neuer Formularname. Alle verfügbaren Optionen hier anzeigen

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

PUT

URL

/apps/APP_ID/entities/ID.json

Inhalt der Anfrage

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

Antwort: 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
     }
}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

PUT

URL

/apps/APP_ID/entities/ID.xml

Inhalt der Anfrage

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

Antwort: 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>

Löscht das Formular

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Sie müssen die ID des Formulars kennen, das Sie löschen möchten. Sie können die ID nach Erhalt aller Formulare finden . Wenn Sie die Formular-ID kennen, müssen Sie die ID in der URL ersetzen, zum Beispiel:/apps/APP_ID /entities/ID.json on /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

DELETE

URL

/apps/APP_ID/entities/ID.json

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

DELETE

URL

/apps/APP_ID/entities/ID.xml

Inhalt der Anfrage

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

Antwort

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

Erstellen Sie ein Formular

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

name

Formularname

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/apps/APP_ID/entities.json

Inhalt der Anfrage

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

Antwort: 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
      }
}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

/apps/APP_ID/entities.xml

Inhalt der Anfrage

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

Antwort: 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>

Feld

Solche Feldattribute können von der REST-API abgerufen werden.

Die eindeutige Kennung des Feldes

entity_id

Formularfeld-ID

name

Name

type_name

Feldtyp. Kann sein: 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

Formularfelder abrufen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

{rest_api_key":"API_KEY"}

Antwort: Ruft alle Formularfelder ab

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort: Ruft alle Formularfelder ab

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

Holen Sie sich ein Feld

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

Sie müssen die ID des Felds kennen. Sie können die ID nach Erhalt aller Formularfelder finden. Wenn Sie die Feld-ID kennen, müssen Sie die ID in der URL ersetzen, zum Beispiel:/apps/APP_ID/entity/ENTITY_ID/properties/ID.json unter /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

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

Ruft ein Feld mit Name ab

Parameter

rest_api_key

Ihr API-Schlüssel

database_name

Sie müssen den Datenbanknamen kennen. Sie können den Namen abrufen, indem Sie die Abfrage ausführen. Alle Datenbanken abrufen .

form_name

Sie müssen den Namen des Formulars kennen. Sie können ihn erhalten, indem Sie Alle Formulare abrufen verbinden.

field_name

Sie müssen den Namen des Feldes kennen. Sie können ihn erhalten, indem Sie Alle Formularfelder abrufen verbinden.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

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

Aktion ausführen

Parameter

rest_api_key

Ihr API-Schlüssel

DTYPE_ID

Sie müssen Ihre Datensatzkennung kennen. Sie können die ID mit dem Fetch All Records-Aufruf finden.

ACTION_PROPERTY_ID

Sie müssen Ihre Feldkennung kennen. Sie können die ID mit dem Aufruf Alle Formularfelder abrufen finden.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Inhalt der Anfrage

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

Antwort

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

Aktionen ausführen

Parameter

rest_api_key

Ihr API-Schlüssel

ACTION_PROPERTY_ID

Sie müssen Ihre Feldkennung kennen. Sie können die ID mit dem Aufruf Alle Formularfelder abrufen finden.

dtype_ids

Sie müssen die IDs Ihrer Datensätze kennen. Sie können IDs mit dem Aufruf Fetch All Records finden.

json_dtype_ids

Sie müssen die IDs Ihrer Datensätze kennen. Sie können IDs mit dem Aufruf Fetch All Records finden.

run_by_all_table_or_report

Der folgende Parameter ist verfügbar, um alle Aktionen in der Tabelle oder im Bericht auszuführen: run_by_all_table_or_report=true.

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Inhalt der Anfrage

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

Antwort

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

Aktualisiere das Feld

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

name

Neuer Feldname. Alle verfügbaren Attribute finden Sie hier

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

PUT

URL

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

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

PUT

URL

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

Inhalt der Anfrage

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

Antwort

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

Feld löschen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

DELETE

URL

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

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

DELETE

URL

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

Inhalt der Anfrage

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

Antwort

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

Erstellt ein Feld

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

name

Feldname

type_name

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

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

Inhalt der Anfrage

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

Antwort: 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
 }
}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

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

Inhalt der Anfrage

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

Antwort: 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>

Liefert die Summen in der Spalte

Parameter

rest_api_key

Ihr API-Schlüssel

ENTITY_ID

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/search/sum/ENTITY_ID/ID.json

Inhalt der Anfrage

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

Antwort

    
{total: 3}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/search/sum/ENTITY_ID/ID.xml

Inhalt der Anfrage

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

Antwort

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

Aufnahme

Solche -Aufzeichnungsattribute können von der REST-API abgerufen werden.

Die eindeutige Kennung für den Datensatz.

app_id

App-ID

entity_id

Formular-ID aufzeichnen.

values

Hash-Schreibwerte. Dabei ist der Schlüssel die Feld-ID und der Wert der Feldwert.

json_values

Werte-Hash aufzeichnen. Wobei Schlüssel Feld-ID und Wert dieser Feldwert ist. Analog zu values_hash, aber im JSON-Format

rel_values

Hash des Beziehungswerts des Datensatzes. Dabei ist der Schlüssel die Feld-ID und der Wert die ID des zugeordneten Datensatzes.

Datensätze abrufen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

page

Seitenzahl mit Datensätzen. Von 1 bis Anzahl der Datensätze / per_page .

name_value

Verwenden Sie den Parameter, um Datensätze der folgenden Form abzurufen: "Feldname": "Wert", "Feld-ID": "Feldname"

fetch_all

Für Inhaber von kostenpflichtigen Konten steht der folgende Parameter zur Verfügung: fetch_all=true.
Um eine bestimmte Anzahl von Beiträgen zu erhalten, verwenden Sie den Parameter per_page.
Einschränkungen der maximalen Anzahl von Einträgen per_page für verschiedene Pläne:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Anforderungstext
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

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

Holen Sie sich einen Datensatz

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Sie müssen die Datensatz-ID kennen. Die ID kann gefunden werden, nachdem Sie alle Datensätze erhalten haben . Wenn Sie die ID kennen, müssen Sie die ID in der URL ersetzen, zum Beispiel:/apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Verwenden Sie den Parameter, um Datensätze der folgenden Form abzurufen: "Feldname": "Wert", "Feld-ID": "Feldname"

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

/apps/APP_ID/dtypes/ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

/apps/APP_ID/dtypes/ID.xml

Inhalt der Anfrage

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

Antwort

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

Aktualisiert den Datensatz

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

values

Hash-Datensatzwerte, wobei der Schlüssel die Formularfeld-ID ist

json_values

If you using jQuery, Ruby or another programming language then, please, use 'values' parameter to send encoding parameters. However, if your framework doesn't allow this you can send record values as JSON string, but in this case specify your parameter name as 'json_values'. And your JSON values string will looks like this: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}"

subforms_values / subforms_json_values

To create or update subforms, in the same way, use 'subforms_values' or 'json_subforms_values'.
With a format below:
"{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2", subform1_field2_id: "aaa"}, subform1_record2_id: {subform1_field1_id: "3", subform1_field2_id: "bb"}}, property2_id: {entity_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4", subform2_field2_id: "bb"}, subform2_record2_id: {subform2_field1_id: "5", subform2_field2_id: "dd"}}}" .

Where property1_id and property2_id - this is Fields ID's with a Subform type in the main table.
subform1_id, subform2_id - Forms ID's, which was set in property1_id and property2_id settings.
subform1_record1_id и subform1_record2_id - this is new or existent subform records ID's.
subform1_field1_id, subform1_field2_id - fields ID's in the form subform1_id.
subform2_field1_id, subform2_field2_id - fields ID's in the form subform2_id.

All ID's - it's a 22 characters URL-save base64 code, you can get them from other API calls or create for new subform records.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

PUT

URL

/apps/APP_ID/dtypes/ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Inhalt der Anfrage

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

Antwort

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

Aktualisieren Sie mehrere Datensätze

Parameter

rest_api_key

Ihr API-Schlüssel

confirm_action

Der folgende Parameter ist erforderlich, um eine Aktualisierung in einer Tabelle oder einem Bericht auszuführen: confirm_action: update.

ENTITY_ID

Sie müssen die Formularkennung Ihres Feldes kennen, um die Feldeinstellungen zu aktualisieren. Sie können ENTITY_ID mit dem Fetch All Forms-Aufruf finden.

APP_ID

Sie müssen Ihre Datenbankkennung kennen, um Datenbankinformationen abzurufen. Sie können die ID mit dem Aufruf Fetch All Databases finden.

dtype_ids

Sie müssen die IDs Ihrer Datensätze kennen. Sie können IDs mit dem Aufruf Fetch All Records finden.

json_dtype_ids

Sie müssen die IDs Ihrer Datensätze kennen. Sie können IDs mit dem Aufruf Fetch All Records finden.

update_id

Sie müssen Ihre Feldkennung kennen. Sie können die ID mit dem Aufruf Alle Formularfelder abrufen finden.

update_term

Neuer Wert für Datensätze

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Inhalt der Anfrage


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

Antwort

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

Alle Datensätze aktualisieren

Parameter

rest_api_key

Ihr API-Schlüssel

confirm_action

Der folgende Parameter ist erforderlich, um die Aktualisierung aller Datensätze in der Tabelle oder im Bericht auszuführen: confirm_action: update_all.

ENTITY_ID

Sie müssen die Formularkennung Ihres Feldes kennen, um die Feldeinstellungen zu aktualisieren. Sie können ENTITY_ID mit dem Fetch All Forms-Aufruf finden.

APP_ID

Sie müssen Ihre Datenbankkennung kennen, um Datenbankinformationen abzurufen. Sie können die ID mit dem Aufruf Fetch All Databases finden.

update_id

Sie müssen Ihre Feldkennung kennen. Sie können die ID mit dem Aufruf Alle Formularfelder abrufen finden.

update_term

Neuer Wert für Datensätze

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Inhalt der Anfrage


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

Antwort

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

Zellendaten aktualisieren

Parameter

rest_api_key

Ihr API-Schlüssel

PROPERTY_ID

DTYPE_ID

val

Der neue Wert der Datenzelle

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Inhalt der Anfrage

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

Antwort

    
{"new_value": "John Smith"}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Inhalt der Anfrage

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

Antwort

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

Datensatz löschen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Inhalt der Anfrage

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

Antwort

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

Mehrere Datensätze löschen

Parameter

rest_api_key

Ihr API-Schlüssel

ENTITY_ID

Sie müssen die Formularkennung Ihres Feldes kennen, um die Feldeinstellungen zu aktualisieren. Sie können ENTITY_ID mit dem Fetch All Forms-Aufruf finden.

APP_ID

Sie müssen Ihre Datenbankkennung kennen, um Datenbankinformationen abzurufen. Sie können die ID mit dem Aufruf Fetch All Databases finden.

dtype_ids

Sie müssen die IDs Ihrer Datensätze kennen. Sie können IDs mit dem Aufruf Fetch All Records finden.

json_dtype_ids

Sie müssen die IDs Ihrer Datensätze kennen. Sie können IDs mit dem Aufruf Fetch All Records finden. (Nicht unbedingt)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Inhalt der Anfrage


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

Antwort

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

Alle löschen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

Sie müssen Ihre Datenbankkennung kennen, um Datenbankinformationen abzurufen. Sie können die ID mit dem Aufruf Fetch All Databases finden.

ENTITY_ID

Sie müssen die Formularkennung Ihres Feldes kennen, um die Feldeinstellungen zu aktualisieren. Sie können ENTITY_ID mit dem Fetch All Forms-Aufruf finden.

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Inhalt der Anfrage

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

Antwort

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Inhalt der Anfrage


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

Antwort

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

Neuer Datensatz

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

Wenn Sie Ihre persönliche ID verwenden müssen, können Sie UUID (eindeutige Kennung) generieren. 22 Zeichen lang URL-sicher base64 Zum Beispiel in Ruby . Als nächstes müssen Sie es an den Hash 'values' übergeben, zum Beispiel: values => {'id' => ID}, ändern Sie zu: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, andernfalls generiert das System eine eindeutige Kennung für Sie.

values / json_values

subforms_values / subforms_json_values

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/apps/APP_ID/dtypes.json

Inhalt der Anfrage

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

Antwort: 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"
}
}

Wir stellen eine Abfrage (XML)

Format

XML

Methode

POST

URL

/apps/APP_ID/dtypes.xml

Inhalt der Anfrage

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

Antwort: 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>

Suche

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

ENTITY_ID

view

Um Datensätze abzurufen, müssen Sie die Berichts-ID kennen. (Nicht unbedingt)

search

Möchten Sie einen Film auf dem Tisch? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - Feldkennung, nach der wir suchen ( -ALL - - für einen Poke in allen Spalten),
SEARCH_TERM - was bedeutet, yake shukaєmo,
SEARCH_CRITERIA - Kriterium für eine Nachricht, vielleicht eines davon:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Für reguläre Zahlen und Daten : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Für ein Date für ungefähr eine Stunde : 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.

Systemspalten : added_by, created_at, updated_at, ip.

Wenn Sie in mehreren Spalten mit einem einheitlichen "UND" -Kriterium suchen möchten, sollten diese Kriterien in einem Array platziert werden. wenn "ODER", dann in ein separates, zum Beispiel:
[[{"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"}]]

Die Suchformel wird sein: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Die Anzahl der Datensätze in den Suchergebnissen beträgt maximal 200.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

/search/APP_ID.json

Inhalt der Anfrage

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

Antwort

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

Beziehung

So verknüpfen Sie Datensätze:

Um eine Beziehung zwischen Datensätzen herzustellen, müssen Sie einen separaten Hash in der Abfrage CREATE OR UPDATE record senden.

curl -H 'Inhaltstyp: 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 muss Sie müssen die Form 'rel' => {rel_id => RECORD_ID} oder 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} haben, wenn Sie eine many-zu-many-Beziehung haben. Dabei ist RECORD_ID die ID des Datensatzes, in dem Sie den aktuellen kombinieren möchten Rekord. So erhalten Sie rel_id.

Parameter

rest_api_key

Ihr API-Schlüssel

PROPERTY_ID

ENTITY_ID

Sie müssen die Formular-ID kennen. Sie finden ENTITY_ID nach Erhalt aller Formulare . Wenn Sie die Formular-ID kennen, müssen Sie ENTITY_ID in der URL ersetzen, z. B. /apps/APP_ID/entities/ENTITY_ID/properties.json durch/apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

Berichte

Auf solche Berichtsattribute kann über die REST-API zugegriffen werden.

name

Name

Berichte abrufen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

App-ID

ENTITY_ID

Tabellen-ID (FORMULAR)

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

{"rest_api_key":"API_KEY"}

Antwort: Gibt alle Tabellenberichte zurück.

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

Wir stellen eine Abfrage (XML)

Format

XML

Methode

GET

URL

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

Inhalt der Anfrage: Gibt alle Tabellenberichte zurück.

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

Antwort

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

Dateien

Siehe Dateilink

Um den Link zur Datei zu erhalten, rufen Sie zuerst die Datensatzfeldwerte ab und Sie können die Datei über den Link https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME herunterladen, wobei FILE_NAME - der Name der heruntergeladenen Datei, erhalten in Hashes vom Typ PROPERTY_ID => VALUE, RECORD_ID - Datensatz-ID, PROPERTY_ID - Feld-ID.

Dateien herunterladen

Um eine Datei in einen Datensatz hochzuladen, müssen Sie eine POST-Anforderung an die API-Methode upload_file mit mehrteiligem / Formulardaten-Inhaltstyp-Header senden und erst danach müssen Sie Ihren Datensatz erstellen oder aktualisieren. Also die Datensatz-ID sollte vor den Aufrufen generiert werden. Außerdem müssen Sie den Multipart-Header generieren. Befolgen Sie dazu das Ruby-Beispiel mit der folgenden MultipartPost-Klasse. In diesem Beispiel erfahren Sie, wie Sie die Datei auch in das Unterformular hochladen.

Beispiel für Ruby

  
    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

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

property_id

dtype_id

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

POST

URL

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

Inhalt der Anfrage

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

Antwort

    Uploaded

Dateien entfernen

Parameter

rest_api_key

Ihr API-Schlüssel

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Dateiname

Wir stellen eine Abfrage (JSON)

Format

JSON

Methode

GET

URL

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

Inhalt der Anfrage

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

Antwort

    File removed

Beispiele

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Creating proper call with Method: GET/POST/PUT/DELETE
  req = case method
          when "get"
            Net::HTTP::Get.new(uri.path) 
          when "post" 
            Net::HTTP::Post.new(uri.path)
          when "put"
            Net::HTTP::Put.new(uri.path)
          when "delete"
            Net::HTTP::Delete.new(uri.path)
        end

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

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

  # Alle HTTPS-Verbindungen und SSL-Zertifikate werden überprüft

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# Wir stellen eine Abfrage
  https.start do |htt| 
    htt.request(req)
  end
end


# Denken Sie daran, API_KEY festzulegen
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Die Antwort ist verfügbar response.body
puts response.body

Dies ist die grundlegende REST-API und muss ausreichen, um coole und nützliche Dinge zu erstellen. Wenn Sie jedoch etwas anderes möchten, z. B. mehr Methoden usw., wenden Sie sich bitte an uns jederzeit. Wir freuen uns immer von Ihnen zu hören!

QuintaDB-REST-API

Allgemeine Informationen zu API-Aufrufen

Datenbank

Formular

Feld

Aufnahme

Berichte

Dateien

Wir verwenden Cookies, um die erforderlichen Funktionen der Website bereitzustellen. Durch Klicken auf "Akzeptieren" stimmen Sie der Verwendung von Cookies auf unserer Website zu.