QuintaDB REST API

QuintaDB REST API är utformad för att låsa upp potentialen i de data som lagras i din QuintaDB-databas. Med detta API kan du uppnå mer än vad som för närvarande erbjuds av standard QuintaDB UI. Så här ger vi du kan göra med dina data allt du behöver och på det sätt du behöver. Du kan skapa egna skript, stationära och mobilappar för olika plattformar som iPhone/Android och många fler. Och QuintaDB kommer att vara en plats där du lagrar, delar och hanterar dina data.

Allmän information om API-samtal

Alla samtal ska innehålla REST API-nyckel , som finns i menyn "API" längst upp till höger på sidan.
Resultat returneras i JSON eller XML , beroende på din begäran.
Vi visar en tabell med ett resultat för varje samtal. Webbadressen visas på detta sätt /apps.json , det betyder att du ska ringa https://QuintaDB.com /apps.json i din ansökan. Observera att alla samtal ska använda https och du måste validera SSL-certifikat för servrar.

databas

Sådana databasattribut kan nås via REST API.

Unik databasidentifierare. Du behöver detta för att komma åt databasformuläret och posterna

name

Namn

created_at

Dags när databasen skapades

updated_at

Tidpunkt då databasen senast uppdaterades (ändrade poster eller formulär)

Hämta alla databaser

Parametrar

rest_api_key

din API-nyckel

page

Databaser paginerade med 20 poster per sida. Så om du har 100 databaser kan sidan vara 1..5.

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps.json

Begäran

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

Svar: returnerar dina nuvarande 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
} ]}

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps.xml

Begäran

<?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: returnerar dina nuvarande 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>

Hämta databas efter ID

Parametrar

rest_api_key

din API-nyckel

APP_ID

Du måste känna till din databasidentifierare för att hämta databasinformation. Du kan hitta ID med Hämta alla databaser samtal. När du vet det måste du lägg till detta ID till URL i länken nedan, dvs. ändra /apps/ID.json till /apps/aOWO_dVXHdHie1WeGFE8k2.json

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps/APP_ID.json

Begäran

{"rest_api_key":"API_KEY"}

Svar: returnerar databasinformation

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps/APP_ID.xml

Begäran

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

Svar: returnerar databasinformation

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

Hämta databas efter namn

Parametrar

rest_api_key

din API-nyckel

Namn

Du måste veta ditt databasnamn för att hämta databasinformation. Du kan hitta Namn med Hämta alla databaser .

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps/search.json

Begäran

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

Svar: returnerar databasinformation

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps/search.xml

Begäran

<?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: returnerar databasinformation

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

Uppdatera databas

Parametrar

rest_api_key

din API-nyckel

APP_ID

name

Nytt databasnamn

Skicka begäran (JSON)

Format

JSON

Metod

PUT

URL

/apps/APP_ID.json

Begäran

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

Svar: returnerar databasinformation

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

Skicka begäran (XML)

Format

XML

Metod

PUT

URL

/apps/APP_ID.xml

Begäran

<?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: returnerar databasinformation

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

Radera databas

Parametrar

rest_api_key

din API-nyckel

APP_ID

Skicka begäran (JSON)

Format

JSON

Metod

DELETE

URL

/apps/APP_ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

DELETE

URL

/apps/APP_ID.xml

Begäran

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

After removing database this call returns all databases which were left.

Skapa databas

Parametrar

rest_api_key

din API-nyckel

database_name

databasnamn

form_name

Formnamn. Du kan inte skapa databas utan formulär. Eftersom det inte är vettigt att ha databas utan formulär.

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/apps.json

Begäran

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

Svar: returnerar databasinformation

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

/apps.xml

Begäran

<?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: returnerar databasinformation

    
  <?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 händelse av fel. Du får ett felmeddelande, dvs. Sådant appnamn finns redan.

Form

Sådana formattribut kan nås via REST API.

