QuintaDB REST API

QuintaDB REST API er designet til at låse op for potentialet i de data, der er gemt i din QuintaDB-database. Ved hjælp af denne API kan du opnå mere end aktuelt tilbydes af standard QuintaDB UI. Sådan giver vi din evne til at gøre med dine data alt hvad du har brug for og på den måde, du har brug for. Du kan oprette dine egne scripts, desktop- og mobilapplikationer til forskellige platforme som iPhone/Android og many flere. Og QuintaDB vil være et sted, hvor du gemmer, deler og administrerer dine data.

Generel information om API-opkald

Alle opkald skal indeholde en REST API-nøgle , som kan findes ved at klikke på knappen API-nøgler " i begyndelsen af siden.
Serversvar kan modtages i JSON eller XML format afhængigt af din anmodning.
Nedenfor viser vi tabeller med serverrespons for hver anmodning. URL`er vises som /apps.json , hvilket betyder, at du skal kalde metoden med linket https://QuintaDB.ru /apps.json i dit program. Bemærk, at alle opkald skal bruge protokollen https , og du skal kontrollere serverens SSL-certifikat for gyldighed.

Database

Sådanne databaseattributter kan være tilgængelige via REST API.

Unik database-id. Du skal bruge dette for at få adgang til denne databaseformularer og optegnelser

name

Navn

created_at

Tid, hvor databasen blev oprettet

updated_at

Tidspunkt, hvor databasen sidst blev opdateret (ændrede poster eller formularer)

Hent alle databaser

Parameters

rest_api_key

din API-nøgle

page

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

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps.json

Anmodningsorgan

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

Svar: returnerer dine nuværende 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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps.xml

Anmodningsorgan

<?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 dine nuværende 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>

Hent database efter id

Parameters

rest_api_key

din API-nøgle

APP_ID

Du skal kende din database-id for at hente databaseoplysninger. Du kan finde ID ved hjælp af Hent alle databaser -opkald. Når du kender det, skal du tilføj dette id til URL i nedenstående link, dvs. skift /apps/ID.json til /apps/aOWO_dVXHdHie1WeGFE8k2.json

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID.json

Anmodningsorgan

{"rest_api_key":"API_KEY"}

Svar: returnerer databaseinformation

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID.xml

Anmodningsorgan

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

Svar: returnerer databaseinformation

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

Parameters

rest_api_key

din API-nøgle

Navn

Du skal kende dit databasenavn for at hente databaseoplysninger. Du kan finde Navn ved hjælp af Hent alle databaser -opkald.

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps/search.json

Anmodningsorgan

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

Svar: returnerer databaseinformation

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps/search.xml

Anmodningsorgan

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

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

Opdater database

Parameters

rest_api_key

din API-nøgle

APP_ID

name

Nyt databasenavn

Forespørgsel (JSON)

Format

JSON

Metode

PUT

URL

/apps/APP_ID.json

Anmodningsorgan

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

Svar: returnerer databaseinformation

    
{"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ørgsel (XML)

Format

XML

Metode

PUT

URL

/apps/APP_ID.xml

Anmodningsorgan

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

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

Slet database

Parameters

rest_api_key

din API-nøgle

APP_ID

Forespørgsel (JSON)

Format

JSON

Metode

DELETE

URL

/apps/APP_ID.json

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

DELETE

URL

/apps/APP_ID.xml

Anmodningsorgan

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

Efter fjernelse af database returnerer dette opkald alle de databaser, der var tilbage.

Opret database

Parameters

rest_api_key

din API-nøgle

database_name

Database navn

form_name

Formularnavn. Du kan ikke oprette database uden form. Fordi det ikke giver mening at have database uden formularer.

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/apps.json

Anmodningsorgan

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

Svar: returnerer databaseinformation

    
{"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ørgsel (XML)

Format

XML

Metode

POST

URL

/apps.xml

Anmodningsorgan

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

    
  <?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 tilfælde af fejl. Du får en fejlmeddelelse, dvs. 'Sådan et appnavn findes allerede'.

Form

Sådanne formattributter kan være tilgængelige via REST API.

Unik formular-id. Du skal bruge dette for at få adgang til denne formular og formularoptegnelser

name

Navn

desc

Beskrivelse

post_action

Liste over modtagere af e-mail-underretninger

Hent alle databaseformularer

Parameters

rest_api_key

din API-nøgle

APP_ID

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID/entities.json

Anmodningsorgan

{rest_api_key":"API_KEY"}

Svar: hent alle databaseformularer

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID/entities.xml

Anmodningsorgan

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

Svar: hent alle databaseformularer

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

Hent formular efter id

Parameters

rest_api_key

din API-nøgle

APP_ID

Du skal kende din formular-id for at hente formularoplysninger. Du kan finde ID ved hjælp af Hent alle formularer . Opkald. Når du kender det, skal du tilføj dette id til URL i nedenstående link, dvs. skift /apps/APP_ID/entities.json til /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID/entities/ID.json

Anmodningsorgan

{"rest_api_key":"API_KEY"}

Svar: returnerer formularoplysninger

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID/entities/ID.xml

Anmodningsorgan

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

Svar: returnerer formularoplysninger

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

Hent formular efter navn

Parameters

rest_api_key

din API-nøgle

database_name

Du skal kende dit databasenavn for at hente databaseoplysninger. Du kan finde Navn ved hjælp af Hent alle databaser -opkald.

form_name

Du skal kende dit formularnavn for at hente formularoplysninger. Du kan finde formularnavn ved hjælp af Fetch All Forms call.

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps/search/entities/search.json

Anmodningsorgan

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

Svar: returnerer formularoplysninger

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps/search/entities/search.xml

Anmodningsorgan

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

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

Opdateringsformular

Parameters

rest_api_key

din API-nøgle

APP_ID

name

Nyt formularnavn. Se alle tilgængelige attributter her

Forespørgsel (JSON)

Format

JSON

Metode

PUT

URL

/apps/APP_ID/entities/ID.json

Anmodningsorgan

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

Svar: returnerer formularoplysninger

    
{"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ørgsel (XML)

Format

XML

Metode

PUT

URL

/apps/APP_ID/entities/ID.xml

Anmodningsorgan

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

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

Slet formular

Parameters

rest_api_key

din API-nøgle

APP_ID

Du skal kende din database-id. Du kan finde APP_ID ved hjælp af Hent alle formularer . Når du kender det, skal du tilføje dette APP_ID til URL i linket nedenfor, dvs. skift /apps/APP_ID/entities.json til /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Forespørgsel (JSON)

Format

JSON

Metode

DELETE

URL

/apps/APP_ID/entities/ID.json

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

DELETE

URL

/apps/APP_ID/entities/ID.xml

Anmodningsorgan

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

Opret formular

Parameters

rest_api_key

din API-nøgle

APP_ID

name

Form name

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/apps/APP_ID/entities.json

Anmodningsorgan

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

Svar: returnerer formularoplysninger

    
{"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ørgsel (XML)

Format

XML

Metode

POST

URL

/apps/APP_ID/entities.xml

Anmodningsorgan

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

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

Sådanne feltegenskaber kan hentes via REST API.

Unik feltidentifikator. Du skal bruge dette for at få adgang til dette felt

entity_id

Feltets form-id.

name

Navn

type_name

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

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

{rest_api_key":"API_KEY"}

Svar: hent alle formularfelter

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

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

Anmodningsorgan

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

Svar: hent alle formularfelter

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

Hent felt efter id

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

Du skal kende din felt-id for at opdatere feltindstillinger. Du kan finde ID ved hjælp af Hent alle formularfelter -opkald. Når du kender det, skal du bruge for at tilføje dette id til URL i nedenstående link, dvs. ændre /apps/APP_ID/entities/ENTITY_ID/properties/ID.json til /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

GET

URL

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

Anmodningsorgan

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

Hent felt efter navn

Parameters

rest_api_key

din API-nøgle

database_name

Du skal kende dit databasenavn for at hente databaseoplysninger. Du kan finde Navn ved hjælp af Hent alle databaser -opkald.

form_name

Du skal kende dit formularnavn for at hente formularoplysninger. Du kan finde formularnavn ved hjælp af Fetch All Forms call.

field_name

Du skal kende dit feltnavn for at opdatere feltindstillinger. Du kan finde feltnavn ved hjælp af Hent alle formularfelter -opkald.

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

GET

URL

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

Anmodningsorgan

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

Kør handling

Parameters

rest_api_key

din API-nøgle

DTYPE_ID

Du skal kende din registreringsidentifikation. Du kan finde ID ved at bruge Hent alle poster opkald.

ACTION_PROPERTY_ID

Du skal kende din feltidentifikator. Du kan finde ID ved at bruge Hent alle formularfelter opkald.

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Anmodningsorgan

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

Svar

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

Forespørgsel (XML)

Format

XML

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Anmodningsorgan

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

Kør handlinger

Parameters

rest_api_key

din API-nøgle

ACTION_PROPERTY_ID

Du skal kende din feltidentifikator. Du kan finde ID ved at bruge Hent alle formularfelter opkald.

dtype_ids

Du skal kende dine registrerings-id'er. Du kan finde ID ved at bruge Hent alle poster-opkald.

json_dtype_ids

Du skal kende dine registrerings-id'er. Du kan finde ID ved at bruge Hent alle poster-opkald.

run_by_all_table_or_report

Følgende parameter er tilgængelig til at køre alle handlinger i tabel eller rapport: run_by_all_table_or_report=true.

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Anmodningsorgan

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

Opdateringsfelt

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

name

Nyt feltnavn. Se alle tilgængelige attributter her

Forespørgsel (JSON)

Format

JSON

Metode

PUT

URL

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

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

PUT

URL

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

Anmodningsorgan

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

Slet felt

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

Forespørgsel (JSON)

Format

JSON

Metode

DELETE

URL

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

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

DELETE

URL

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

Anmodningsorgan

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

Opret felt

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

name

Nyt formfeltnavn

type_name

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

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

Anmodningsorgan

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

Svar: returnerer formularoplysninger

    
{"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ørgsel (XML)

Format

XML

Metode

POST

URL

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

Anmodningsorgan

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

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

Parameters

rest_api_key

din API-nøgle

ENTITY_ID

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/search/sum/ENTITY_ID/ID.json

Anmodningsorgan

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

Svar

    
{total: 3}

Forespørgsel (XML)

Format

XML

Metode

GET

URL

/search/sum/ENTITY_ID/ID.xml

Anmodningsorgan

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

Optag

Sådanne record attributter kan være tilgængelige via REST API.

Unik record-id. Du skal bruge dette for at få adgang til denne post.

app_id

App-id

entity_id

Recordens form-id.

values

Registrer værdier hash. Hvor nøglen er felt-id og værdi er denne feltværdi.

json_values

Record values hash. Hvor nøglen er felt-id og værdi er denne feltværdi. Analog af values_hash men i JSON-format

rel_values

Registrer forholdsværdier hash. Hvor nøglen er felt-id og værdien er det linkede post-id.

Hent alle poster

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

page

Registrerer sidetal. Fra 1 til tabel Registrerer antal/ pr. side .

name_value

Brug parameteren til at få poster af formularen: "field name": "value", "field id": "field name"

fetch_all

For ejere af betalte konti er følgende parameter tilgængelig: fetch_all=true.
For at få et bestemt antal indlæg skal du bruge parameteren per_page.
Begrænsninger for det maksimale antal poster per_page for forskellige planer:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

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

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

GET

URL

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

Anmodningsorgan

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

Parameters

rest_api_key

din API-nøgle

APP_ID

Du skal kende din post-id. Du kan finde ID ved hjælp af Hent alle poster -opkald. Når du kender det, skal du tilføje dette ID til URL i linket nedenfor, dvs. skift /apps/APP_ID/dtypes/ID.json til /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Brug parameteren til at få poster af formularen: "field name": "value", "field id": "field name"

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

/apps/APP_ID/dtypes/ID.json

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

GET

URL

/apps/APP_ID/dtypes/ID.xml

Anmodningsorgan

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

Opdater post

Parameters

rest_api_key

din API-nøgle

APP_ID

values

Optag værdier hash, hvor nøglen er formfelt-id.

json_values

Hvis du bruger jQuery, Ruby eller et andet programmeringssprog, så brug venligst parameteren 'værdier' til at sende kodningsparametre. Hvis din ramme ikke tillader dette, kan du sende postværdier som JSON-streng, men i dette tilfælde angiv dit parameternavn som 'json_values'. Og din JSON-værdistreng vil se sådan ud: "{" aNW4nkW5bdUjldO8oKuSku ": " 2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} "

subforms_values / subforms_json_values

For at oprette eller opdatere underformularer på samme måde skal du bruge 'subforms_values' eller 'json_subforms_values'.
Med nedenstående format:
"{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 underformtype i hovedtabellen.
subform1_id, subform2_id - Forms-id'er, som blev indstillet i indstillinger for property1_id og property2_id.
subform1_record1_id и subform1_record2_id - dette er nye eller eksisterende underformular-records ID'er.
subform1_field1_id, subform1_field2_id - felter ID'er i form subform1_id.
subform2_field1_id, subform2_field2_id - felter ID'er i form subform2_id.

Alle ID'er - det er en 22 tegn URL-gem base64-kode, du kan hente dem fra andre API-opkald eller oprette til nye underformularrekorder.

Forespørgsel (JSON)

Format

JSON

Metode

PUT

URL

/apps/APP_ID/dtypes/ID.json

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Anmodningsorgan

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

Opdater flere poster

Parameters

rest_api_key

din API-nøgle

confirm_action

Følgende parameter er påkrævet for at køre opdatering i tabel eller rapport: confirm_action: update.

ENTITY_ID

Du skal kende dit felts formular-id for at opdatere feltindstillingerne. Du kan finde ENTITY_ID ved at bruge Hent alle formularer opkald.

APP_ID

Du skal kende din database-id for at kunne hente databaseoplysninger. Du kan finde ID ved at bruge Hent alle databaser opkald.

dtype_ids

Du skal kende dine registrerings-id'er. Du kan finde ID ved at bruge Hent alle poster-opkald.

json_dtype_ids

Du skal kende dine registrerings-id'er. Du kan finde ID ved at bruge Hent alle poster-opkald.

update_id

Du skal kende din feltidentifikator. Du kan finde ID ved at bruge Hent alle formularfelter opkald.

update_term

Ny værdi for poster

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Anmodningsorgan

{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ørgsel (XML)

Format

XML

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Anmodningsorgan


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

Opdater alle poster

Parameters

rest_api_key

din API-nøgle

confirm_action

Følgende parameter er påkrævet for at køre opdatering af alle poster i tabel eller rapport: bekræft_handling: opdatering_alle.

ENTITY_ID

Du skal kende dit felts formular-id for at opdatere feltindstillingerne. Du kan finde ENTITY_ID ved at bruge Hent alle formularer opkald.

APP_ID

Du skal kende din database-id for at kunne hente databaseoplysninger. Du kan finde ID ved at bruge Hent alle databaser opkald.

update_id

Du skal kende din feltidentifikator. Du kan finde ID ved at bruge Hent alle formularfelter opkald.

update_term

Ny værdi for poster

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Anmodningsorgan

{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ørgsel (XML)

Format

XML

Metode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Anmodningsorgan


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

Opdater datacelle

Parameters

rest_api_key

din API-nøgle

PROPERTY_ID

DTYPE_ID

val

Ny celleværdi

Forespørgsel (JSON)

Format

JSON

Metode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Anmodningsorgan

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

Svar

    
{"new_value": "John Smith"}

Forespørgsel (XML)

Format

XML

Metode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Anmodningsorgan

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

Slet post

Parameters

rest_api_key

din API-nøgle

APP_ID

Forespørgsel (JSON)

Format

JSON

Metode

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Anmodningsorgan

{"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ørgsel (XML)

Format

XML

Metode

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Anmodningsorgan

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

Slet flere

Parameters

rest_api_key

din API-nøgle

ENTITY_ID

Du skal kende dit felts formular-id for at opdatere feltindstillingerne. Du kan finde ENTITY_ID ved at bruge Hent alle formularer opkald.

APP_ID

Du skal kende din database-id for at kunne hente databaseoplysninger. Du kan finde ID ved at bruge Hent alle databaser opkald.

dtype_ids

Du skal kende dine registrerings-id'er. Du kan finde ID ved at bruge Hent alle poster-opkald.

json_dtype_ids

Du skal kende dine registrerings-id'er. Du kan finde ID ved at bruge Hent alle poster-opkald. (Valgfri)

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Anmodningsorgan

{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ørgsel (XML)

Format

XML

Metode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Anmodningsorgan


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

Slet alt

Parameters

rest_api_key

din API-nøgle

APP_ID

Du skal kende din database-id for at kunne hente databaseoplysninger. Du kan finde ID ved at bruge Hent alle databaser opkald.

ENTITY_ID

Du skal kende dit felts formular-id for at opdatere feltindstillingerne. Du kan finde ENTITY_ID ved at bruge Hent alle formularer opkald.

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

Forespørgsel (JSON)

Format

JSON

Metode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Anmodningsorgan

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

Svar

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

Forespørgsel (XML)

Format

XML

Metode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Anmodningsorgan


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

Opret post

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

Hvis du har brug for dit personlige id, kan du generere UUID (unik identifikator) 22 tegn lang URL-sikker base64 For eksempel i Ruby . Derefter skal du videregive den til 'værdier' hash, for eksempel: værdier => {'id' => ID}, skift til: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, ellers genererer systemet en unik identifikator til dig.

values / json_values

subforms_values / subforms_json_values

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/apps/APP_ID/dtypes.json

Anmodningsorgan

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

Svar: returnerer formularoplysninger

    
{"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ørgsel (XML)

Format

XML

Metode

POST

URL

/apps/APP_ID/dtypes.xml

Anmodningsorgan

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

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

Parameters

rest_api_key

din API-nøgle

APP_ID

ENTITY_ID

view

Du skal kende dit rapport-id for at hente poster. (Valgfri)

search

Kunne du tænke dig et smæk på bordet? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - feltidentifikator, som vi søger efter ( -ALL - - for en poke på alle kolonner),
SEARCH_TERM - hvilket betyder, yake shukaєmo,
SEARCH_CRITERIA - kriterium for en besked, måske en af dem:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

For regelmæssige numre og datoer : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

For en dato i cirka 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øge i flere kolonner med et samlende "AND" -kriterium, skal disse kriterier placeres i en matrix, hvis "ELLER", for eksempel i en separat, f.eks:
[[{"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øgeformlen 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

Antallet af poster i søgeresultaterne, maksimalt er 200.

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

/search/APP_ID.json

Anmodningsorgan

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

Sådan linkes poster:

For at opdatere linket mellem poster skal du sende separat hash til CREATE eller UPDATE record-opkald.

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 "

Denne hash skal være ligesom 'rel' => {rel_id => RECORD_ID} eller 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} hvis du har many-til-many-forhold. Hvor RECORD_ID er det et registrerings-id, som du vil linke med nuværende rekord. Se nedenfor, hvordan du får rel_id.

Parameters

rest_api_key

din API-nøgle

PROPERTY_ID

ENTITY_ID

Du skal kende dit felts formular-id for at opdatere feltindstillinger. Du kan finde ENTITY_ID ved hjælp af Hent alle formularer . Opkald. Når du kender det, skal du bruge for at tilføje dette ENTITY_ID til URL i nedenstående link, dvs. ændre /apps/APP_ID/entities/ENTITY_ID/properties.json til /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

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

Svar

Rapporter

Sådanne rapportattributter kan være tilgængelige via REST API.

name

Navn

Hent rapporter

Parameters

rest_api_key

din API-nøgle

APP_ID

App-id

ENTITY_ID

Tabel (form) ID

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

{"rest_api_key":"API_KEY"}

Svar: returnerer alle tabelrapporter.

    
{"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ørgsel (XML)

Format

XML

Metode

GET

URL

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

Anmodningsorgan: returnerer alle tabelrapporter.

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

Hent fil-URL

For at downloade recordfiler skal du først hente recordværdier, og derefter kan du downloade filen ved hjælp af linket som dette https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, hvor FILE_NAME - filnavn, som du kan få fra postværdier-hash, der ser ud som PROPERTY_ID => VALUE, RECORD_ID - record ID, PROPERTY_ID - field ID.

Upload filer

For at uploade en fil til en post skal du indgive en POST-anmodning til upload_file API-metoden med multipart/form-data-indholdstypeoverskrift og først derefter skal du oprette eller opdatere din post. Så post-ID skal genereres før opkaldene. Og også bliver du nødt til at generere Multipart-overskriften, følg venligst Ruby-eksemplet med MultipartPost-klassen nedenfor. For eksempel lærer du, hvordan du også uploader filen til underformularen.

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

Parameters

rest_api_key

din API-nøgle

APP_ID

property_id

dtype_id

Forespørgsel (JSON)

Format

JSON

Metode

POST

URL

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

Anmodningsorgan

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

Svar

    Uploaded

Fjern filer

Parameters

rest_api_key

din API-nøgle

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Filnavn

Forespørgsel (JSON)

Format

JSON

Metode

GET

URL

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

Anmodningsorgan

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

	# Oprettelse af korrekt opkald med metode: 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 indstil indholdstypen som applikation/json eller applikation/xml   Bemærk XML-formatet for parametre, rodelementet 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
	# Indstilling af indholdstype
  req["Content-Type"] = "application/#{format}"

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

  # Alle opkald via HTTPS og verificering af SSL-certifikater

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


# Sørg for at indstille 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 er inde response.body
puts response.body

Det er velkendt, at softwareudvikling er meget vigtig i disse dage. At have REST API til din software vil øge din produkts popularitet meget. Dette er en grundlæggende REST API, og det skulle være nok til at skabe gode ting. Men hvis du har brug for noget andet, flere metoder osv., er du velkommen til at kontakte os når som helst. Vi ser frem til at høre fra dig!

QuintaDB REST API

Generel information om API-opkald

Database

Form

Felt

Optag

Rapporter

Filer

QuintaDB.com bruger cookies til at give den nødvendige webstedsfunktionalitet og forbedre din oplevelse. Ved at bruge vores hjemmeside accepterer du vores cookiepolitik.