QuintaDB REST API

QuintaDB REST API er hannað til að opna fyrir möguleika gagnanna sem eru geymdir í QuintaDB gagnagrunninum þínum. Með þessu API er hægt að ná meira en nú er í boði með sjálfgefnu QuintaDB UI. Þetta er hvernig við gefum þú getur gert með gögnunum þínum allt sem þú þarft og á þann hátt sem þú þarft. Þú getur búið til þínar eigin forskriftir, skjáborð og farsímaforrit fyrir mismunandi kerfi eins og iPhone/Android og miklu fleiri. Og QuintaDB verður staður þar sem þú geymir, deilir og hefur umsjón með gögnunum þínum.

Almennar upplýsingar um API símtöl

Öll símtöl ættu að innihalda REST API lykil sem er að finna í valmyndinni "API" efst til hægri á síðunni.
Niðurstaða er skilað í JSON eða XML , allt eftir beiðni þinni.
Við munum sýna töflu með niðurstöðu fyrir hvert símtal. Slóðin verður sýnd með þessum hætti /apps.json , það þýðir að þú ættir að hringja í https://QuintaDB.com /apps.json í umsókn þinni. Vinsamlegast athugaðu að öll símtöl ættu að nota https og þú verður að staðfesta SSL vottorð netþjóna.

Gagnagrunnur

Slíkar gagnagrunnseiginleikar geta verið aðgengilegar með REST API.

Einstakt auðkenni gagnagrunns. Þú þarft þetta til að fá aðgang að þessum gagnagrunni og skjölum

name

Nafn

created_at

Tími þegar gagnagrunnur var búinn til

updated_at

Tími þegar gagnagrunnur var síðast uppfærður (breyttum skrám eða eyðublöðum)

Fáðu alla gagnagrunna

Færibreytur

rest_api_key

API lykillinn þinn

page

Gagnasöfn blaðsíðuð af 20 skrám á hverja síðu. Svo ef þú ert með 100 gagnagrunna getur síðan verið 1..5.

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps.json

Aðilinn að beiðni

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

