QuintaDB REST API

QuintaDB REST API er designet for å låse opp potensialet til dataene som er lagret i QuintaDB-databasen. Ved å bruke denne API-en kan du oppnå mer enn det som for øyeblikket tilbys av standard QuintaDB UI. Slik gir vi du evner å gjøre med dataene dine alt du trenger og på den måten du trenger. Du kan lage dine egne skript, stasjonære og mobilapplikasjoner for forskjellige plattformer som iPhone/Android og mange flere. Og QuintaDB vil være et sted hvor du lagrer, deler og administrerer dataene dine.

Generell informasjon om API-anrop

Alle samtaler skal inneholde REST API-nøkkel , som du finner i menyen "API" øverst til høyre på siden.
Resultat returneres i JSON eller XML , avhengig av din forespørsel.
Vi viser en tabell med et resultat for hver samtale. URL-en vises på denne måten /apps.json , det betyr at du bør ringe https://QuintaDB.com /apps.json i applikasjonen din. Vær oppmerksom på at alle samtaler skal bruke https og at du må validere serverens SSL-sertifikat.

Database

Slike databaseattributter kan være tilgjengelige via REST API.

Unik databaseidentifikator. Du trenger dette for å få tilgang til denne databaseskjemaene og postene

name

Navn

created_at

Tidspunkt da databasen ble opprettet

updated_at

Tidspunkt da databasen sist ble oppdatert (endrede poster eller skjemaer)

Få alle databaser

Parametere

rest_api_key

API-nøkkelen din

page

Databaser paginert med 20 poster per side. Så hvis du har 100 databaser, kan siden være 1..5.

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps.json

Forespørselsorgan

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

Svar: returnerer gjeldende databaser.

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps.xml

Forespørselsorgan

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

Svar: returnerer gjeldende databaser.

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

Få database etter ID

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Du må kjenne databasens identifikator for å hente databaseinformasjon. Du kan finne ID ved å bruke Hent alle databaser . Når du vet det, må du legg til denne ID-en i URL i lenken nedenfor, dvs. endre /apps/ID.json til /apps/aOWO_dVXHdHie1WeGFE8k2.json

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID.json

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar: returnerer databaseinformasjon

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID.xml

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

Hent database etter navn

Parametere

rest_api_key

API-nøkkelen din

Navn

Du må kjenne databasenavnet ditt for å hente databaseinformasjon. Du kan finne Navn ved å bruke Hent alle databaser .

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps/search.json

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps/search.xml

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

Oppdater database

Parametere

rest_api_key

API-nøkkelen din

APP_ID

name

Nytt databasenavn

Forespørsel (JSON)

Format

JSON

Metode

PUT

URL

/apps/APP_ID.json

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

Forespørsel (XML)

Format

XML

Metode

PUT

URL

/apps/APP_ID.xml

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

Slett database

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Forespørsel (JSON)

Format

JSON

Metode

DELETE

URL

/apps/APP_ID.json

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar

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

Forespørsel (XML)

Format

XML

Metode

DELETE

URL

/apps/APP_ID.xml

Forespørselsorgan

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

Svar

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

Etter at databasen er fjernet, returnerer samtalen alle databasene som var igjen.

Opprett database

Parametere

rest_api_key

API-nøkkelen din

database_name

Database navn

form_name

Form name. Du kan ikke opprette database uten skjema. Fordi det ikke gir mening å ha en database uten skjemaer.

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/apps.json

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

/apps.xml

Forespørselsorgan

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

Svar: returnerer databaseinformasjon

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

I tilfelle feil. Du får feilmelding, dvs. 'Slike appnavn eksisterer allerede'.

Skjema

Slike skjemaattributter kan være tilgjengelige via REST API.

Unik skjemaidentifikator. Du trenger dette for å få tilgang til dette skjemaet og skjemaoppføringene

name

Navn

desc

Beskrivelse

post_action

Liste over mottakere av e-postvarsler

Hent alle databaseskjemaer

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID/entities.json

Forespørselsorgan

