API REST QuintaDB

API REST QuintaDB Progettato per permetterti di sfruttare appieno il potenziale dei dati archiviati nel database QuintaDB. Usando questa API, puoi ottenere più di quanto attualmente offra l'interfaccia QuintaDB. In effetti, ti offriamo l'opportunità di farlo tutto ciò di cui hai bisogno con i dati. Ad esempio, puoi creare script, applicazioni per computer e applicazioni mobili personalizzati per varie piattaforme come iPhone / Android e altri. QuintaDB rimarrà lì, dove memorizzi, gestisci e usi i tuoi dati con altri.

Informazioni generali sulle chiamate API

Tutte le chiamate devono contenere una chiave API REST, che può essere trovata facendo clic sul pulsante "chiavi API" all`inizio della pagina.
La risposta del server può essere ricevuta in formato JSON o XML , a seconda della richiesta.
Di seguito mostriamo tabelle con le risposte del server per ogni richiesta. Gli URL verranno visualizzati come /apps.json , il che significa che devi chiamare il metodo con il link https://QuintaDB.ru /apps.json nel tuo programma. Tieni presente che tutte le chiamate devono utilizzare il protocollo https e devi verificare la validità del certificato SSL del server.

Database

Tali attributi del database possono essere ottenuti utilizzando l'API REST.

L`IDentificatore univoco del database

name

Nome

created_at

Ora in cui è stato creato il database

updated_at

Ora in cui il database è stato aggiornato

Visualizza tutti i database

Parametri

rest_api_key

la tua chiave API

page

I database vengono visualizzati 20 per pagina, quindi la pagina può essere 1..5

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps.json

Contenuto della richiesta

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

Risposta: restituisce tutti i database

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps.xml

Contenuto della richiesta

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

Risposta: restituisce tutti i database

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

Ottiene il database per ID

Parametri

rest_api_key

la tua chiave API

APP_ID

È necessario conoscere l`ID del database che si desidera eliminare. È possibile trovare l`ID dopo aver ricevuto tutti i database . Conoscendo l`ID del database, è necessario sostituire l`ID nell'URL, ad esempio: /apps/ID.json su /apps/aOWO_dVXHdHie1WeGFE8k2.json

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps/APP_ID.json

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta: restituisce informazioni sul 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
 }
}

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps/APP_ID.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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>

Ottiene il database per nome

Parametri

rest_api_key

la tua chiave API

Nome

Devi conoscere il nome del database. Puoi ottenere il nome eseguendo la query Ottieni tutti i database ..

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps/search.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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
 }
}

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps/search.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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>

Aggiorna il database

Parametri

rest_api_key

la tua chiave API

APP_ID

name

Nuovo nome del database

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

PUT

URL

/apps/APP_ID.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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
 }
}

Stiamo effettuando una query (XML)

Formato

XML

Metodo

PUT

URL

/apps/APP_ID.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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>

Elimina il database

Parametri

rest_api_key

la tua chiave API

APP_ID

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

DELETE

URL

/apps/APP_ID.json

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

DELETE

URL

/apps/APP_ID.xml

Contenuto della richiesta

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

Risposta

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

Dopo aver eliminato il database, questo metodo restituisce tutti i database rimanenti.

Crea un app

Parametri

rest_api_key

la tua chiave API

database_name

Il nome del database

form_name

Il nome del modulo. Non è possibile creare un database senza un modulo perché non esiste un punto in un database senza un modulo.

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/apps.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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
    }
}

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

/apps.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sul 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 caso di errore. Riceverai un messaggio di errore, ad esempio 'Il nome dell'applicazione esiste già'.

Modulo

Questi attributi di forma possono essere ottenuti dall'API REST.