Svar: skilar núverandi gagnagrunnum þínum.

    
{"databases":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2021-04-29T01:26:22-05:00",
 "updated_at"      : "2021-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps.xml

Aðilinn að beiðni

<?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: skilar núverandi gagnagrunnum þínum.

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
  <database>
    <id>aOWO_dVXHdHie1WeGFE8k2</id>
    <name>Database name 1</name>
    <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
    <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
    <dtypes-count type="integer">0</dtypes-count>
    <entities-count type="integer">1</entities-count>
    <properties-count type="integer">0</properties-count>
  </database>
  <database>
    <id>aOWO3eVXHdHie1WeGFE8k2</id>
    <name>Database Name 2</name>
    <created-at type="datetime">2021-04-29T01:26:22-05:00</created-at>
    <updated-at type="datetime">2021-08-16T00:47:56-05:00</updated-at>
    <dtypes-count type="integer">768</dtypes-count>
    <entities-count type="integer">6</entities-count>
    <properties-count type="integer">240</properties-count>
  </database>
</databases>

Fáðu gagnagrunn eftir auðkenni

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Þú verður að þekkja auðkenni gagnagrunnsins til að sækja upplýsingar um gagnagrunninn. Þú getur fundið auðkenni með því að nota Sækja alla gagnagrunna hringingu. Þegar þú veist það þarftu bættu þessu auðkenni við slóðina í krækjunni hér að neðan, þ.e. breyttu /apps/ID.json í /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps/APP_ID.json

Aðilinn að beiðni

{"rest_api_key":"API_KEY"}

Svar: skilar upplýsingum um gagnagrunn

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps/APP_ID.xml

Aðilinn að beiðni

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

Svar: skilar upplýsingum um gagnagrunn

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

Fáðu gagnagrunn eftir nafni

Færibreytur

rest_api_key

API lykillinn þinn

Nafn

Þú verður að þekkja heiti gagnagrunnsins til þess að sækja upplýsingar um gagnagrunninn. Þú getur fundið nafn með því að nota Náðu í alla gagnagrunna .

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps/search.json

Aðilinn að beiðni

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

Svar: skilar upplýsingum um gagnagrunn

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps/search.xml

Aðilinn að beiðni

<?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: skilar upplýsingum um gagnagrunn

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

Uppfæra gagnagrunn

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

name

Nýtt heiti gagnagrunns

Making request (JSON)

Snið

JSON

Aðferð

PUT

URL

/apps/APP_ID.json

Aðilinn að beiðni

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

Svar: skilar upplýsingum um gagnagrunn

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "New database name",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

Making request (XML)

Snið

XML

Aðferð

PUT

URL

/apps/APP_ID.xml

Aðilinn að beiðni

<?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: skilar upplýsingum um gagnagrunn

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

Eyða gagnagrunni

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Making request (JSON)

Snið

JSON

Aðferð

DELETE

URL

/apps/APP_ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

DELETE

URL

/apps/APP_ID.xml

Aðilinn að beiðni

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

Eftir að gagnagrunnur hefur verið fjarlægður skilar þetta símtal öllum gagnagrunnum sem voru eftir.

Búðu til gagnagrunn

Færibreytur

rest_api_key

API lykillinn þinn

database_name

Heiti gagnagrunns

form_name

Heiti eyðublaðs. Þú getur ekki búið til gagnagrunn án forms. Vegna þess að það er ekki skynsamlegt að hafa gagnagrunn án eyðublaða.

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/apps.json

Aðilinn að beiðni

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

Svar: skilar upplýsingum um gagnagrunn

    
{"database":
   {"id"              : "aOWO_dVXHdHie1WeGFE8k2"
    "name"            : "Database Name 1",
    "created_at"      : "2011-08-16T05:42:40-05:00",
    "updated_at"      : "2011-08-16T05:42:40-05:00",
    "dtypes_count"    : 0,
    "entities_count"  : 1,
    "properties_count": 0
    }
}

Making request (XML)

Snið

XML

Aðferð

POST

URL

/apps.xml

Aðilinn að beiðni

<?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: skilar upplýsingum um gagnagrunn

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

Ef um villu er að ræða. Þú færð villuboð, þ.e. Slíkt forritaheiti er þegar til.

Form

Slík formeiginleiki er hægt að nálgast með REST API.

Einstakt auðkenni eyðublaðs. Þú þarft þetta til að fá aðgang að þessu eyðublaði og eyðublöðaskrám

name

Nafn

desc

Lýsing

post_action

Listi yfir viðtakendur tölvupósts tilkynninga

Náðu í öll gagnagrunnseyðublöð

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps/APP_ID/entities.json

Aðilinn að beiðni

{rest_api_key":"API_KEY"}

Svar: sækið öll gagnagrunnseyðublöð

    
{"forms":[
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
 },
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps/APP_ID/entities.xml

Aðilinn að beiðni

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

Svar: sækið öll gagnagrunnseyðublöð

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

Fáðu form eftir auðkenni

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Þú verður að þekkja auðkenni eyðublaðsins til að geta fengið upplýsingar um eyðublaðið. Þú getur fundið auðkenni með því að nota Sæktu öll eyðublöð símtal. Þegar þú veist það þarftu bættu þessu auðkenni við slóðina í krækjunni hér að neðan, þ.e. breyttu /apps/APP_ID/entities.json í /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps/APP_ID/entities/ID.json

Aðilinn að beiðni

{"rest_api_key":"API_KEY"}

Svar: skilar formupplýsingum

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps/APP_ID/entities/ID.xml

Aðilinn að beiðni

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

Svar: skilar formupplýsingum

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

Fáðu form eftir nafni

Færibreytur

rest_api_key

API lykillinn þinn

database_name

Þú verður að þekkja heiti gagnagrunnsins til þess að sækja upplýsingar um gagnagrunninn. Þú getur fundið nafn með því að nota Náðu í alla gagnagrunna .

form_name

Þú verður að vita nafnið á eyðublaðinu til að geta náð í formupplýsingar. Þú getur fundið formheiti með Náðu í öll form símtal.

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps/search/entities/search.json

Aðilinn að beiðni

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

Svar: skilar formupplýsingum

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps/search/entities/search.xml

Aðilinn að beiðni

<?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: skilar formupplýsingum

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

Uppfæra form

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

name

Nýtt heiti eyðublaðs. Sjá alla tiltæka eiginleika hér

Making request (JSON)

Snið

JSON

Aðferð

PUT

URL

/apps/APP_ID/entities/ID.json

Aðilinn að beiðni

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

Svar: skilar formupplýsingum

    
{"form":   
{   
"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
"name"            : "New form name",
"desc"            : "Form description",
"post_action"     : "email@email.com",
"position"        : 0,
"sort_by"         : null,
"asc"             : false,
"per_page"        : 10,
"allow_delete"    : false,
"new_widget"      : null,
"records_widget"  : null,
"target_page"     : null,
"allow_database"  : true,
"send_emails"     : true,
"settings"        : null
     }
}

Making request (XML)

Snið

XML

Aðferð

PUT

URL

/apps/APP_ID/entities/ID.xml

Aðilinn að beiðni

<?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: skilar formupplýsingum

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

Eyða eyðublaði

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Þú verður að þekkja auðkenni gagnagrunnsins. Þú getur fundið APP_ID með því að nota Náðu í öll form símtal. Þegar þú veist það þarftu að bæta þessu APP_ID við URL krækjuna hér að neðan, þ.e. breyta /apps/APP_ID/entities.json í /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)

Snið

JSON

Aðferð

DELETE

URL

/apps/APP_ID/entities/ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

DELETE

URL

/apps/APP_ID/entities/ID.xml

Aðilinn að beiðni

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

Búa til eyðublað

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

name

Heiti eyðublaðs

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/apps/APP_ID/entities.json

Aðilinn að beiðni

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

Svar: skilar formupplýsingum

    
{"form":   
{   
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "New form",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

Making request (XML)

Snið

XML

Aðferð

POST

URL

/apps/APP_ID/entities.xml

Aðilinn að beiðni

<?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: skilar formupplýsingum

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

Reitur

Slíka reitareiginleika er hægt að sækja um REST API.

Einstakt auðkenni reits. Þú þarft þetta til að fá aðgang að þessum reit

entity_id

Auðkenni eyðublaðsins.

name

Nafn

type_name

Heiti reitategundar. Get af einum 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

Náðu í alla formreiti

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

{rest_api_key":"API_KEY"}

Svar: sækið alla formreiti

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

Making request (XML)

Snið

XML

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Svar: sækið alla formreiti

    
<?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áðu Field eftir auðkenni

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

Þú verður að þekkja svæðisauðkenni þitt til að uppfæra vettvangsstillingar. Þú getur fundið auðkenni með því að nota Sæktu öll form reiti símtal. Þegar þú veist það þarftu til að bæta þessu auðkenni við URL í krækjunni hér að neðan, þ.e. breyta /apps/APP_ID/entities/ENTITY_ID/properties/ID.json í /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHd

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Svar

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
 <id>clrSoltHDdQyozW5NcLrGd</id>
 <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
 <name>test</name>
 <desc nil="true"></desc>
 <type-name>string</type-name>
 <default></default>
 <validate-options></validate-options>
 <position type="integer">0</position>
 <visible type="boolean">true</visible>
 <size type="integer">50</size>
 <cols type="integer">43</cols>
 <rows type="integer">10</rows>
</field>

Fáðu reit eftir nafni

Færibreytur

rest_api_key

API lykillinn þinn

database_name

Þú verður að þekkja heiti gagnagrunnsins til þess að sækja upplýsingar um gagnagrunninn. Þú getur fundið nafn með því að nota Náðu í alla gagnagrunna .

form_name

Þú verður að vita nafnið á eyðublaðinu til að geta náð í formupplýsingar. Þú getur fundið formheiti með Náðu í öll form símtal.

field_name

Þú verður að þekkja reitanafn þitt til að uppfæra reitastillingar. Þú getur fundið heiti reits með Náðu í öll form reiti símtal.

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Keyra aðgerð

Færibreytur

rest_api_key

API lykillinn þinn

DTYPE_ID

Þú verður að þekkja skráningarauðkennið þitt. Þú getur fundið auðkenni með því að nota Sækja allar skrár símtal.

ACTION_PROPERTY_ID

Þú verður að vita reitauðkennið þitt. Þú getur fundið auðkenni með því að nota Sækja alla eyðublaðsreitir kalla.

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/actions/ACTION_PROPERTY_ID.json

Aðilinn að beiðni

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

Svar

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

Making request (XML)

Snið

XML

Aðferð

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Aðilinn að beiðni

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

Keyra aðgerðir

Færibreytur

rest_api_key

API lykillinn þinn

ACTION_PROPERTY_ID

Þú verður að vita reitauðkennið þitt. Þú getur fundið auðkenni með því að nota Sækja alla eyðublaðsreitir kalla.

dtype_ids

Þú verður að þekkja skjölin þín. Þú getur fundið auðkenni með því að nota Sækja allar færslur símtalið.

json_dtype_ids

Þú verður að þekkja skjölin þín. Þú getur fundið auðkenni með því að nota Sækja allar færslur símtalið.

run_by_all_table_or_report

Eftirfarandi færibreyta er tiltæk til að keyra allar aðgerðir í töflu eða skýrslu: run_by_all_table_or_report=true.

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/actions/ACTION_PROPERTY_ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Aðilinn að beiðni

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

Uppfæra reit

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

name

Nýtt reitanafn. Sjá alla tiltæka eiginleika hér

Making request (JSON)

Snið

JSON

Aðferð

PUT

URL

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

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

PUT

URL

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

Aðilinn að beiðni

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

Eyða reit

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

Making request (JSON)

Snið

JSON

Aðferð

DELETE

URL

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

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

DELETE

URL

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

Aðilinn að beiðni

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

Búa til reit

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

name

Nýtt form reitanafn

type_name

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

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

Aðilinn að beiðni

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

Svar: skilar formupplýsingum

    
{"field": 
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

Making request (XML)

Snið

XML

Aðferð

POST

URL

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

Aðilinn að beiðni

<?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: skilar formupplýsingum

    
<?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áðu samtals eftir dálki

Færibreytur

rest_api_key

API lykillinn þinn

ENTITY_ID

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/search/sum/ENTITY_ID/ID.json

Aðilinn að beiðni

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

Svar

    
{total: 3}

Making request (XML)

Snið

XML

Aðferð

GET

URL

/search/sum/ENTITY_ID/ID.xml

Aðilinn að beiðni

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

Svar

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

Record

Slík skráareiginleikar geta verið aðgengileg í gegnum REST API.

Einkvæmt færsluauðkenni. Þú þarft þetta til að fá aðgang að þessari skrá.

app_id

auðkenni forrits

entity_id

Form auðkenni skráningar.

values

Record values hash. Where key is field id and value is this field value.

json_values

Skrá gildi kjötkássa. Þar sem lykillinn er reitarauðkenni og gildi er þetta svæðisgildi. Hliðstæða values_hash en á JSON sniði

rel_values

Skráðu sambandsgildi kjötkássa. Þar sem lykill er reitauðkenni og gildi er tengt auðkenni færslu.

Náðu í allar færslur

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

page

Skrár blaðsíðunúmer. Frá 1 til töflu Fjöldi færslna/ á hverja síðu .

name_value

Notaðu færibreytuna til að fá gögn af gerðinni: "field name": "value", "field id": "field name"

fetch_all

Fyrir eigendur greiddra reikninga er eftirfarandi færibreyta tiltæk: fetch_all=true.
Til að fá ákveðinn fjölda pósta skaltu nota per_page færibreytuna.
Takmarkanir á hámarksfjölda færslna per_page fyrir mismunandi áætlanir:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Beiðni um stofnun
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

GET

URL

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

Aðilinn að beiðni

<?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áðu skrá

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Þú verður að þekkja skjalaauðkenni þitt. Þú getur fundið auðkenni með því að nota Náðu í allar skrár hringingu. Þegar þú veist það þarftu að bæta þessu auðkenni við slóðina í krækjuna hér að neðan, þ.e. breyta /apps/APP_ID/dtypes/ID.json í /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Notaðu færibreytuna til að fá gögn af gerðinni: "field name": "value", "field id": "field name"

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

/apps/APP_ID/dtypes/ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

GET

URL

/apps/APP_ID/dtypes/ID.xml

Aðilinn að beiðni

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

Uppfærðu færslu

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

values

Skráðu gildi kjötkássa, þar sem lykillinn er auðkenni formreits.

json_values

Ef þú notar jQuery, Ruby eða annað forritunarmál þá, vinsamlegast notaðu 'gildi' færibreytu til að senda kóðunarfæribreytur. Hins vegar, ef ramminn þinn leyfir þetta ekki, geturðu sent metgildi sem JSON streng, en í þessu tilfelli tilgreindu breytuheiti þitt sem 'json_values'. Og JSON gildisstrengurinn þinn mun líta svona út: "{" aNW4nkW5bdUjldO8oKuSku ": " 2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} "

subforms_values / subforms_json_values

Til að búa til eða uppfæra undirform, á sama hátt, notaðu 'subforms_values' eða 'json_subforms_values'.
Með sniði hér að neðan:
"{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 ", undirform2_field2_id: "dd "}}} ".

Þar sem property1_id og property2_id - þetta eru Fields ID með undirformsgerð í aðaltöflu.
subform1_id, subform2_id - Auðkenni eyðublaða, sem var stillt í stillingum property1_id og property2_id.
subform1_record1_id и subform1_record2_id - þetta er nýtt eða til staðar auðkenni undirforma.
subform1_field1_id, subform1_field2_id - reiti auðkenni í formi subform1_id.
subform2_field1_id, subform2_field2_id - reiti auðkenni í formi subform2_id.

Öll auðkenni - það er 22 stafir með URL-vistun base64 kóða, þú getur fengið þau úr öðrum API símtölum eða búið til nýjar undirform skrár.

Making request (JSON)

Snið

JSON

Aðferð

PUT

URL

/apps/APP_ID/dtypes/ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Aðilinn að beiðni

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

Uppfærðu margar færslur

Færibreytur

rest_api_key

API lykillinn þinn

confirm_action

Eftirfarandi færibreyta er nauðsynleg til að keyra uppfærslu í töflu eða skýrslu: confirm_action: update.

ENTITY_ID

Þú verður að þekkja eyðublaðaauðkenni svæðisins þíns til að uppfæra svæðisstillingar. Þú getur fundið ENTITY_ID með því að nota Sæktu öll eyðublöð símtalið.

APP_ID

Þú verður að þekkja auðkenni gagnagrunnsins til að ná í gagnagrunnsupplýsingar. Þú getur fundið auðkenni með því að nota Sæktu alla gagnagrunna símtalið.

dtype_ids

Þú verður að þekkja skjölin þín. Þú getur fundið auðkenni með því að nota Sækja allar færslur símtalið.

json_dtype_ids

Þú verður að þekkja skjölin þín. Þú getur fundið auðkenni með því að nota Sækja allar færslur símtalið.

update_id

Þú verður að vita reitauðkennið þitt. Þú getur fundið auðkenni með því að nota Sækja alla eyðublaðsreitir kalla.

update_term

Nýtt gildi fyrir færslur

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Aðilinn að beiðni


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

Uppfæra allar færslur

Færibreytur

rest_api_key

API lykillinn þinn

confirm_action

Eftirfarandi færibreyta er nauðsynleg til að keyra uppfærslu á öllum færslum í töflu eða skýrslu: confirm_action: update_all.

ENTITY_ID

Þú verður að þekkja eyðublaðaauðkenni svæðisins þíns til að uppfæra svæðisstillingar. Þú getur fundið ENTITY_ID með því að nota Sæktu öll eyðublöð símtalið.

APP_ID

Þú verður að þekkja auðkenni gagnagrunnsins til að ná í gagnagrunnsupplýsingar. Þú getur fundið auðkenni með því að nota Sæktu alla gagnagrunna símtalið.

update_id

Þú verður að vita reitauðkennið þitt. Þú getur fundið auðkenni með því að nota Sækja alla eyðublaðsreitir kalla.

update_term

Nýtt gildi fyrir færslur

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Aðilinn að beiðni


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

Uppfærðu gagnasellu

Færibreytur

rest_api_key

API lykillinn þinn

PROPERTY_ID

DTYPE_ID

val

Nýtt klefi gildi

Making request (JSON)

Snið

JSON

Aðferð

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Aðilinn að beiðni

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

Svar

    
{"new_value": "John Smith"}

Making request (XML)

Snið

XML

Aðferð

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Aðilinn að beiðni

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

Eyða skrá

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Making request (JSON)

Snið

JSON

Aðferð

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Aðilinn að beiðni

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

Delete multiple

Færibreytur

rest_api_key

API lykillinn þinn

ENTITY_ID

Þú verður að þekkja eyðublaðaauðkenni svæðisins þíns til að uppfæra svæðisstillingar. Þú getur fundið ENTITY_ID með því að nota Sæktu öll eyðublöð símtalið.

APP_ID

Þú verður að þekkja auðkenni gagnagrunnsins til að ná í gagnagrunnsupplýsingar. Þú getur fundið auðkenni með því að nota Sæktu alla gagnagrunna símtalið.

dtype_ids

Þú verður að þekkja skjölin þín. Þú getur fundið auðkenni með því að nota Sækja allar færslur símtalið.

json_dtype_ids

Þú verður að þekkja skjölin þín. Þú getur fundið auðkenni með því að nota Sækja allar færslur símtalið. (Valfrjálst)

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Aðilinn að beiðni

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

Making request (XML)

Snið

XML

Aðferð

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Aðilinn að beiðni


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

Eyða öllu

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

Þú verður að þekkja auðkenni gagnagrunnsins til að ná í gagnagrunnsupplýsingar. Þú getur fundið auðkenni með því að nota Sæktu alla gagnagrunna símtalið.

ENTITY_ID

Þú verður að þekkja eyðublaðaauðkenni svæðisins þíns til að uppfæra svæðisstillingar. Þú getur fundið ENTITY_ID með því að nota Sæktu öll eyðublöð símtalið.

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

Making request (JSON)

Snið

JSON

Aðferð

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Aðilinn að beiðni

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

Svar

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

Making request (XML)

Snið

XML

Aðferð

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Aðilinn að beiðni


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

Búðu til færslu

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

Ef þú þarft að nota persónulegt auðkenni þitt geturðu búið til UUID (einstakt auðkenni) 22 stafir að lengd, URL-öruggur base64 Til dæmis í Ruby . Næst þarftu að senda það í 'gildi' kjötkássuna, til dæmis: gildi => {'id' => ID}, breyta til: gildi => {'id' => '22adadVXHdHie1WeGFE8k2'}, annars mun kerfið búa til einstakt auðkenni fyrir þig.

values / json_values

subforms_values / subforms_json_values

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/apps/APP_ID/dtypes.json

Aðilinn að beiðni

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

Svar: skilar formupplýsingum

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

Making request (XML)

Snið

XML

Aðferð

POST

URL

/apps/APP_ID/dtypes.xml

Aðilinn að beiðni

<?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: skilar formupplýsingum

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

Leita

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

ENTITY_ID

view

Þú verður að þekkja skýrsluauðkennið þitt til að geta fengið skrár. (Valfrjálst)

search

Viltu fletta á borðið? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - reitauðkenni sem við erum að leita eftir ( -ALL - - fyrir pælingu í öllum dálkum),
SEARCH_TERM - sem þýðir, yake shukaєmo,
SEARCH_CRITERIA - viðmið fyrir skilaboð, kannski eitt af þeim:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Fyrir venjulegar tölur og dagsetningar : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Fyrir stefnumót í um klukkustund : 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.

Kerfisdálkar : added_by, created_at, updated_at, ip.

Ef þú vilt leita í nokkrum dálkum með sameiningar „OG“ viðmiðun, þá ættu þessi viðmið að vera sett í eitt fylki, ef „EÐA“, þá í sérstakan, til dæmis:
[[{"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"}]]

leitarformúlan verður: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Fjöldi meta í leitarniðurstöðunum, hámarkið er 200.

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

/search/APP_ID.json

Aðilinn að beiðni

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

Sambönd

Hvernig á að tengja skrár:

Til að uppfæra hlekk á milli skjala verður þú að fara með aðskildan kjötkássa í CREATE eða UPDATE plötusímtal.

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 "

Þetta kjötkássa ætti að vera eins og 'rel' => {rel_id => RECORD_ID} eða 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} ef þú ert með mörg til mörg samband. Þar sem RECORD_ID er það auðkenni færslu sem þú vilt tengja við núverandi met. Vinsamlegast sjáðu hér að neðan hvernig á að fá rel_id.

Færibreytur

rest_api_key

API lykillinn þinn

PROPERTY_ID

ENTITY_ID

Þú verður að þekkja form auðkenni reits þíns til að uppfæra svæðisstillingar. Þú getur fundið ENTITY_ID með því að nota Hringdu í öll form símtal. Þegar þú veist það þarftu að bæta þessu ENTITY_ID við slóðina í krækjunni hér að neðan, þ.e. breyta /apps/APP_ID/entities/ENTITY_ID/properties.json í /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Svar

Skýrslur

Slíkar skýrslueinkenni geta verið aðgengilegar í gegnum REST API.

name

Nafn

Fáðu skýrslur

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

auðkenni forrits

ENTITY_ID

Tafla (eyðublað) auðkenni

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

{"rest_api_key":"API_KEY"}

Svar: skilar öllum töfluskýrslum.

    
{"reports":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Report Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "entity_id"    : 'aEWQZdIXfahOqWvcvwrGTP',
 "app_id"  : 'ddIbpcNSncW5xcHxpdHCoW'
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Report Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "entity_id"       : 'RtWQZdIXfahOqWvcvwrGTP',
 "app_id"          : 'ddIbpcNSncW5xcHxpdHCoW'
} ]}