{rest_api_key":"API_KEY"}

Svar: hent alle databaseskjemaer

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID/entities.xml

Forespørselsorgan

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

Svar: hent alle databaseskjemaer

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

Få skjema etter ID

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Du må kjenne skjemaidentifikatoren din for å hente skjemainformasjon. Du kan finne ID ved å bruke Hent alle skjemaer . Når du vet det, må du legg denne ID-en til URL i lenken nedenfor, dvs. endre /apps/APP_ID/entities.json til /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID/entities/ID.json

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar: returnerer skjemainformasjon

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID/entities/ID.xml

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Få skjema etter navn

Parametere

rest_api_key

API-nøkkelen din

database_name

Du må kjenne databasenavnet ditt for å hente databaseinformasjon. Du kan finne Navn ved å bruke Hent alle databaser .

form_name

Du må vite skjemaets navn for å hente skjemainformasjon. Du kan finne skjemanavn ved å bruke Hent alle skjemaer .

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps/search/entities/search.json

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps/search/entities/search.xml

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Oppdater skjema

Parametere

rest_api_key

API-nøkkelen din

APP_ID

name

Nytt skjemanavn. Se alle tilgjengelige attributter her

Forespørsel (JSON)

Format

JSON

Metode

PUT

URL

/apps/APP_ID/entities/ID.json

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Forespørsel (XML)

Format

XML

Metode

PUT

URL

/apps/APP_ID/entities/ID.xml

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Slett skjema

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Du må vite databasens identifikator. Du kan finne APP_ID ved å bruke Hent alle skjemaer . Når du vet det, må du legge til dette APP_ID i URL i lenken nedenfor, dvs. endre /apps/APP_ID/entities.json til /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Forespørsel (JSON)

Format

JSON

Metode

DELETE

URL

/apps/APP_ID/entities/ID.json

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar

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

Forespørsel (XML)

Format

XML

Metode

DELETE

URL

/apps/APP_ID/entities/ID.xml

Forespørselsorgan

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

Svar

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

Opprett skjema

Parametere

rest_api_key

API-nøkkelen din

APP_ID

name

Form name

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/apps/APP_ID/entities.json

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

/apps/APP_ID/entities.xml

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Felt

Slike feltegenskaper kan hentes via REST API.

Unik feltidentifikator. Du trenger dette for å få tilgang til dette feltet

entity_id

Feltets skjemaidentifikator.

name

Navn

type_name

Feltypenavn. Kan av en av: 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

Hent alle skjemafelt

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

{rest_api_key":"API_KEY"}

Svar: hent alle skjemafelt

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

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

Forespørselsorgan

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

Svar: hent alle skjemafelt

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

Få felt etter ID

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

Du må kjenne feltidentifikatoren din for å kunne oppdatere feltinnstillingene. Du kan finne ID ved å bruke Hent alle skjemafelt samtale. Når du vet det, trenger du for å legge til denne ID-en i URL-en i lenken nedenfor, dvs. endre /apps/APP_ID/entities/ENTITY_ID/properties/ID.json til /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

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

Forespørselsorgan

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

Svar

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

Få felt etter navn

Parametere

rest_api_key

API-nøkkelen din

database_name

Du må kjenne databasenavnet ditt for å hente databaseinformasjon. Du kan finne Navn ved å bruke Hent alle databaser .

form_name

Du må vite skjemaets navn for å hente skjemainformasjon. Du kan finne skjemanavn ved å bruke Hent alle skjemaer .

field_name

Du må kjenne feltnavnet ditt for å oppdatere feltinnstillingene. Du kan finne feltnavnet ved å bruke Hent alle skjemafelt -anrop.

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

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

Forespørselsorgan

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

Svar

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

Kjør handling

Parametere

rest_api_key

API-nøkkelen din

DTYPE_ID

Du må kjenne postidentifikatoren din. Du kan finne ID ved å bruke Hent alle poster-anrop.

ACTION_PROPERTY_ID

Du må kjenne feltidentifikatoren din. Du kan finne ID ved å bruke Hent alle skjemafelt-anrop.

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Forespørselsorgan

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

Svar

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

Kjør handlinger

Parametere

rest_api_key

API-nøkkelen din

ACTION_PROPERTY_ID

Du må kjenne feltidentifikatoren din. Du kan finne ID ved å bruke Hent alle skjemafelt-anrop.

dtype_ids

Du må kjenne identifikatorene dine. Du kan finne ID ved å bruke Hent alle poster-anrop.

json_dtype_ids

Du må kjenne postidentifikatorene dine. Du kan finne ID ved å bruke Hent alle poster-anrop.

run_by_all_table_or_report

Følgende parameter er tilgjengelig for å kjøre alle handlinger i tabell eller rapport: run_by_all_table_or_report=true.

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Forespørselsorgan

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

Svar

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

Oppdateringsfelt

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

name

Nytt feltnavn. Se alle tilgjengelige attributter her

Forespørsel (JSON)

Format

JSON

Metode

PUT

URL

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

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

PUT

URL

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

Forespørselsorgan

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

Svar

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

Slett felt

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

Forespørsel (JSON)

Format

JSON

Metode

DELETE

URL

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

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar

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

Forespørsel (XML)

Format

XML

Metode

DELETE

URL

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

Forespørselsorgan

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

Svar

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

Opprett felt

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

name

Nytt skjemafeltnavn

type_name

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

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

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

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

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Få total per kolonne

Parametere

rest_api_key

API-nøkkelen din

ENTITY_ID

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/search/sum/ENTITY_ID/ID.json

Forespørselsorgan

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

Svar

    
{total: 3}

Forespørsel (XML)

Format

XML

Metode

GET

URL

/search/sum/ENTITY_ID/ID.xml

Forespørselsorgan

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

Svar

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

Record

Slike postattributter kan være tilgjengelige via REST API.

Unik postidentifikator. Du trenger dette for å få tilgang til denne posten.

app_id

App-ID

entity_id

Record's form identifier.

values

Registrer verdier hash. Hvor nøkkelen er felt-ID og verdien er denne feltverdien.

json_values

Record values hash. Hvor nøkkelen er felt-ID og verdi er denne feltverdien. Analog av values_hash men i JSON-format

rel_values

Registrer relasjoner verdier hash. Hvor nøkkelen er felt-ID og verdien er den koblede post-ID-en.

Hent alle poster

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

page

Registrerer sidetall. Fra 1 til tabell Registrerer antall/ per_side .

name_value

Bruk parameteren for å få data av typen: "field name": "value", "field id": "field name"

fetch_all

For eiere av betalte kontoer er følgende parameter tilgjengelig: fetch_all=true.
For å få et spesifikt antall innlegg, bruk parameteren per_page.
Begrensninger for maksimalt antall oppføringer per_page for forskjellige planer:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

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

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

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

Forespørselsorgan

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

Svar

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

Få post

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Du må kjenne post-ID-en din. Du kan finne ID ved å bruke Hent alle poster -anrop. Når du vet det, må du legge til denne ID-en i URL i lenken nedenfor, dvs. endre /apps/APP_ID/dtypes/ID.json til /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Bruk parameteren for å få data av typen: "field name": "value", "field id": "field name"

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID/dtypes/ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID/dtypes/ID.xml

Forespørselsorgan

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

Svar

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

Oppdater post

Parametere

rest_api_key

API-nøkkelen din

APP_ID

values

Record verdier hash, der nøkkelen er form felt id.

json_values

Hvis du bruker jQuery, Ruby eller et annet programmeringsspråk, vennligst bruk 'verdier' -parameteren for å sende kodingsparametere. Hvis rammeverket ditt ikke tillater dette, kan du sende postverdier som JSON-streng, men i dette tilfellet spesifiser parameternavnet ditt som 'json_values'. Og JSON-verdistrengen din ser slik ut: "{" aNW4nkW5bdUjldO8oKuSku ": " 2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} "

subforms_values / subforms_json_values

For å opprette eller oppdatere underformer, på samme måte, bruk 'subforms_values' eller 'json_subforms_values'.
Med formatet nedenfor:
"{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 "}}} ".