L`IDentificatore univoco per il modulo

name

Nome

desc

Descrizione

post_action

Elenco dei destinatari dei messaggi di posta elettronica

Ottieni qualsiasi modulo

Parametri

rest_api_key

la tua chiave API

APP_ID

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps/APP_ID/entities.json

Contenuto della richiesta

{rest_api_key":"API_KEY"}

Risposta: Ottieni tutti i moduli del database

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps/APP_ID/entities.xml

Contenuto della richiesta

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

Risposta: Ottieni tutti i moduli del database

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

Scarica il modulo in ID

Parametri

rest_api_key

la tua chiave API

APP_ID

Devi conoscere l`ID del modulo. Puoi trovare ENTITY_ID dopo aver ricevuto tutti i moduli . Quando conosci l`ID del modulo, devi elencare ENTITY_ID nell'URL, ad esempio: /apps/APP_ID/entity.json su /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps/APP_ID/entities/ID.json

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta: restituisce informazioni sui moduli

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps/APP_ID/entities/ID.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Ottieni il modulo per nome

Parametri

rest_api_key

la tua chiave API

database_name

Devi conoscere il nome del database. Puoi ottenere il nome eseguendo la query Ottieni tutti i database ..

form_name

Devi conoscere il nome del modulo. Puoi ottenerlo collegando Ottieni tutti i moduli .

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps/search/entities/search.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps/search/entities/search.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Aggiorna il modulo

Parametri

rest_api_key

la tua chiave API

APP_ID

name

Nuovo nome del modulo. Vedi tutte le opzioni disponibili qui

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

PUT

URL

/apps/APP_ID/entities/ID.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

PUT

URL

/apps/APP_ID/entities/ID.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Elimina il modulo

Parametri

rest_api_key

la tua chiave API

APP_ID

Devi conoscere l`ID del modulo che desideri eliminare. Puoi trovare l`ID dopo aver ricevuto tutti i moduli . Conoscendo l`ID del modulo, devi sostituire l`ID nell'URL, ad esempio: /apps/APP_ID/entities/ID.json su /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

DELETE

URL

/apps/APP_ID/entities/ID.json

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

DELETE

URL

/apps/APP_ID/entities/ID.xml

Contenuto della richiesta

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

Risposta

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

Crea un modulo

Parametri

rest_api_key

la tua chiave API

APP_ID

name

Nome modulo

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/apps/APP_ID/entities.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

/apps/APP_ID/entities.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Campo

Tali attributi di campo possono essere ottenuti dall'API REST.

L`IDentificatore univoco del campo

entity_id

ID campo modulo

name

Nome

type_name

Tipo di campo. Può essere: 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

Ottieni campi modulo

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