Making request (XML)

Snið

XML

Aðferð

GET

URL

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

Aðilinn að beiðni: skilar öllum töfluskýrslum.

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

Skrár

Fá vefslóð skráar

Til þess að hlaða niður skrám þarftu að sækja metgildi fyrst og þá geturðu sótt skrána með því að nota hlekkinn eins og þennan https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, þar sem FILE_NAME - skráarheiti, sem þú getur fengið frá skráargildum kjötkássa, sem lítur út eins og PROPERTY_ID => VALUE, RECORD_ID - skráningarauðkenni, PROPERTY_ID - auðkenni reits.

Hlaða inn skrám

Til þess að hlaða skrá inn í skrá þarftu að leggja fram POST beiðni um upload_file API aðferðina með haus fyrir fjölhluta/form-gagna innihalds og fyrst eftir það þarftu að búa til eða uppfæra færsluna þína. Svo skráningarauðkenni ætti að mynda fyrir símtölin. Og einnig þarftu að búa til Multipart haus, vinsamlegast fylgdu Ruby dæminu með MultipartPost bekknum hér að neðan. Sem dæmi lærirðu hvernig á að hlaða skránni inn í undirformið líka.

Ruby dæmi

  
    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

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

property_id

dtype_id

Making request (JSON)

Snið