Hvor property1_id og property2_id - dette er felt-ID-er med en underformstype i hovedtabellen.
subform1_id, subform2_id - Forms ID's, som ble satt i innstillingene property1_id og property2_id.
subform1_record1_id и subform1_record2_id - dette er nye eller eksisterende underformular-ID-er.
subform1_field1_id, subform1_field2_id - felt ID er i skjemaet subform1_id.
subform2_field1_id, subform2_field2_id - felt ID er i skjemaet subform2_id.

Alle ID-er - det er en 22 tegn URL-lagret base64-kode, du kan få dem fra andre API-anrop eller opprette for nye underformularposter.

Forespørsel (JSON)

Format

JSON

Metode

PUT

URL

/apps/APP_ID/dtypes/ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Forespørselsorgan

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

Svar

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

Oppdater flere poster

Parametere

rest_api_key

API-nøkkelen din

confirm_action

Følgende parameter er nødvendig for å kjøre oppdatering i tabell eller rapport: confirm_action: update.

ENTITY_ID

Du må kjenne feltets skjemaidentifikator for å oppdatere feltinnstillingene. Du kan finne ENTITY_ID ved å bruke Hent alle skjemaer-kallet.

APP_ID

Du må kjenne databaseidentifikatoren din for å hente databaseinformasjon. Du kan finne ID ved å bruke Hent alle databaser-anrop.