Unik formuläridentifierare. Du behöver detta för att komma åt detta formulär och formulärposter

name

Namn

desc

Beskrivning

post_action

Lista över mottagare av e-postmeddelanden

Hämta alla databasformulär

Parametrar

rest_api_key

din API-nyckel

APP_ID

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps/APP_ID/entities.json

Begäran

{rest_api_key":"API_KEY"}

Svar: hämta alla databasformulär

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps/APP_ID/entities.xml

Begäran

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

Svar: hämta alla databasformulär

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

Hämta formulär efter ID

Parametrar

rest_api_key

din API-nyckel

APP_ID

Du måste känna till din formuläridentifierare för att hämta formulärinformation. Du kan hitta ID med Hämta alla blanketter . När du vet det måste du lägg till detta ID till URL i länken nedan, dvs. ändra /apps/APP_ID/entities.json till /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps/APP_ID/entities/ID.json

Begäran

{"rest_api_key":"API_KEY"}

Svar: returnerar formulärinformation

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps/APP_ID/entities/ID.xml

Begäran

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

Svar: returnerar formulärinformation

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

Hämta formulär efter namn

Parametrar

rest_api_key

din API-nyckel

database_name

Du måste veta ditt databasnamn för att hämta databasinformation. Du kan hitta Namn med Hämta alla databaser .

form_name

Du måste känna till ditt formulärnamn för att hämta formulärinformation. Du kan hitta formulärnamn med Hämta alla formulär samtal.

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps/search/entities/search.json

Begäran

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

Svar: returnerar formulärinformation

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps/search/entities/search.xml

Begäran

<?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: returnerar formulärinformation

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

Uppdateringsformulär

Parametrar

rest_api_key

din API-nyckel

APP_ID

name

Nytt formulärnamn. Se alla tillgängliga attribut här

Skicka begäran (JSON)

Format

JSON

Metod

PUT

URL

/apps/APP_ID/entities/ID.json

Begäran

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

Svar: returnerar formulärinformation

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

Skicka begäran (XML)

Format

XML

Metod

PUT

URL

/apps/APP_ID/entities/ID.xml

Begäran

<?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: returnerar formulärinformation

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

Radera formulär

Parametrar

rest_api_key

din API-nyckel

APP_ID

Du måste känna till din databasidentifierare. Du kan hitta APP_ID med Hämta alla blanketter . När du vet det måste du lägga till detta APP_ID till URL i länken nedan, dvs. ändra /apps/APP_ID/entities.json till /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Skicka begäran (JSON)

Format

JSON

Metod

DELETE

URL

/apps/APP_ID/entities/ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

DELETE

URL

/apps/APP_ID/entities/ID.xml

Begäran

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

Skapa formulär

Parametrar

rest_api_key

din API-nyckel

APP_ID

name

Form name

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/apps/APP_ID/entities.json

Begäran

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

Svar: returnerar formulärinformation

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

/apps/APP_ID/entities.xml

Begäran

<?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: returnerar formulärinformation

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

Fält

Sådana fältegenskaper kan hämtas via REST API.

Unik fältidentifierare. Du behöver detta för att komma åt det här fältet

entity_id

Fältets formuläridentifierare.

name

Namn

type_name

Namn på fälttyp. 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

Hämta alla formulärfält

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

{rest_api_key":"API_KEY"}

Svar: hämta alla formulärfält

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

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

Begäran

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

Svar: hämta alla formulärfält

    
<?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å fält efter ID

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

Du måste känna till din fältidentifierare för att uppdatera fältinställningarna. Du kan hitta ID med Hämta alla formulärfält . När du vet det behöver du för att lägga till detta ID till URL i länken nedan, dvs. ändra /apps/APP_ID/entities/ENTITY_ID/properties/ID.json till /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHd

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

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

Begäran

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

Get Field by Name

Parametrar

rest_api_key

din API-nyckel

database_name

Du måste veta ditt databasnamn för att hämta databasinformation. Du kan hitta Namn med Hämta alla databaser .

form_name

Du måste känna till ditt formulärnamn för att hämta formulärinformation. Du kan hitta formulärnamn med Hämta alla formulär samtal.

field_name

Du måste känna till ditt fältnamn för att uppdatera fältinställningar. Du kan hitta fältnamn med Hämta alla formulärfält -anrop.

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

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

Begäran

<?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 åtgärd

Parametrar

rest_api_key

din API-nyckel

DTYPE_ID

Du måste känna till din postidentifierare. Du kan hitta ID genom att använda Hämta alla poster-samtal.

ACTION_PROPERTY_ID

Du måste känna till din fältidentifierare. Du kan hitta ID genom att använda Hämta alla formulärfält-anrop.

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/actions/ACTION_PROPERTY_ID.json

Begäran

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

Svar

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Begäran

<?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 åtgärder

Parametrar

rest_api_key

din API-nyckel

ACTION_PROPERTY_ID

Du måste känna till din fältidentifierare. Du kan hitta ID genom att använda Hämta alla formulärfält-anrop.

dtype_ids

Du måste känna till dina registeridentifierare. Du kan hitta ID genom att använda Hämta alla poster-anrop.

json_dtype_ids

Du måste känna till dina registeridentifierare. Du kan hitta ID genom att använda Hämta alla poster-anrop.

run_by_all_table_or_report

Följande parameter är tillgänglig för att köra alla åtgärder i tabell eller rapport: run_by_all_table_or_report=true.

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/actions/ACTION_PROPERTY_ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Begäran

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

Uppdatera fält

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

name

Nytt fältnamn. Se alla tillgängliga attribut här

Skicka begäran (JSON)

Format

JSON

Metod

PUT

URL

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

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

PUT

URL

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

Begäran

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

Radera fält

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

Skicka begäran (JSON)

Format

JSON

Metod

DELETE

URL

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

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

DELETE

URL

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

Begäran

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

Skapa fält

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

name

Nytt formulärfältnamn

type_name

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

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

Begäran

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

Svar: returnerar formulärinformation

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

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

Begäran

<?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: returnerar formulärinformation

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

Parametrar

rest_api_key

din API-nyckel

ENTITY_ID

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/search/sum/ENTITY_ID/ID.json

Begäran

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

Svar

    
{total: 3}

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/search/sum/ENTITY_ID/ID.xml

Begäran

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

Spela in

Sådana postattribut kan nås via REST API.

Unik postidentifierare. Du behöver detta för att få tillgång till denna post.

app_id

App-ID

entity_id

Record's form identifier.

values

Spela in värden hash. Där nyckeln är fält-id och värdet är detta fältvärde.

json_values

Record values hash. Där nyckeln är field id och value är detta fältvärde. Analog av values_hash men i JSON-format

rel_values

Spela in relationer värden hash. Där nyckeln är fält-id och värdet är det länkade post-ID.

Hämta alla poster

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

page

Registrerar sidnummer. Från 1 till tabell Antal poster/ per_sida .

name_value

Använd parametern för att få data av typen: "field name": "value", "field id": "field name"

fetch_all

För ägare av betalkonton är följande parameter tillgänglig: fetch_all=true.
För att få ett specifikt antal inlägg, använd parametern per_page.
Begränsningar för det maximala antalet poster per_page för olika planer:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Begäran kropp
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

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

Begäran

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

Parametrar

rest_api_key

din API-nyckel

APP_ID

Du måste känna till din postidentifierare. Du kan hitta ID med Hämta alla poster . När du vet det måste du lägga till detta ID i URL i länken nedan, dvs. ändra /apps/APP_ID/dtypes/ID.json till /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Använd parametern för att få data av typen: "field name": "value", "field id": "field name"

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

/apps/APP_ID/dtypes/ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

GET

URL

/apps/APP_ID/dtypes/ID.xml

Begäran

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

Uppdatera post

Parametrar

rest_api_key

din API-nyckel

APP_ID

values

Spela in värden hash, där nyckeln är formfält-id.

json_values

Om du använder jQuery, Ruby eller ett annat programmeringsspråk, vänligen använd parametern värden för att skicka kodningsparametrar. Om ditt ramverk inte tillåter detta kan du skicka postvärden som JSON-sträng, men i det här fallet ange ditt parameternamn som 'json_values'. Och din JSON-värden ser ut så här: "{" aNW4nkW5bdUjldO8oKuSku ": " 2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} "

subforms_values / subforms_json_values

För att skapa eller uppdatera underformulär, på samma sätt, använd subforms_values eller 'json_subforms_values'.
Med nedanstå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 "}}} ".

Där property1_id och property2_id - detta är fält-ID: er med en underformstyp i huvudtabellen.
subform1_id, subform2_id - Forms-ID: n, som sattes i inställningar för property1_id och property2_id.
subform1_record1_id и subform1_record2_id - det här är nya eller existerande underformulär-ID.
subform1_field1_id, subform1_field2_id - fält-ID: er i formuläret subform1_id.
subform2_field1_id, subform2_field2_id - fält-ID i formuläret subform2_id.

Alla ID: er är 22 tecken URL-spara base64-kod, du kan hämta dem från andra API-samtal eller skapa för nya underformulärsposter.

Skicka begäran (JSON)

Format

JSON

Metod

PUT

URL

/apps/APP_ID/dtypes/ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Begäran

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

Uppdatera flera poster

Parametrar

rest_api_key

din API-nyckel

confirm_action

Följande parameter krävs för att köra uppdatering i tabell eller rapport: confirm_action: update.

ENTITY_ID

Du måste känna till ditt fälts formuläridentifierare för att uppdatera fältinställningarna. Du kan hitta ENTITY_ID genom att använda Hämta alla formulär-anrop.

APP_ID

Du måste känna till din databasidentifierare för att kunna hämta databasinformation. Du kan hitta ID med Hämta alla databaser-anrop.

dtype_ids

Du måste känna till dina registeridentifierare. Du kan hitta ID genom att använda Hämta alla poster-anrop.

json_dtype_ids

Du måste känna till dina registeridentifierare. Du kan hitta ID genom att använda Hämta alla poster-anrop.

update_id

Du måste känna till din fältidentifierare. Du kan hitta ID genom att använda Hämta alla formulärfält-anrop.

update_term

Nytt värde för poster

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Begäran


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

Uppdatera alla poster

Parametrar

rest_api_key

din API-nyckel

confirm_action

Följande parameter krävs för att köra uppdatering av alla poster i tabell eller rapport: confirm_action: update_all.

ENTITY_ID

Du måste känna till ditt fälts formuläridentifierare för att uppdatera fältinställningarna. Du kan hitta ENTITY_ID genom att använda Hämta alla formulär-anrop.

APP_ID

Du måste känna till din databasidentifierare för att kunna hämta databasinformation. Du kan hitta ID med Hämta alla databaser-anrop.

update_id

Du måste känna till din fältidentifierare. Du kan hitta ID genom att använda Hämta alla formulärfält-anrop.

update_term

Nytt värde för poster

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Begäran


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

Uppdatera datacell

Parametrar

rest_api_key

din API-nyckel

PROPERTY_ID

DTYPE_ID

val

Nytt cellvärde

Skicka begäran (JSON)

Format

JSON

Metod

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Begäran

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

Svar

    
{"new_value": "John Smith"}

Skicka begäran (XML)

Format

XML

Metod

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Begäran

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

Ta bort post

Parametrar

rest_api_key

din API-nyckel

APP_ID

Skicka begäran (JSON)

Format

JSON

Metod

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Begäran

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

Radera flera

Parametrar

rest_api_key

din API-nyckel

ENTITY_ID

Du måste känna till ditt fälts formuläridentifierare för att uppdatera fältinställningarna. Du kan hitta ENTITY_ID genom att använda Hämta alla formulär-anrop.

APP_ID

Du måste känna till din databasidentifierare för att kunna hämta databasinformation. Du kan hitta ID med Hämta alla databaser-anrop.

dtype_ids

Du måste känna till dina registeridentifierare. Du kan hitta ID genom att använda Hämta alla poster-anrop.

json_dtype_ids

Du måste känna till dina registeridentifierare. Du kan hitta ID genom att använda Hämta alla poster-anrop. (valfritt)

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Begäran

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Begäran


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

Radera alla

Parametrar

rest_api_key

din API-nyckel

APP_ID

Du måste känna till din databasidentifierare för att kunna hämta databasinformation. Du kan hitta ID med Hämta alla databaser-anrop.

ENTITY_ID

Du måste känna till ditt fälts formuläridentifierare för att uppdatera fältinställningarna. Du kan hitta ENTITY_ID genom att använda Hämta alla formulär-anrop.

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

Skicka begäran (JSON)

Format

JSON

Metod

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Begäran

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

Svar

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

Skicka begäran (XML)

Format

XML

Metod

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Begäran


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

Skapa post

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

Om du behöver använda ditt personliga ID kan du skapa UUID (unik identifierare) 22 tecken lång URL-säker base64 Till exempel i Ruby . Därefter måste du skicka det till hash-värdena, till exempel: values => {'id' => ID}, ändra till: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, annars genererar systemet en unik identifierare åt dig.

values / json_values

subforms_values / subforms_json_values

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/apps/APP_ID/dtypes.json

Begäran

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

Svar: returnerar formulärinformation

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

Skicka begäran (XML)

Format

XML

Metod

POST

URL

/apps/APP_ID/dtypes.xml

Begäran

<?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: returnerar formulärinformation

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

Parametrar

rest_api_key

din API-nyckel

APP_ID

ENTITY_ID

view

Du måste känna till ditt rapport-ID för att hämta poster. (valfritt)

search

Vill du ha en sväng på bordet? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - fältidentifierare som vi söker efter ( -ALL - - för att söka i alla kolumner),
SEARCH_TERM - värdet vi letar efter,
SEARCH_CRITERIA - kriterium för ett meddelande, kanske ett av dem:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contain, not_contains.

För vanliga nummer och datum : mindre_ än större, mindre_ än_eller_ekvivalent_till, större_och_ekvivalent_till.

För ett datum i ungefär en timme : före, efter, denna_dag_och_ före, denna_dag_och_efter, igår, idag, imorgon, idag_eller_sista, senaste_7_dagar, sista_30_dagar,
sista_60_dagar, sista_90_dagar, sista_120_dagar, nästa_7_dagar, nästa_30_dagar, nästa_60_dagar, nästa_90_dagar, nästa_120_dagar, nästa_n_dagar, sista_n_dagar,
sista veckan, den här veckan, nästa vecka, nuvarande och föregående vecka, aktuell och nästa vecka, nästa_ veckor, sista_ veckor, sista månad, denna månad, nästa månad,
nuvarande_och_förväg_månad, nuvarande_och_nästa_månad, nästa_n_månader, sista_n_månader, sista_år, detta_år, senaste_2_år, nästa_2_år, nuvarande_och_förväg_år,
nuvarande_och_näst_år, nästa_når, sista_n_år.

Systemkolumner : added_by, created_at, updated_at, ip.

Om du vill söka i flera kolumner med ett förenande "OCH" -kriterium ska dessa kriterier placeras i en matris, om "ELLER", sedan till en separat, till exempel:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "är"}, {"a" => "PROPERTY_ID_2", "b" => "A", "o" => "är"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

sökformeln kommer att vara: "Hitta alla poster där PROPERTY_ID_1 OCH PROPERTY_ID_2 är lika med A ELLER PROPERTY_ID_3 är lika med B"

limit

Antalet poster i sökresultaten, maximalt är 200.

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

/search/APP_ID.json

Begäran

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

Relationer

Hur man länkar poster:

För att uppdatera länken mellan poster måste du skicka separat hash till CREATE eller UPDATE record-samtal.

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 "

Denna hash borde vara som 'rel' => {rel_id => RECORD_ID} eller 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} om du har många-till-många-förhållanden. Där RECORD_ID är det ett post-ID som du vill länka till nuvarande post. Se nedan hur du får rel_id.