JSON

Aðferð

POST

URL

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

Aðilinn að beiðni

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

Svar

    Uploaded

Fjarlægðu skrár

Færibreytur

rest_api_key

API lykillinn þinn

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Skráarheiti

Making request (JSON)

Snið

JSON

Aðferð

GET

URL

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

Aðilinn að beiðni

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

Svar

    File removed

Dæmi

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Creating proper call with Method: GET/POST/PUT/DELETE
  req = case method
          when "get"
            Net::HTTP::Get.new(uri.path) 
          when "post" 
            Net::HTTP::Post.new(uri.path)
          when "put"
            Net::HTTP::Put.new(uri.path)
          when "delete"
            Net::HTTP::Delete.new(uri.path)
        end

   # Umbreyta breytum í JSON/XML og stilltu innihaldsgerðina sem forrit/json eða forrit/xml   Takið eftir XML sniði fyrir breytur, rótareiningin 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
	# Stilla tegund efnis
  req["Content-Type"] = "application/#{format}"

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

  # Öll símtöl í gegnum HTTPS og staðfesta SSL vottorð

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


# Gakktu úr skugga um að setja eigin API_KEY hér
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Svarið verður í response.body
puts response.body

Það er vel þekkt að hugbúnaðargerð er mjög mikilvæg þessa dagana. Að hafa REST API fyrir hugbúnaðinn þinn mun auka vinsældir þínar mjög mikið. Þetta er grunn REST API og það ætti að vera nóg til að búa til frábæra hluti. Hins vegar, ef vantar eitthvað annað, fleiri aðferðir o.s.frv., vinsamlegast ekki hika við að hafðu samband hvenær sem er. Við hlökkum til að heyra í þér!

QuintaDB REST API

Almennar upplýsingar um API símtöl

Gagnagrunnur

Form

Reitur

Record

Skýrslur

Skrár

QuintaDB.com notar vafrakökur til að veita nauðsynlega virkni síðunnar og bæta upplifun þína. Með því að nota vefsíðu okkar samþykkir þú stefnu okkar um vafrakökur.