dtype_ids

Du må kjenne identifikatorene dine. Du kan finne ID ved å bruke Hent alle poster-anrop.

json_dtype_ids

Du må kjenne postidentifikatorene dine. Du kan finne ID ved å bruke Hent alle poster-anrop.

update_id

Du må kjenne feltidentifikatoren din. Du kan finne ID ved å bruke Hent alle skjemafelt-anrop.

update_term

Ny verdi for poster

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Forespørselsorgan


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

Svar

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

Oppdater alle poster

Parametere

rest_api_key

API-nøkkelen din

confirm_action

Følgende parameter er nødvendig for å kjøre oppdatering av alle poster i tabell eller rapport: confirm_action: update_all.

ENTITY_ID

Du må kjenne feltets skjemaidentifikator for å oppdatere feltinnstillingene. Du kan finne ENTITY_ID ved å bruke Hent alle skjemaer-kallet.

APP_ID

Du må kjenne databaseidentifikatoren din for å hente databaseinformasjon. Du kan finne ID ved å bruke Hent alle databaser-anrop.

update_id

Du må kjenne feltidentifikatoren din. Du kan finne ID ved å bruke Hent alle skjemafelt-anrop.

update_term

Ny verdi for poster

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Forespørselsorgan


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

Svar

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

Oppdater datacelle

Parametere

rest_api_key

API-nøkkelen din

PROPERTY_ID

DTYPE_ID

val

Ny celleverdi

Forespørsel (JSON)

Format

JSON

Metode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Forespørselsorgan

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

Svar

    
{"new_value": "John Smith"}

Forespørsel (XML)

Format

XML

Metode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Forespørselsorgan

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

Svar

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

Slett posten

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Forespørsel (JSON)

Format

JSON

Metode

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar

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

Forespørsel (XML)

Format

XML

Metode

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Forespørselsorgan

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

Svar

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

Slett flere

Parametere

rest_api_key

API-nøkkelen din

ENTITY_ID

Du må kjenne feltets skjemaidentifikator for å oppdatere feltinnstillingene. Du kan finne ENTITY_ID ved å bruke Hent alle skjemaer-kallet.

APP_ID

Du må kjenne databaseidentifikatoren din for å hente databaseinformasjon. Du kan finne ID ved å bruke Hent alle databaser-anrop.

dtype_ids

Du må kjenne identifikatorene dine. Du kan finne ID ved å bruke Hent alle poster-anrop.

json_dtype_ids

Du må kjenne postidentifikatorene dine. Du kan finne ID ved å bruke Hent alle poster-anrop. (Valgfritt)

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Forespørselsorgan


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

Svar

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

Slett alt

Parametere

rest_api_key

API-nøkkelen din

APP_ID

Du må kjenne databaseidentifikatoren din for å hente databaseinformasjon. Du kan finne ID ved å bruke Hent alle databaser-anrop.

ENTITY_ID

Du må kjenne feltets skjemaidentifikator for å oppdatere feltinnstillingene. Du kan finne ENTITY_ID ved å bruke Hent alle skjemaer-kallet.

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

Forespørsel (JSON)

Format

JSON

Metode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Forespørselsorgan

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

Svar

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

Forespørsel (XML)

Format

XML

Metode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Forespørselsorgan


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

Svar

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

Opprett post

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

Du må generere 22 tegn lang URL-sikker base64 UUID (Universally Unique IDentifier) . For eksempel i Ruby . Da må du sende disse identifikatorene til 'verdier' hash. Dvs: verdier => {'id' => ID}, endre til: verdier => {'id' => '22adadVXHdHie1WeGFE8k2'}

values / json_values

subforms_values / subforms_json_values

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/apps/APP_ID/dtypes.json

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Forespørsel (XML)

Format

XML

Metode

POST

URL

/apps/APP_ID/dtypes.xml

Forespørselsorgan

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

Svar: returnerer skjemainformasjon

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

Søk

Parametere

rest_api_key

API-nøkkelen din

APP_ID

ENTITY_ID

view

Du må kjenne rapport-ID-en din for å hente poster. (Valgfritt)

search

Vil du ha et flick på bordet? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - feltidentifikator som vi søker etter ( -ALL - - for å søke i alle kolonner),
SEARCH_TERM - verdien vi leter etter,
SEARCH_CRITERIA - kriterium for en melding, kanskje en av dem:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