Parametrar

rest_api_key

din API-nyckel

PROPERTY_ID

ENTITY_ID

Du måste känna till fältets formuläridentifierare för att uppdatera fältinställningar. Du kan hitta ENTITY_ID med Hämta alla formulär . När du vet det behöver du för att lägga till detta ENTITY_ID till URL i länken nedan, dvs. ändra /apps/APP_ID/entities/ENTITY_ID/properties.json till /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

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

Svar

Rapporter

Sådana rapportattribut kan nås via REST API.

name

Namn

Få rapporter

Parametrar

rest_api_key

din API-nyckel

APP_ID

App-ID

ENTITY_ID

Table (Form) ID

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

{"rest_api_key":"API_KEY"}

Svar: returnerar alla 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'
} ]}

Skicka begäran (XML)

Format

XML

Metod

GET

URL

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

Begäran: returnerar alla 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

Hämta fil-URL

För att ladda ner inspelningsfiler måste du hämta postvärden först och sedan kan du ladda ner filen med den här länken https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, där FILE_NAME - filnamn, som du kan få från postvärden hash, som ser ut som PROPERTY_ID => VALUE, RECORD_ID - post-ID, PROPERTY_ID - fält-ID.

Ladda upp filer

För att ladda upp en fil till en post måste du göra en POST-begäran till upload_file API-metoden med multipart/form-data-innehållsrubrik och först efter det måste du skapa eller uppdatera din post. Så post-ID bör genereras före samtalen. Och du måste också skapa rubriken Multipart, följ Ruby-exemplet med klassen MultipartPost nedan. Till exempel lär du dig hur du laddar upp filen i underformuläret.