{rest_api_key":"API_KEY"}

Risposta: Ottiene tutti i campi modulo

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta: Ottiene tutti i campi modulo

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

Ottieni un campo

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

Devi conoscere l`ID del campo. Puoi trovare l`ID dopo aver ricevuto tutti i campi del modulo . Conoscendo l`ID del campo, devi sostituire l`ID nell'URL, ad esempio: /apps/APP_ID/entity/ENTITY_ID/properties/ID.json su /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

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

Ottiene un campo con Nome

Parametri

rest_api_key

la tua chiave API

database_name

Devi conoscere il nome del database. Puoi ottenere il nome eseguendo la query Ottieni tutti i database ..

form_name

Devi conoscere il nome del modulo. Puoi ottenerlo collegando Ottieni tutti i moduli .

field_name

Devi conoscere il nome del campo. Puoi ottenerlo collegando Ottieni tutti i campi modulo .

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

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

Esegui azione

Parametri

rest_api_key

la tua chiave API

DTYPE_ID

Devi conoscere l'identificatore del tuo record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record.

ACTION_PROPERTY_ID

Devi conoscere l'identificatore del tuo campo. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i campi modulo.

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/actions/ACTION_PROPERTY_ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Contenuto della richiesta

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

Risposta

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

Esegui azioni

Parametri

rest_api_key

la tua chiave API

ACTION_PROPERTY_ID

Devi conoscere l'identificatore del tuo campo. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i campi modulo.

dtype_ids

Devi conoscere gli identificatori dei record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record.

json_dtype_ids

Devi conoscere gli identificatori dei record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record.

run_by_all_table_or_report

Il seguente parametro è disponibile per eseguire tutte le azioni nella tabella o nel rapporto: run_by_all_table_or_report=true.

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/actions/ACTION_PROPERTY_ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Contenuto della richiesta

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

Risposta

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

Aggiorna il campo

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

name

Nuovo nome campo. Tutti gli attributi disponibili sono disponibili qui

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

PUT

URL

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

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

PUT

URL

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

Contenuto della richiesta

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

Risposta

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

Elimina il campo

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

DELETE

URL

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

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

DELETE

URL

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

Contenuto della richiesta

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

Risposta

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

Crea un campo

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

name

Nome campo

type_name

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

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

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

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

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Ottiene i totali nella colonna

Parametri

rest_api_key

la tua chiave API

ENTITY_ID

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/search/sum/ENTITY_ID/ID.json

Contenuto della richiesta

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

Risposta

    
{total: 3}

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/search/sum/ENTITY_ID/ID.xml

Contenuto della richiesta

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

Risposta

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

Record

Tali attributi di registrazione possono essere ottenuti dall'API REST.

L`IDentificatore univoco per il record.

app_id

ID app

entity_id

ID modulo di registrazione

values

Hash scrivere valori. Dove la chiave è il ID campo e il valore è il valore del campo.

json_values

Registra valori hash. Dove chiave è id campo e valore è questo valore di campo. Analogo di values_hash ma in formato JSON

rel_values

Hash del valore della relazione del record. Dove la chiave è ID campo e il valore è l`ID del record associato.

Ottiene i record

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

page

Numero di pagina con record. Da 1 a numero di record / per_page .

name_value

Utilizza il parametro per ottenere i record del modulo: "nome campo": "valore", "id campo": "nome campo"

fetch_all

Per i proprietari di account a pagamento è disponibile il seguente parametro: fetch_all=true.
Per ottenere un numero specifico di post, utilizza il parametro per_page.
Restrizioni sul numero massimo di voci per_page per piani diversi:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

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

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

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

Ottieni un record

Parametri

rest_api_key

la tua chiave API

APP_ID

Devi conoscere l`ID record. l`ID può essere trovato dopo aver ricevuto tutti i record . Quando conosci l`ID, devi sostituire l`ID nell'URL, ad esempio: /apps/APP_ID/dtypes/ID. json on /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Utilizza il parametro per ottenere i record del modulo: "nome campo": "valore", "id campo": "nome campo"

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

/apps/APP_ID/dtypes/ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

/apps/APP_ID/dtypes/ID.xml

Contenuto della richiesta

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

Risposta

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

Aggiorna il record

Parametri

rest_api_key

la tua chiave API

APP_ID

values

Valori del record di hash, dove la chiave è l`ID del campo modulo

json_values

Se usi jQuery, Ruby o un other linguaggio di programmazione, quindi inserisci i valori dei record come hash codificato nel parametro 'valori'. Ma se il tuo framework non ti consente di farlo, puoi inviare i valori dei record, JSON, ad esempio: " {"aNW4nkW5bdUjldO8oKuSku ": "2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". Ma utilizza quindi il nome del parametro 'json_values'.

subforms_values / subforms_json_values

Per creare o aggiornare sottomaschere, allo stesso modo, usare 'subforms_values' o 'json_subforms_values'.
il seguente formato:
"{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 "}}} ".

Dove property1_id e property2_id è l`ID dei campi Sottomaschera nella tabella principale.
subform1_id, subform2_id - l`ID del modulo a cui puntano i campi property1_id e property2_id.
subform1_record1_id e subform1_record2_id: questo è l`ID dei record di sottomaschera nuovi o esistenti.
subform1_field1_id, subform1_field2_id - ID dei campi nel modulo subform1_id.
subform2_field1_id, subform2_field2_id - ID dei campi nel modulo subform2_id.

Tutti gli ID sono codici base64 sicuri con URL di 22 caratteri, puoi prenderli da altre API di connessione o crearne one tuo per i nuovi ID record.

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

PUT

URL

/apps/APP_ID/dtypes/ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Contenuto della richiesta

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

Risposta

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

Aggiorna diversi record

Parametri

rest_api_key

la tua chiave API

confirm_action

Per eseguire l'aggiornamento nella tabella o nel rapporto è necessario il seguente parametro: confirm_action: update.

ENTITY_ID

Devi conoscere l'identificatore del modulo del tuo campo per aggiornare le impostazioni del campo. Puoi trovare ENTITY_ID utilizzando la chiamata Recupera tutti i moduli.

APP_ID

Devi conoscere l'identificatore del tuo database per recuperare le informazioni sul database. Puoi trovare l'ID usando la chiamata Recupera tutti i database.

dtype_ids

Devi conoscere gli identificatori dei record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record.

json_dtype_ids

Devi conoscere gli identificatori dei record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record.

update_id

Devi conoscere l'identificatore del tuo campo. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i campi modulo.

update_term

Nuovo valore per i record

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Contenuto della richiesta


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

Risposta

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

Aggiorna tutti i record

Parametri

rest_api_key

la tua chiave API

confirm_action

Il seguente parametro è necessario per eseguire l'aggiornamento di tutti i record nella tabella o nel rapporto: confirm_action: update_all.

ENTITY_ID

Devi conoscere l'identificatore del modulo del tuo campo per aggiornare le impostazioni del campo. Puoi trovare ENTITY_ID utilizzando la chiamata Recupera tutti i moduli.

APP_ID

Devi conoscere l'identificatore del tuo database per recuperare le informazioni sul database. Puoi trovare l'ID usando la chiamata Recupera tutti i database.

update_id

Devi conoscere l'identificatore del tuo campo. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i campi modulo.

update_term

Nuovo valore per i record

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Contenuto della richiesta


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

Risposta

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

Aggiorna i dati della cella

Parametri

rest_api_key

la tua chiave API

PROPERTY_ID

DTYPE_ID

val

Il nuovo valore della cella di dati

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Contenuto della richiesta

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

Risposta

    
{"new_value": "John Smith"}

Stiamo effettuando una query (XML)

Formato

XML

Metodo

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Contenuto della richiesta

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

Risposta

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

Elimina il record

Parametri

rest_api_key

la tua chiave API

APP_ID

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Contenuto della richiesta

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

Risposta

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

Elimina diversi record

Parametri

rest_api_key

la tua chiave API

ENTITY_ID

Devi conoscere l'identificatore del modulo del tuo campo per aggiornare le impostazioni del campo. Puoi trovare ENTITY_ID utilizzando la chiamata Recupera tutti i moduli.

APP_ID

Devi conoscere l'identificatore del tuo database per recuperare le informazioni sul database. Puoi trovare l'ID usando la chiamata Recupera tutti i database.

dtype_ids

Devi conoscere gli identificatori dei record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record.

json_dtype_ids

Devi conoscere gli identificatori dei record. Puoi trovare l'ID utilizzando la chiamata Recupera tutti i record. (Non necessariamente)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Contenuto della richiesta


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

Risposta

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

Elimina tutto

Parametri

rest_api_key

la tua chiave API

APP_ID

Devi conoscere l'identificatore del tuo database per recuperare le informazioni sul database. Puoi trovare l'ID usando la chiamata Recupera tutti i database.

ENTITY_ID

Devi conoscere l'identificatore del modulo del tuo campo per aggiornare le impostazioni del campo. Puoi trovare ENTITY_ID utilizzando la chiamata Recupera tutti i moduli.

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Contenuto della richiesta

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

Risposta

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Contenuto della richiesta


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

Risposta

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

Nuovo record

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

Se devi utilizzare il tuo ID personale, puoi generare UUID (identificatore univoco) 22 caratteri base64 sicura per URL Ad esempio in Ruby . Successivamente dovrai passarlo all'hash 'values', ad esempio: values => {'id' => ID}, passare a: valori => {'id' => '22adadVXHdHie1WeGFE8k2'}, altrimenti il sistema genererà un identificatore univoco per te.

values / json_values

subforms_values / subforms_json_values

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/apps/APP_ID/dtypes.json

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

POST

URL

/apps/APP_ID/dtypes.xml

Contenuto della richiesta

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

Risposta: restituisce informazioni sui moduli

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

Cerca

Parametri

rest_api_key

la tua chiave API

APP_ID

ENTITY_ID

view

Per ottenere i record, devi conoscere l`ID del rapporto. (Non necessariamente)

search

Vuoi un colpetto sul tavolo? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - identificatore di campo in base al quale stiamo cercando ( -ALL - - per un colpo su tutte le colonne),
SEARCH_TERM - significato, yake shukaєmo,
SEARCH_CRITERIA - criterio per un messaggio, forse uno di loro:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Per numeri e date regolari : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Per un appuntamento per circa un`ora : 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.

Colonne di sistema : added_by, created_at, updated_at, ip.

Se desideri cercare in più colonne con un criterio "AND" unificante, questi criteri dovrebbero essere inseriti in un array, se "OR", quindi in uno separato, ad esempio:
[[{"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"}]]

la formula di ricerca sarà: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Il numero di record nei risultati della ricerca, il massimo è 200.

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

/search/APP_ID.json

Contenuto della richiesta

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

Risposta

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

Relazione

Come collegare i record:

Per stabilire una relazione tra i record, è necessario inviare un hash separato nella 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 deve essere nella forma 'rel' => {rel_id => RECORD_ID} o 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} se hai una relazione many-a-many. Dove RECORD_ID è l`ID del record in cui desideri combinare l'attuale record. Ecco come ottenere rel_id.

Parametri

rest_api_key

la tua chiave API

PROPERTY_ID

ENTITY_ID

Devi conoscere l`ID del modulo. Puoi trovare ENTITY_ID dopo aver ricevuto tutti i moduli . Conoscendo l`ID del modulo, dovrai sostituire ENTITY_ID nell'URL, ad esempio /apps/APP_ID/entities/ENTITY_ID/properties.json con /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2'proper

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

Rapporti

Tali attributi del rapporto possono essere accessibili tramite l'API REST.

name

Nome

ottieni rapporti

Parametri

rest_api_key

la tua chiave API

APP_ID

ID app

ENTITY_ID

ID tabella (modulo)

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

{"rest_api_key":"API_KEY"}

Risposta: restituisce tutti i report delle tabelle.

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

Stiamo effettuando una query (XML)

Formato

XML

Metodo

GET

URL

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

Contenuto della richiesta: restituisce tutti i report delle tabelle.

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

Risposta

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

File

Vedere il collegamento al file

per ottenere un collegamento al file, ottenere innanzitutto i valori dei campi record e scaricare il file dal collegamento https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, dove FILE_NAME: il nome del file scaricato, ottenuto in hash di tipo PROPERTY_ID => VALUE, RECORD_ID - ID record, PROPERTY_ID - ID campo.

Scarica i file

Per caricare un file in un record devi fare una richiesta POST al metodo API upload_file con intestazione del tipo di contenuto multipart / form-data e solo dopo devi creare o aggiornare il tuo record. Quindi l'ID del record dovrebbe essere generato prima delle chiamate. Inoltre dovrai generare l'intestazione Multipart, per favore, segui l'esempio di Ruby con la classe MultipartPost di seguito. In questo esempio imparerai come caricare il file anche nella sottomaschera.

Esempio su 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

Parametri

rest_api_key

la tua chiave API

APP_ID

property_id

dtype_id

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

POST

URL

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

Contenuto della richiesta

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

Risposta

    Uploaded

Rimuove i file

Parametri

rest_api_key

la tua chiave API

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Nome file

Stiamo effettuando una query (JSON)

Formato

JSON

Metodo

GET

URL

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

Contenuto della richiesta

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

Risposta

    File removed

Esempi

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Crea una chiamata al metodo richiesto: 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

   # Converti i parametri in JSON/XML e imposta il tipo di contenuto come application/json o application/xml   Nota il formato del parametro XML, in cui l`elemento principale è 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
	# Imposta il tipo di contenuto
  req["Content-Type"] = "application/#{format}"

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

  # Vengono verificate tutte le connessioni HTTPS e i certificati SSL

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


# Ricorda di impostare API_KEY
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# La risposta sarà disponibile response.body
puts response.body

Questa è l'API REST di base e deve essere sufficiente per creare cose interessanti e utili. Tuttavia, se vuoi qualcos'other, ad esempio più metodi, ecc. contatta noi in qualsiasi momento. Siamo sempre entusiasti di avere tue notizie!

API REST QuintaDB

Informazioni generali sulle chiamate API

Database

Modulo

Campo

Record

Rapporti

File

Utilizziamo i cookie per fornire le funzionalità necessarie del sito Web. Facendo clic su "Accetta" accetti l'uso dei cookie sul nostro sito Web.