For vanlige tall og datoer : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

For en date i omtrent en time : 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.

Systemkolonner : added_by, created_at, updated_at, ip.

Hvis du vil søke i flere kolonner med et samlende "OG" -kriterium, bør disse kriteriene plasseres i en matrise, hvis "ELLER", så til en egen, for eksempel:
[[{"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"}]]

søkeformelen vil være: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Antall poster i søkeresultatene, maksimum er 200.

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

/search/APP_ID.json

Forespørselsorgan

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

Svar

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

Forhold

Slik kobler du poster:

For å oppdatere lenken mellom postene, må du sende separat hash til CREATE eller UPDATE record call.

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 "

Dette hashet bør være som 'rel' => {rel_id => RECORD_ID} eller 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} hvis du har mange-til-mange-forhold. Hvor RECORD_ID er det et ID-nummer til en plate som du vil koble til nåværende post. Vennligst se nedenfor hvordan du blir rel_id.

Parametere

rest_api_key

API-nøkkelen din

PROPERTY_ID

ENTITY_ID

Du må kjenne feltets skjemaidentifikator for å kunne oppdatere feltinnstillingene. Du kan finne ENTITY_ID ved å bruke Hent alle skjemaer . Når du vet det, trenger du for å legge til dette ENTITY_ID til URL i lenken nedenfor, dvs. endre /apps/APP_ID/entities/ENTITY_ID/properties.json til /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

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

Svar

Rapporter

Slike rapportattributter kan være tilgjengelige via REST API.

name

Navn

Få rapporter

Parametere

rest_api_key

API-nøkkelen din

APP_ID

App-ID

ENTITY_ID

Tabell (skjema) ID

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

{"rest_api_key":"API_KEY"}

Svar: returnerer alle tabellrapporter.

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

Forespørsel (XML)

Format

XML

Metode

GET

URL

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

Forespørselsorgan: returnerer alle tabellrapporter.

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

Svar

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

Filer

Få fil-URL

For å laste ned postfiler må du hente postverdier først, og deretter vil du kunne laste ned filen ved hjelp av lenken slik https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, der FILE_NAME - filnavn, som du kan få fra postverdiene hash, som ser ut som PROPERTY_ID => VALUE, RECORD_ID - record ID, PROPERTY_ID - field ID.

Last opp filer

For å laste opp en fil til en post må du sende en POST-forespørsel til upload_file API-metoden med flertall/form-data innholdstype overskrift, og først etter det må du opprette eller oppdatere posten din. Så post-ID bør genereres før samtalene. Og du må også generere flerdelt overskrift, vær så snill, følg Ruby-eksemplet med klassen MultipartPost nedenfor. For eksempel lærer du hvordan du laster opp filen i underformen også.

Eksempel på rubin

  
    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

Parametere

rest_api_key

API-nøkkelen din

APP_ID

property_id

dtype_id

Forespørsel (JSON)

Format

JSON

Metode

POST

URL

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

Forespørselsorgan

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

Svar

    Uploaded

Fjern filer

Parametere

rest_api_key

API-nøkkelen din

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Filnavn

Forespørsel (JSON)

Format

JSON

Metode

GET

URL

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

Forespørselsorgan

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

Svar

    File removed

Eksempler

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

   # Konverter parametrene til JSON/XML og sett innholdstypen som applikasjon/json eller applikasjon/xml   Legg merke til XML-formatet for parametere, rotelementet er 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
	# Angi innholdstype
  req["Content-Type"] = "application/#{format}"

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

  # Alle samtaler via HTTPS og verifiserende SSL-sertifikater

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


# Sørg for å angi din egen API_KEY her
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Svaret vil være i response.body
puts response.body

Det er velkjent at programvareutvikling er veldig viktig i disse dager. Å ha REST API for programvaren din vil øke produktets popularitet veldig mye. Dette er en grunnleggende REST API og det bør være nok til å lage gode ting. Men hvis du trenger noe annet, flere metoder osv., vær så snill, kontakt oss når som helst. Vi ser frem til å høre fra deg!

QuintaDB REST API

Generell informasjon om API-anrop

Database

Skjema

Felt

Record

Rapporter

Filer

QuintaDB.com bruker informasjonskapsler for å gi den nødvendige funksjonaliteten på nettstedet og forbedre opplevelsen din. Ved å bruke nettstedet vårt, godtar du vår policy for informasjonskapsler.