QuintaDB REST API

QuintaDB REST API Ontworpen om u het potentieel van de gegevens die onen opgeslagen in de QuintaDB-database volledig te benutten. Door deze API te gebruiken, kunt u meer bereiken dan de QuintaDB-interface die momenteel wordt aangeboden. We geven u zelfs de mogelijkheid om dit te doen alles wat u nodig heeft met de gegevens. U kunt bijvoorbeeld uw eigen scripts, computertoepassingen en mobiele toepassingen maken voor verschillende platforms zoals iPhone/Android en other. En QuintaDB blijft daar, waar u uw gegevens opslaat, beheert en gebruikt met othern.

Algemene informatie over API-aanroepen

Alle oproepen moeten een REST API-sleutel bevatten, die u kunt vinden door op de knop "API-sleutels" aan het begin van de pagina te klikken.
Serverreactie kan worden ontvangen in JSON of XML -indeling, afhankelijk van uw verzoek.
Hieronder tonen we tabellen met serverreacties voor elk verzoek. URL`s worden weergegeven als /apps.json , wat betekent dat u de methode met de link https://QuintaDB.ru /apps.json in uw programma moet aanroepen. Houd er rekening mee dat alle oproepen het https -protocol moeten gebruiken en dat u het SSL-certificaat van de server op geldigheid moet controleren.

Database

Dergelijke databaseattributen kunnen worden verkregen met de REST API.

de unieke database-ID

name

Naam

created_at

Tijdstip waarop de database is gemaakt

updated_at

Tijdstip waarop de database is bijgewerkt

bekijk alle databases

Parameters

rest_api_key

uw API-sleutel

page

Databases worden 20 per pagina weergegeven, dus pagina kan 1..5 onen

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps.json

inhoud van het verzoek

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

Antwoord: geeft alle databases terug

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

Formaat

XML

methode

GET

URL

/apps.xml

inhoud van het verzoek

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

Antwoord: geeft alle databases terug

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

Haal de database op voor ID

Parameters

rest_api_key

uw API-sleutel

APP_ID

U moet de ID weten van de database die u wilt verwijderen. U kunt de ID vinden nadat u alle databases heeft ontvangen . Als u de ID van de database kent, moet u de ID in de URL vervangen, bijvoorbeeld:/apps/ID.json op /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps/APP_ID.json

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord: geeft informatie over de database

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

Formaat

XML

methode

GET

URL

/apps/APP_ID.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

Haal de database op naam

Parameters

rest_api_key

uw API-sleutel

Naam

U moet de databasenaam kennen. U kunt de naam krijgen door de query Alle databases ophalen .. uit te voeren.

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps/search.json

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

Formaat

XML

methode

GET

URL

/apps/search.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

update de database

Parameters

rest_api_key

uw API-sleutel

APP_ID

name

Nieuwe databasenaam

Making request (JSON)

Formaat

JSON

methode

PUT

URL

/apps/APP_ID.json

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

Formaat

XML

methode

PUT

URL

/apps/APP_ID.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

Verwijder de database

Parameters

rest_api_key

uw API-sleutel

APP_ID

Making request (JSON)

Formaat

JSON

methode

DELETE

URL

/apps/APP_ID.json

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord

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

Formaat

XML

methode

DELETE

URL

/apps/APP_ID.xml

inhoud van het verzoek

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

Antwoord

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

na het verwijderen van de database, retourneert deze methode alle resterende databases.

Maak een app

Parameters

rest_api_key

uw API-sleutel

database_name

de naam van de database

form_name

De naam van het formulier. U kunt gone database maken zonder een formulier omdat er gone zin is in een database zonder een formulier.

Making request (JSON)

Formaat

JSON

methode

POST

URL

/apps.json

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

Formaat

XML

methode

POST

URL

/apps.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over de database

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

In het geval van een fout. U krijgt een foutmelding, d.w.z. 'Dergelijke app-naam bestaat al'.

Vorm

Deze vormkenmerken kunnen worden verkregen door de REST API.

de unieke identificatie voor het formulier

name

Naam

desc

Beschrijving

post_action

lijst met ontvangers van e-mailberichten

Verkrijg alle formulieren

Parameters

rest_api_key

uw API-sleutel

APP_ID

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps/APP_ID/entities.json

inhoud van het verzoek

{rest_api_key":"API_KEY"}

Antwoord: Verkrijg alle databaseformulieren

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

Formaat

XML

methode

GET

URL

/apps/APP_ID/entities.xml

inhoud van het verzoek

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

Antwoord: Verkrijg alle databaseformulieren

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

Download het formulier in ID

Parameters

rest_api_key

uw API-sleutel

APP_ID

Je moet de formulier-ID kennen. Je kunt ENTITY_ID vinden nadat je alle formulieren hebt ontvangen . Als je de formulier-ID kent, moet je ENTITY_ID in de URL vermelden, bijvoorbeeld:/apps/APP_ID/entiteiten. json op /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps/APP_ID/entities/ID.json

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord: geeft informatie over formulieren

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

Formaat

XML

methode

GET

URL

/apps/APP_ID/entities/ID.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Verkrijg het formulier op naam

Parameters

rest_api_key

uw API-sleutel

database_name

U moet de databasenaam kennen. U kunt de naam krijgen door de query Alle databases ophalen .. uit te voeren.

form_name

Je moet de naam van het formulier weten. Je kunt het verkrijgen door alle formulieren te koppelen.

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps/search/entities/search.json

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Formaat

XML

methode

GET

URL

/apps/search/entities/search.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

werk het formulier bij

Parameters

rest_api_key

uw API-sleutel

APP_ID

name

Nieuwe formuliernaam. Bekijk alle beschikbare opties hier

Making request (JSON)

Formaat

JSON

methode

PUT

URL

/apps/APP_ID/entities/ID.json

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Formaat

XML

methode

PUT

URL

/apps/APP_ID/entities/ID.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

het formulier verwijderen

Parameters

rest_api_key

uw API-sleutel

APP_ID

U moet de ID kennen van het formulier dat u wilt verwijderen. U kunt de ID vinden nadat u alle formulieren heeft ontvangen . Als u de formulier-ID kent, moet u de ID in de URL vervangen, bijvoorbeeld:/apps/APP_ID /entities/ID.json op /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)

Formaat

JSON

methode

DELETE

URL

/apps/APP_ID/entities/ID.json

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord

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

Formaat

XML

methode

DELETE

URL

/apps/APP_ID/entities/ID.xml

inhoud van het verzoek

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

Antwoord

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

Maak een formulier

Parameters

rest_api_key

uw API-sleutel

APP_ID

name

Formuliernaam

Making request (JSON)

Formaat

JSON

methode

POST

URL

/apps/APP_ID/entities.json

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Formaat

XML

methode

POST

URL

/apps/APP_ID/entities.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Veld

Dergelijke veldattributen kunnen worden verkregen door de REST API.

de unieke identificatie van het veld

entity_id

formulierveld-ID

name

Naam

type_name

veldtype. Kan onen: 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

Krijg formuliervelden

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

{rest_api_key":"API_KEY"}

Antwoord: Verkrijg alle formuliervelden

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

Formaat

XML

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord: Verkrijg alle formuliervelden

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

Verkrijg een veld

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

Je moet de ID van het veld weten. Je kunt de ID vinden nadat je alle formuliervelden hebt ontvangen . Als je de veld-ID kent, moet je de ID in de URL vervangen, bijvoorbeeld:/apps/APP_ID/entiteiten/ENTITY_ID/properties/ID.json op /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord

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

Formaat

XML

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

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

Verkrijg een veld met Naam

Parameters

rest_api_key

uw API-sleutel

database_name

U moet de databasenaam kennen. U kunt de naam krijgen door de query Alle databases ophalen .. uit te voeren.

form_name

Je moet de naam van het formulier weten. Je kunt het verkrijgen door alle formulieren te koppelen.

field_name

U moet de naam van het veld weten. U kunt deze verkrijgen door alle formuliervelden te koppelen.

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

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

Formaat

XML

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

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

Actie uitvoeren

Parameters

rest_api_key

uw API-sleutel

DTYPE_ID

Je moet je record-ID weten. Je kunt de ID vinden met behulp van Fetch All Records call.

ACTION_PROPERTY_ID

U moet uw veldidentificatie kennen. U kunt de ID vinden met behulp van Fetch All Form Fields call.

Making request (JSON)

Formaat

JSON

methode

GET

URL

/actions/ACTION_PROPERTY_ID.json

inhoud van het verzoek

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

Antwoord

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

Making request (XML)

Formaat

XML

methode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

inhoud van het verzoek

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

Antwoord

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

Voer acties uit

Parameters

rest_api_key

uw API-sleutel

ACTION_PROPERTY_ID

U moet uw veldidentificatie kennen. U kunt de ID vinden met behulp van Fetch All Form Fields call.

dtype_ids

Je moet de ID's van je records kennen. Je kunt de ID vinden met de Fetch All Records-oproep.

json_dtype_ids

Je moet de ID's van je records kennen. Je kunt de ID vinden met de Fetch All Records-oproep.

run_by_all_table_or_report

De volgende parameter is beschikbaar om alle acties in tabel of rapport uit te voeren: run_by_all_table_or_report=true.

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

Making request (JSON)

Formaat

JSON

methode

GET

URL

/actions/ACTION_PROPERTY_ID.json

inhoud van het verzoek

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

Antwoord

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

Making request (XML)

Formaat

XML

methode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

inhoud van het verzoek

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

Antwoord

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

werk het veld bij

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

name

Nieuwe veldnaam. Alle beschikbare attributen onen hier te vinden

Making request (JSON)

Formaat

JSON

methode

PUT

URL

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

inhoud van het verzoek

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

Antwoord

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

Formaat

XML

methode

PUT

URL

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

inhoud van het verzoek

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

Antwoord

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

veld verwijderen

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

Making request (JSON)

Formaat

JSON

methode

DELETE

URL

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

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord

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

Formaat

XML

methode

DELETE

URL

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

inhoud van het verzoek

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

Antwoord

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

Maak een veld

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

name

Veldnaam

type_name

Making request (JSON)

Formaat

JSON

methode

POST

URL

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

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Formaat

XML

methode

POST

URL

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

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Verkrijg de totalen in de kolom

Parameters

rest_api_key

uw API-sleutel

ENTITY_ID

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

Making request (JSON)

Formaat

JSON

methode

GET

URL

/search/sum/ENTITY_ID/ID.json

inhoud van het verzoek

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

Antwoord

    
{total: 3}

Making request (XML)

Formaat

XML

methode

GET

URL

/search/sum/ENTITY_ID/ID.xml

inhoud van het verzoek

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

Antwoord

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

Record

Dergelijke opnamekenmerken kunnen worden verkregen door de REST API.

de unieke identificatie voor het record.

app_id

app-ID

entity_id

Formulier-ID vastleggen.

values

Hash-schrijfwaarden. Waar de sleutel de veld-ID is en de waarde de veldwaarde is.

json_values

Record waarden hash. Waar de sleutel field id is en waarde is deze veldwaarde. Analoog van values_hash maar in JSON-formaat

rel_values

Hash van de relatiewaarde van het record. Waarbij de sleutel de veld-ID is en de waarde het ID van het gekoppelde record.

Haal records op

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

page

Paginanummer met records. Van 1 tot aantal records/ per_pagina .

name_value

Gebruik de parameter om records op te halen met de vorm: "field name": "value", "field id": "field name"

fetch_all

Voor eigenaren van betaalde accounts is de volgende parameter beschikbaar: fetch_all=true.
Gebruik de parameter per_page om een specifiek aantal berichten te krijgen.
Beperkingen op het maximum aantal inzendingen per_page voor verschillende abonnementen:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

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

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

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

Formaat

XML

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

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

Haal een record op

Parameters

rest_api_key

uw API-sleutel

APP_ID

Je moet de record-ID kennen. De ID kan worden gevonden nadat je alle records hebt ontvangen . Als je de ID kent, moet je de ID in de URL vervangen, bijvoorbeeld:/apps/APP_ID/dtypes/ID. json op /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Gebruik de parameter om records op te halen met de vorm: "field name": "value", "field id": "field name"

Making request (JSON)

Formaat

JSON

methode

GET

URL

/apps/APP_ID/dtypes/ID.json

inhoud van het verzoek

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

Antwoord

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

Formaat

XML

methode

GET

URL

/apps/APP_ID/dtypes/ID.xml

inhoud van het verzoek

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

Antwoord

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

werk het record bij

Parameters

rest_api_key

uw API-sleutel

APP_ID

values

Hash-recordwaarden, waarbij de sleutel de formulierveld-ID is

json_values

Als je jQuery, Ruby of een other programmeertaal gebruikt, voer dan de recordwaarden in als de gecodeerde hash in de parameter 'waarden'. Maar als je framework je dit niet toestaat, kun je de recordwaarden, JSON, bijvoorbeeld verzenden: " {"aNW4nkW5bdUjldO8oKuSku ": "2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". Gebruik dan de parameternaam 'json_values'.

subforms_values / subforms_json_values

Gebruik voor het maken of bijwerken van subformulieren op dezelfde manier de 'subforms_values' of 'json_subforms_values'.
de volgende indeling:
"{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"}}} ".

Waar property1_id en property2_id de ID is van de subformuliervelden in de hoofdtabel.
subform1_id, subform2_id - De formulier-ID waarnaar de velden property1_id en property2_id verwijzen.
subform1_record1_id en subform1_record2_id - dit is de ID van de nieuwe of bestaande subformulierrecords.
subform1_field1_id, subform1_field2_id - ID van velden in het formulier subform1_id.
subform2_field1_id, subform2_field2_id - ID van de velden in het subform2_id-formulier.

Alle ID's onen URL-beveiligde base64-codes van 22 tekens, u kunt ze van other verbindings-API's halen of uw eigen maken voor nieuwe record-ID's.

Making request (JSON)

Formaat

JSON

methode

PUT

URL

/apps/APP_ID/dtypes/ID.json

inhoud van het verzoek

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

Antwoord

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

Formaat

XML

methode

PUT

URL

/apps/APP_ID/dtypes/ID.xml

inhoud van het verzoek

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

Antwoord

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

Update verschillende records

Parameters

rest_api_key

uw API-sleutel

confirm_action

De volgende parameter is vereist om update in tabel of rapport uit te voeren: confirm_action: update.

ENTITY_ID

Je moet de formulier-ID van je veld kennen om de veldinstellingen bij te werken. Je kunt ENTITY_ID vinden met de Fetch All Forms-aanroep.

APP_ID

Je moet je database-ID weten om database-informatie op te halen. Je kunt de ID vinden met de Fetch All Databases-aanroep.

dtype_ids

Je moet de ID's van je records kennen. Je kunt de ID vinden met de Fetch All Records-oproep.

json_dtype_ids

Je moet de ID's van je records kennen. Je kunt de ID vinden met de Fetch All Records-oproep.

update_id

U moet uw veldidentificatie kennen. U kunt de ID vinden met behulp van Fetch All Form Fields call.

update_term

Nieuwe waarde voor records

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

Making request (JSON)

Formaat

JSON

methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

inhoud van het verzoek

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

Antwoord

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

Making request (XML)

Formaat

XML

methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

inhoud van het verzoek


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

Antwoord

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

Alle records bijwerken

Parameters

rest_api_key

uw API-sleutel

confirm_action

De volgende parameter is vereist om alle records in tabel of rapport bij te werken: confirm_action: update_all.

ENTITY_ID

Je moet de formulier-ID van je veld kennen om de veldinstellingen bij te werken. Je kunt ENTITY_ID vinden met de Fetch All Forms-aanroep.

APP_ID

Je moet je database-ID weten om database-informatie op te halen. Je kunt de ID vinden met de Fetch All Databases-aanroep.

update_id

U moet uw veldidentificatie kennen. U kunt de ID vinden met behulp van Fetch All Form Fields call.

update_term

Nieuwe waarde voor records

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

Making request (JSON)

Formaat

JSON

methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

inhoud van het verzoek

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

Antwoord

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

Making request (XML)

Formaat

XML

methode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

inhoud van het verzoek


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

Antwoord

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

celgegevens bijwerken

Parameters

rest_api_key

uw API-sleutel

PROPERTY_ID

DTYPE_ID

val

De nieuwe waarde van de gegevenscel

Making request (JSON)

Formaat

JSON

methode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

inhoud van het verzoek

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

Antwoord

    
{"new_value": "John Smith"}

Making request (XML)

Formaat

XML

methode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

inhoud van het verzoek

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

Antwoord

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

record verwijderen

Parameters

rest_api_key

uw API-sleutel

APP_ID

Making request (JSON)

Formaat

JSON

methode

DELETE

URL

/apps/APP_ID/dtypes/ID.json

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord

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

Formaat

XML

methode

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

inhoud van het verzoek

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

Antwoord

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

Meerdere records verwijderen

Parameters

rest_api_key

uw API-sleutel

ENTITY_ID

Je moet de formulier-ID van je veld kennen om de veldinstellingen bij te werken. Je kunt ENTITY_ID vinden met de Fetch All Forms-aanroep.

APP_ID

Je moet je database-ID weten om database-informatie op te halen. Je kunt de ID vinden met de Fetch All Databases-aanroep.

dtype_ids

Je moet de ID's van je records kennen. Je kunt de ID vinden met de Fetch All Records-oproep.

json_dtype_ids

Je moet de ID's van je records kennen. Je kunt de ID vinden met de Fetch All Records-oproep. (Niet noodzakelijk)

Making request (JSON)

Formaat

JSON

methode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

inhoud van het verzoek

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

Antwoord

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

Making request (XML)

Formaat

XML

methode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

inhoud van het verzoek


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

Antwoord

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

Alles verwijderen

Parameters

rest_api_key

uw API-sleutel

APP_ID

Je moet je database-ID weten om database-informatie op te halen. Je kunt de ID vinden met de Fetch All Databases-aanroep.

ENTITY_ID

Je moet de formulier-ID van je veld kennen om de veldinstellingen bij te werken. Je kunt ENTITY_ID vinden met de Fetch All Forms-aanroep.

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

Making request (JSON)

Formaat

JSON

methode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

inhoud van het verzoek

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

Antwoord

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

Making request (XML)

Formaat

XML

methode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

inhoud van het verzoek


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

Antwoord

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

Nieuw record

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

Als u uw persoonlijke ID moet gebruiken, kunt u UUID (unieke ID) genereren 22 tekens lang URL-veilige base64 Bijvoorbeeld in Ruby . Vervolgens moet je het doorgeven aan de hash 'values', bijvoorbeeld: values => {'id' => ID}, verander in: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, anders zal het systeem een unieke identificatie voor je genereren.

values / json_values

subforms_values / subforms_json_values

Making request (JSON)

Formaat

JSON

methode

POST

URL

/apps/APP_ID/dtypes.json

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Formaat

XML

methode

POST

URL

/apps/APP_ID/dtypes.xml

inhoud van het verzoek

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

Antwoord: geeft informatie over formulieren

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

Zoek

Parameters

rest_api_key

uw API-sleutel

APP_ID

ENTITY_ID

view

Om records op te halen, moet u de rapport-ID kennen. (Niet noodzakelijk)

search

Wil je een filmpje op tafel? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - veld-ID waarmee we zoeken ( -ALL - - om alle kolommen te doorzoeken),
SEARCH_TERM - de waarde waarnaar we op zoek zijn,
SEARCH_CRITERIA - criterium voor een bericht, misschien een van hen:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Voor reguliere nummers en datums : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Voor een afspraakje van ongeveer een uur : 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.

Systeemkolommen : added_by, created_at, updated_at, ip.

Als u in meerdere kolommen wilt zoeken met een verenigend "EN" -criterium, dan moeten deze criteria in één array worden geplaatst, als "OF", dan in een aparte, bijvoorbeeld:
[[{"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"}]]

de zoekformule zal zijn: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Het aantal records in de zoekresultaten, het maximum is 200.

Making request (JSON)

Formaat

JSON

methode

POST

URL

/search/APP_ID.json

inhoud van het verzoek

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

Antwoord

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

Relatie

Hoe records koppelen:

Om een relatie tussen records tot stand te brengen, moet je een aparte hash sturen in de query CREATE OR UPDATE record.

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 moet in de vorm 'rel' => {rel_id => RECORD_ID} of 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} als je een many-op-many-relatie hebt. Waar RECORD_ID de ID is van het record waar je de huidige wilt combineren record. Hier is hoe je rel_id kunt krijgen.

Parameters

rest_api_key

uw API-sleutel

PROPERTY_ID

ENTITY_ID

U moet de formulier-ID kennen. U kunt ENTITY_ID vinden nadat u alle formulieren heeft ontvangen . Als u de formulier-ID kent, moet u ENTITY_ID in de URL vervangen, bijvoorbeeld /apps/APP_ID/entities/ENTITY_ID/properties.json door /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

rapporten

Dergelijke rapportattributen kunnen toegankelijk zijn via REST API.

name

Naam

ontvang rapporten

Parameters

rest_api_key

uw API-sleutel

APP_ID

app-ID

ENTITY_ID

Tabel (formulier) ID

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

{"rest_api_key":"API_KEY"}

Antwoord: retourneert alle tabelrapporten.

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

Formaat

XML

methode

GET

URL

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

inhoud van het verzoek: retourneert alle tabelrapporten.

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

Antwoord

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

Bestanden

Zie bestandslink

om de link naar het bestand te krijgen, moet u eerst de recordveldwaarden ophalen en u kunt het bestand downloaden via de link https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, waarbij FILE_NAME - de naam van het gedownloade bestand, verkregen in hashes van het type PROPERTY_ID => VALUE, RECORD_ID - record-ID, PROPERTY_ID - veld-ID.

bestanden downloaden

Om een bestand in een record te uploaden, moet je een POST-verzoek doen naar de upload_file API-methode met koptekst van het inhoudstype multipart / form-data en pas daarna moet je je record maken of bijwerken. Dus de record-ID moet vóór de aanroepen worden gegenereerd. En u moet ook de Multipart-header genereren, volg alstublieft het Ruby-voorbeeld met de MultipartPost-klasse hieronder. In het voorbeeld leert u ook hoe u het bestand naar het subformulier uploadt.

Voorbeeld op 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

Parameters

rest_api_key

uw API-sleutel

APP_ID

property_id

dtype_id

Making request (JSON)

Formaat

JSON

methode

POST

URL

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

inhoud van het verzoek

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

Antwoord

    Uploaded

Bestanden verwijderen

Parameters

rest_api_key

uw API-sleutel

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Bestandsnaam

Making request (JSON)

Formaat

JSON

methode

GET

URL

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

inhoud van het verzoek

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

Antwoord

    File removed

Voorbeelden

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

   # Converteer parameters naar JSON/XML en stel het inhoudstype in als application/json of application/xml   Let op de indeling van de XML-parameter, waarin het belangrijkste element api_call_params  is 
  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
	# Stel het inhoudstype in
  req["Content-Type"] = "application/#{format}"

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

  # Alle HTTPS-verbindingen en SSL-certificaten worden gecontroleerd

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


# vergeet niet om de API_KEY in te stellen
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Antwoord is beschikbaar response.body
puts response.body

Dit is de standaard REST API en het moet genoeg onen om coole en nuttige dingen te maken. Als je echter iets anders wilt, bijvoorbeeld meer methoden, enz. Neem dan contact op ons op elk gewenst moment. We vinden het altijd leuk om van je te horen!

QuintaDB REST API

Algemene informatie over API-aanroepen

Database

Vorm

Veld

Record

rapporten

Bestanden

We gebruiken cookies om de noodzakelijke functionaliteit van de website te bieden. Door op "Accepteren" te klikken, gaat u akkoord met het gebruik van cookies op onze website.