Ruby-exempel

  
    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

Parametrar

rest_api_key

din API-nyckel

APP_ID

property_id

dtype_id

Skicka begäran (JSON)

Format

JSON

Metod

POST

URL

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

Begäran

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

Svar

    Uploaded

Ta bort filer

Parametrar

rest_api_key

din API-nyckel

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Filnamn

Skicka begäran (JSON)

Format

JSON

Metod

GET

URL

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

Begäran

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

Svar

    File removed

Exempel

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Skapa korrekt samtal med metod: 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

   # Konvertera parametrarna till JSON/XML och ställ in innehållstypen som applikation/json eller applikation/xml   Lägg märke till XML-format för parametrar, rotelementet är 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
	# Ställa in innehållstyp
  req["Content-Type"] = "application/#{format}"

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

  # Alla samtal via HTTPS och verifierande SSL-certifikat

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


# Se till att ställa in din egen API_KEY här
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Svaret kommer in response.body
puts response.body

Det är välkänt att mjukvaruutveckling är väldigt viktigt i dessa dagar. Att ha REST API för din programvara kommer att öka produktens popularitet väldigt mycket. Detta är ett grundläggande REST API och det borde vara tillräckligt för att skapa fantastiska saker. Men om du behöver något annat, fler metoder etc., snälla, gärna kontakta oss när som helst. Vi ser fram emot att höra från dig!

QuintaDB REST API

Allmän information om API-samtal

databas

Form

Fält

Spela in

Rapporter

Filer

QuintaDB.com använder cookies för att tillhandahålla nödvändig webbplatsfunktionalitet och förbättra din upplevelse. Genom att använda vår webbplats godkänner du vår cookiepolicy.