QuintaDB REST API

Tá an QuintaDB REST API deartha chun acmhainn na sonraí atá stóráilte i do bhunachar sonraí QuintaDB a dhíghlasáil. Trí úsáid a bhaint as an API seo is féidir leat níos mó a bhaint amach ná mar a thairgeann an Chomhéadain réamhshocraithe QuintaDB faoi láthair. Seo mar a thugaimid is féidir leat gach rud a theastaíonn uait a dhéanamh le do chuid sonraí agus ar an mbealach a theastaíonn uait. Is féidir leat do scripteanna féin, deasc agus feidhmchlár soghluaiste a chruthú d’ardáin éagsúla mar iPhone/Android agus go leor eile. Agus beidh QuintaDB ina áit ina ndéanann tú do chuid sonraí a stóráil, a roinnt agus a bhainistiú.

Faisnéis ghinearálta faoi ghlaonna API

Ba chóir go mbeadh REST eochair API i ngach glao, a d’fhéadfaí a fháil i roghchlár "API" ag barr na láimhe deise den leathanach.
Seoltar Toradh ar ais i JSON nó XML , ag brath ar d’iarratas.
Taispeánfaimid tábla le toradh do gach glao. Taispeánfar an URL ar an mbealach seo /apps.json , ciallaíonn sé gur cheart duit https://QuintaDB.com /apps.json a ghlaoch i d’iarratas. Tabhair faoi deara gur chóir do gach glao https a úsáid agus caithfidh tú deimhniú SSL freastalaithe a bhailíochtú.

Bunachar Sonraí

Is féidir a leithéid de tréithe bunachar sonraí a bheith inrochtana trí REST API.

Aitheantóir uathúil bunachar sonraí. Teastóidh sé seo uait chun foirmeacha agus taifid an bhunachar sonraí seo a rochtain

name

Ainm

created_at

Am nuair a cruthaíodh bunachar sonraí

updated_at

Am nuair a nuashonraíodh an bunachar sonraí go deireanach (taifid nó foirmeacha athraithe)

Get All Databases

Paraiméadair

rest_api_key

do eochair API

page

Bunachair sonraí le 20 taifead in aghaidh an leathanaigh. Mar sin má tá 100 bunachar sonraí agat, is féidir leathanach a bheith 1..5.

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps.json

Comhlacht iarrtha

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

Freagra: returns your current databases.

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

Formáid

XML

Modh

GET

URL

/apps.xml

Comhlacht iarrtha

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

Freagra: returns your current databases.

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

Faigh Bunachar Sonraí le ID

Paraiméadair

rest_api_key

do eochair API

APP_ID

Caithfidh tú aitheantóir do bhunachar sonraí a bheith ar eolas agat chun faisnéis bunachar sonraí a fháil. Is féidir leat ID a fháil trí ghlao Fetch Gach Bunachar Sonraí Nuair a bheidh sé ar eolas agat, beidh ort é a dhéanamh cuir an ID seo le URL sa nasc thíos, ie athraigh /apps/ID.json go /apps/aOWO_dVXHdHie1WeGFE8k2.json

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps/APP_ID.json

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Formáid

XML

Modh

GET

URL

/apps/APP_ID.xml

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Faigh Bunachar Sonraí de réir Ainm

Paraiméadair

rest_api_key

do eochair API

Ainm

Caithfidh ainm do bhunachar sonraí a bheith ar eolas agat chun faisnéis bunachar sonraí a fháil. Is féidir leat Ainm a fháil trí úsáid a bhaint as Fetch Gach Bunachar Sonraí .

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps/search.json

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Formáid

XML

Modh

GET

URL

/apps/search.xml

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Nuashonraigh an bunachar sonraí

Paraiméadair

rest_api_key

do eochair API

APP_ID

name

Ainm bunachar sonraí nua

Making request (JSON)

Formáid

JSON

Modh

PUT

URL

/apps/APP_ID.json

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Formáid

XML

Modh

PUT

URL

/apps/APP_ID.xml

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Scrios Bunachar Sonraí

Paraiméadair

rest_api_key

do eochair API

APP_ID

Making request (JSON)

Formáid

JSON

Modh

DELETE

URL

/apps/APP_ID.json

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra

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

Formáid

XML

Modh

DELETE

URL

/apps/APP_ID.xml

Comhlacht iarrtha

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

Freagra

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

Tar éis an bunachar sonraí a bhaint, seolann an glao seo gach bunachar sonraí a bhí fágtha.

Cruthaigh Bunachar Sonraí

Paraiméadair

rest_api_key

do eochair API

database_name

Ainm an bhunachar sonraí

form_name

Ainm na foirme. Ní féidir leat bunachar sonraí a chruthú gan foirm. Toisc nach ndéanann sé ciall bunachar sonraí a bheith agat gan foirmeacha.

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/apps.json

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

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

Formáid

XML

Modh

POST

URL

/apps.xml

Comhlacht iarrtha

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

Freagra: seoltar faisnéis bunachar sonraí ar ais

    
  <?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 gcás earráide. Gheobhaidh tú teachtaireacht earráide, ie 'Tá ainm an app sin ann cheana'.

Foirm

Is féidir a leithéid de tréithe foirme a bheith inrochtana trí REST API.

Aitheantóir uathúil foirme. Teastóidh sé seo uait chun an fhoirm seo a rochtain agus taifid a fhoirmiú

name

Ainm

desc

Tuairisc

post_action

Liosta de na faighteoirí fógraí ríomhphoist

Faigh gach foirm bunachar sonraí

Paraiméadair

rest_api_key

do eochair API

APP_ID

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps/APP_ID/entities.json

Comhlacht iarrtha

{rest_api_key":"API_KEY"}

Freagra: faigh gach foirm bunachar sonraí

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

Formáid

XML

Modh

GET

URL

/apps/APP_ID/entities.xml

Comhlacht iarrtha

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

Freagra: faigh gach foirm bunachar sonraí

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

Faigh Foirm le ID

Paraiméadair

rest_api_key

do eochair API

APP_ID

Caithfidh tú d`aitheantóir foirme a bheith ar eolas agat chun faisnéis fhoirm a fháil. Is féidir leat ID a fháil trí ghlaoch Fetch All Forms a luaithe is a bheidh sé ar eolas agat, beidh ort é a dhéanamh cuir an ID seo le URL sa nasc thíos, ie athraigh /apps/APP_ID/entities.json go /apps/aOWO_dVXHdHie1WeGFE8k2/entities.jso

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps/APP_ID/entities/ID.json

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra: tuairisceáin faisnéis fhoirm

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

Formáid

XML

Modh

GET

URL

/apps/APP_ID/entities/ID.xml

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Faigh Foirm de réir Ainm

Paraiméadair

rest_api_key

do eochair API

database_name

Caithfidh ainm do bhunachar sonraí a bheith ar eolas agat chun faisnéis bunachar sonraí a fháil. Is féidir leat Ainm a fháil trí úsáid a bhaint as Fetch Gach Bunachar Sonraí .

form_name

Caithfidh ainm do fhoirm a bheith ar eolas agat chun faisnéis fhoirm a fháil. Is féidir leat Ainm na Foirme a fháil trí úsáid a bhaint as Fetch All Forms .

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps/search/entities/search.json

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Formáid

XML

Modh

GET

URL

/apps/search/entities/search.xml

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Foirm nuashonraithe

Paraiméadair

rest_api_key

do eochair API

APP_ID

name

Ainm foirme nua. Féach na tréithe go léir atá ar fáil anseo

Making request (JSON)

Formáid

JSON

Modh

PUT

URL

/apps/APP_ID/entities/ID.json

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Formáid

XML

Modh

PUT

URL

/apps/APP_ID/entities/ID.xml

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Scrios an fhoirm

Paraiméadair

rest_api_key

do eochair API

APP_ID

Caithfidh tú aitheantóir do bhunachar sonraí a bheith ar eolas agat. Is féidir leat APP_ID a fháil trí ghlao Fetch All Forms a luaithe is a bheidh sé ar eolas agat, beidh ort an APP_ID seo a chur le URL i an nasc thíos, ie athraigh /apps/APP_ID/entities.json go /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Making request (JSON)

Formáid

JSON

Modh

DELETE

URL

/apps/APP_ID/entities/ID.json

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra

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

Formáid

XML

Modh

DELETE

URL

/apps/APP_ID/entities/ID.xml

Comhlacht iarrtha

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

Freagra

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

Cruthaigh Foirm

Paraiméadair

rest_api_key

do eochair API

APP_ID

name

Ainm na foirme

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/apps/APP_ID/entities.json

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Formáid

XML

Modh

POST

URL

/apps/APP_ID/entities.xml

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Réimse

Is féidir a leithéid de airíonna páirce a fháil trí REST API.

Aitheantóir uathúil réimse. Teastóidh sé seo uait chun an réimse seo a rochtain

entity_id

Aitheantóir foirme Field.

name

Ainm

type_name

Ainm cineál páirce. An féidir le duine de: 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

Faigh gach réimse foirme

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

{rest_api_key":"API_KEY"}

Freagra: faigh gach réimse foirme

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

Formáid

XML

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra: faigh gach réimse foirme

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

Faigh Réimse le ID

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

Caithfidh tú do aitheantóir réimse a bheith ar eolas agat chun socruithe réimse a nuashonrú. Is féidir leat ID a fháil trí ghlaoch Fetch All Form Fields Nuair a bheidh sé ar eolas agat, beidh ort é chun an ID seo a chur le URL sa nasc thíos, ie athraigh /apps/APP_ID/entities/ENTITY_ID/properties/ID.json go /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra

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

Formáid

XML

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

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

Faigh Réimse de réir Ainm

Paraiméadair

rest_api_key

do eochair API

database_name

Caithfidh ainm do bhunachar sonraí a bheith ar eolas agat chun faisnéis bunachar sonraí a fháil. Is féidir leat Ainm a fháil trí úsáid a bhaint as Fetch Gach Bunachar Sonraí .

form_name

Caithfidh ainm do fhoirm a bheith ar eolas agat chun faisnéis fhoirm a fháil. Is féidir leat Ainm na Foirme a fháil trí úsáid a bhaint as Fetch All Forms .

field_name

Caithfidh tú d`ainm réimse a bheith ar eolas agat chun socruithe réimse a nuashonrú. Is féidir leat ainm réimse a fháil trí Fetch All Form Fields a ghlaoch.

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

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

Formáid

XML

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

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

Rith gníomh

Paraiméadair

rest_api_key

do eochair API

DTYPE_ID

Caithfidh aitheantóir do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead.

ACTION_PROPERTY_ID

Caithfidh tú d'aitheantóir réimse a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Réimse Foirme.

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/actions/ACTION_PROPERTY_ID.json

Comhlacht iarrtha

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

Freagra

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

Making request (XML)

Formáid

XML

Modh

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Comhlacht iarrtha

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

Freagra

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

Rith gníomhartha

Paraiméadair

rest_api_key

do eochair API

ACTION_PROPERTY_ID

Caithfidh tú d'aitheantóir réimse a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Réimse Foirme.

dtype_ids

Caithfidh aitheantóirí do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead.

json_dtype_ids

Caithfidh aitheantóirí do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead.

run_by_all_table_or_report

Tá an paraiméadar seo a leanas ar fáil chun gach gníomh sa tábla nó sa tuairisc a rith: run_by_all_table_or_report=true.

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/actions/ACTION_PROPERTY_ID.json

Comhlacht iarrtha

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

Freagra

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

Making request (XML)

Formáid

XML

Modh

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Comhlacht iarrtha

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

Freagra

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

Nuashonraigh réimse

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

name

Ainm réimse nua. Féach na tréithe go léir atá ar fáil anseo

Making request (JSON)

Formáid

JSON

Modh

PUT

URL

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

Comhlacht iarrtha

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

Freagra

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

Formáid

XML

Modh

PUT

URL

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

Comhlacht iarrtha

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

Freagra

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

Scrios réimse

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

Making request (JSON)

Formáid

JSON

Modh

DELETE

URL

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

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra

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

Formáid

XML

Modh

DELETE

URL

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

Comhlacht iarrtha

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

Freagra

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

Cruthaigh Réimse

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

name

Ainm réimse foirme nua

type_name

Making request (JSON)

Formáid

JSON

Modh

POST

URL

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

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Formáid

XML

Modh

POST

URL

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

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Faigh iomlán de réir colúin

Paraiméadair

rest_api_key

do eochair API

ENTITY_ID

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/search/sum/ENTITY_ID/ID.json

Comhlacht iarrtha

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

Freagra

    
{total: 3}

Making request (XML)

Formáid

XML

Modh

GET

URL

/search/sum/ENTITY_ID/ID.xml

Comhlacht iarrtha

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

Freagra

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

Taifead

Is féidir a leithéid de tréithe taifead a bheith inrochtana trí REST API.

Aitheantóir uathúil taifead. Teastóidh sé seo uait chun an taifead seo a rochtain.

app_id

Aitheantas App

entity_id

Aitheantóir foirme an taifid.

values

Taifead luachanna hash. I gcás gurb í an eochair réimse id agus is é luach an luach réimse seo.

json_values

Taifead luachanna hais. Cá bhfuil an eochair aitheantas réimse agus is é an luach luach an réimse seo. Analóg de values_hash ach i bhformáid JSON

rel_values

Taifead luachanna caidrimh hash. Sa chás go bhfuil eochair réimse id agus is é luach an aitheantais taifead nasctha.

Faigh gach taifead

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

page

Uimhir leathanaigh na dtaifead. Ó 1 go dtí Taifead Tábla comhaireamh/ per_page .

name_value

Úsáid an paraiméadar chun sonraí de chineál a fháil: "ainm páirce": "luach", "réimse id": "ainm páirce"

fetch_all

D'úinéirí cuntas íoctha, tá an paraiméadar seo a leanas ar fáil: feRequest bodytch_all=true.
Chun líon sonrach postálacha a fháil, úsáid an paraiméadar per_page.
Srianta ar uaslíon na n-iontrálacha per_page do phleananna éagsúla:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

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

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

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

Formáid

XML

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

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

Faigh taifead

Paraiméadair

rest_api_key

do eochair API

APP_ID

Caithfidh tú d`aitheantóir taifid a bheith ar eolas agat. Is féidir leat ID a fháil trí ghlaoch Fetch All Records . Nuair a bheidh sé ar eolas agat, beidh ort an ID seo a chur le URL i an nasc thíos, ie athraigh /apps/APP_ID/dtypes/ID.json go /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Úsáid an paraiméadar chun sonraí de chineál a fháil: "ainm páirce": "luach", "réimse id": "ainm páirce"

Making request (JSON)

Formáid

JSON

Modh

GET

URL

/apps/APP_ID/dtypes/ID.json

Comhlacht iarrtha

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

Freagra

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

Formáid

XML

Modh

GET

URL

/apps/APP_ID/dtypes/ID.xml

Comhlacht iarrtha

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

Freagra

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

Taifead nuashonraithe

Paraiméadair

rest_api_key

do eochair API

APP_ID

values

Taifead luachanna hash, áit a bhfuil eochair i bhfoirm réimse id.

json_values

If you using jQuery, Ruby or another programming language then, please, use 'values' parameter to send encoding parameters. However, if your framework doesn't allow this you can send record values as JSON string, but in this case specify your parameter name as 'json_values'. And your JSON values string will looks like this: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}"

subforms_values / subforms_json_values

To create or update subforms, in the same way, use 'subforms_values' or 'json_subforms_values'.
With a format below:
"{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"}}}" .

Where property1_id and property2_id - this is Fields ID's with a Subform type in the main table.
subform1_id, subform2_id - Forms ID's, which was set in property1_id and property2_id settings.
subform1_record1_id и subform1_record2_id - this is new or existent subform records ID's.
subform1_field1_id, subform1_field2_id - fields ID's in the form subform1_id.
subform2_field1_id, subform2_field2_id - fields ID's in the form subform2_id.

All ID's - it's a 22 characters URL-save base64 code, you can get them from other API calls or create for new subform records.

Making request (JSON)

Formáid

JSON

Modh

PUT

URL

/apps/APP_ID/dtypes/ID.json

Comhlacht iarrtha

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

Freagra

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

Formáid

XML

Modh

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Comhlacht iarrtha

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

Freagra

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

Déan taifid iolracha a nuashonrú

Paraiméadair

rest_api_key

do eochair API

confirm_action

Tá an paraiméadar seo a leanas ag teastáil chun an nuashonrú a rith sa tábla nó sa tuairisc: confirm_action: update.

ENTITY_ID

Caithfidh tú aitheantóir foirme do réimse a bheith ar eolas agat chun socruithe an réimse a nuashonrú. Is féidir leat ENTITY_ID a aimsiú trí úsáid a bhaint as Faigh Gach Foirm.

APP_ID

Caithfidh tú aitheantóir an bhunachair shonraí a bheith ar eolas agat chun faisnéis bhunachar sonraí a fháil. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Bunachar Sonraí.

dtype_ids

Caithfidh aitheantóirí do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead.

json_dtype_ids

Caithfidh aitheantóirí do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead.

update_id

Caithfidh tú d'aitheantóir réimse a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Réimse Foirme.

update_term

Luach nua ar thaifid

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Comhlacht iarrtha

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

Freagra

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

Making request (XML)

Formáid

XML

Modh

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Comhlacht iarrtha


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

Freagra

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

Nuashonraigh gach taifead

Paraiméadair

rest_api_key

do eochair API

confirm_action

Tá an paraiméadar seo a leanas ag teastáil chun nuashonrú na dtaifead go léir sa tábla nó sa tuarascáil a rith: confirm_action: update_all.

ENTITY_ID

Caithfidh tú aitheantóir foirme do réimse a bheith ar eolas agat chun socruithe an réimse a nuashonrú. Is féidir leat ENTITY_ID a aimsiú trí úsáid a bhaint as Faigh Gach Foirm.

APP_ID

Caithfidh tú aitheantóir an bhunachair shonraí a bheith ar eolas agat chun faisnéis bhunachar sonraí a fháil. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Bunachar Sonraí.

update_id

Caithfidh tú d'aitheantóir réimse a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Réimse Foirme.

update_term

Luach nua ar thaifid

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Comhlacht iarrtha

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

Freagra

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

Making request (XML)

Formáid

XML

Modh

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Comhlacht iarrtha


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

Freagra

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

Cill sonraí a nuashonrú

Paraiméadair

rest_api_key

do eochair API

PROPERTY_ID

DTYPE_ID

val

Luach cille nua

Making request (JSON)

Formáid

JSON

Modh

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Comhlacht iarrtha

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

Freagra

    
{"new_value": "John Smith"}

Making request (XML)

Formáid

XML

Modh

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Comhlacht iarrtha

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

Freagra

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

Scrios an taifead

Paraiméadair

rest_api_key

do eochair API

APP_ID

Making request (JSON)

Formáid

JSON

Modh

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra

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

Formáid

XML

Modh

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Comhlacht iarrtha

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

Freagra

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

Scrios iolra

Paraiméadair

rest_api_key

do eochair API

ENTITY_ID

Caithfidh tú aitheantóir foirme do réimse a bheith ar eolas agat chun socruithe an réimse a nuashonrú. Is féidir leat ENTITY_ID a aimsiú trí úsáid a bhaint as Faigh Gach Foirm.

APP_ID

Caithfidh tú aitheantóir an bhunachair shonraí a bheith ar eolas agat chun faisnéis bhunachar sonraí a fháil. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Bunachar Sonraí.

dtype_ids

Caithfidh aitheantóirí do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead.

json_dtype_ids

Caithfidh aitheantóirí do thaifid a bheith ar eolas agat. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Taifead. (Roghnach)

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Comhlacht iarrtha

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

Freagra

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

Making request (XML)

Formáid

XML

Modh

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Comhlacht iarrtha


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

Freagra

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

Scrios gach

Paraiméadair

rest_api_key

do eochair API

APP_ID

Caithfidh tú aitheantóir an bhunachair shonraí a bheith ar eolas agat chun faisnéis bhunachar sonraí a fháil. Is féidir leat aitheantas a aimsiú trí ghlao Faigh Gach Bunachar Sonraí.

ENTITY_ID

Caithfidh tú aitheantóir foirme do réimse a bheith ar eolas agat chun socruithe an réimse a nuashonrú. Is féidir leat ENTITY_ID a aimsiú trí úsáid a bhaint as Faigh Gach Foirm.

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

Making request (JSON)

Formáid

JSON

Modh

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Comhlacht iarrtha

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

Freagra

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

Making request (XML)

Formáid

XML

Modh

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Comhlacht iarrtha


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

Freagra

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

Cruthaigh taifead

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

Caithfidh tú 22 carachtar a chruthú le bonn URL-sábháilte64 fad UUID (Aitheantóir Uathúil Uilíoch) . Mar shampla, i Ruby Ansin beidh ort an t-aitheantóirí seo a chur ar aghaidh chuig hash 'luachanna'. => {'id' => '22adadVXHdHie1WeGFE8k2'}

values / json_values

subforms_values / subforms_json_values

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/apps/APP_ID/dtypes.json

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Formáid

XML

Modh

POST

URL

/apps/APP_ID/dtypes.xml

Comhlacht iarrtha

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

Freagra: tuairisceáin faisnéis fhoirm

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

Cuardaigh

Paraiméadair

rest_api_key

do eochair API

APP_ID

ENTITY_ID

view

Caithfidh tú id do thuairisce a bheith ar eolas agat chun taifid a fháil. (Roghnach)

search

Ar mhaith leat flick ar an mbord? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - aitheantóir réimse a bhfuilimid ag cuardach ( -ALL - - chun gach colún a chuardach),
SEARCH_TERM - an luach atá á lorg againn,
SEARCH_CRITERIA - critéar do theachtaireacht, b`fhéidir ceann acu:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contain, not_contains.

Le haghaidh uimhreacha agus dátaí rialta : less_than, Greater_than, less_than_or_equal_to, Greater_than_or_equal_to.

Ar feadh dáta ar feadh thart ar uair an chloig : roimh, tar éis, this_day_and_before, this_day_and_after, inné, inniu, amárach, inniu_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.

Colúin chórais : added_by, created_at, update_at, ip.

Más mian leat cuardach a dhéanamh i roinnt colúin le critéar aontaithe "AGUS", ba cheart na critéir seo a chur in aon eagar amháin, más "NÓ" é, ansin isteach i gceann ar leithligh, mar shampla:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "is"}, {"a" => "PROPERTY_ID_2", "b" => "A", is é "o" => "is"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

is í an fhoirmle cuardaigh: "Faigh na taifid go léir ina bhfuil PROPERTY_ID_1 AGUS PROPERTY_ID_2 cothrom le A NÓ PROPERTY_ID_3 cothrom le B"

limit

Is é 200 an líon taifead sna torthaí cuardaigh.

Making request (JSON)

Formáid

JSON

Modh

POST

URL

/search/APP_ID.json

Comhlacht iarrtha

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

Freagra

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

Caidrimh

Conas taifid a nascadh:

D’fhonn an nasc idir taifid a nuashonrú ní mór duit hash ar leithligh a chur isteach i nglao taifead CREATE nó Suas chun dáta.

curl -H 'Cineál Ábhar: feidhmchlár/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 "

Ba chóir go mbeadh an hash seo cosúil le 'rel' => {rel_id => RECORD_ID} nó 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} má tá caidreamh lán le go leor agat. I gcás RECORD_ID is ID taifead é ar mhaith leat nasc a dhéanamh leis taifead reatha. Le do thoil, féach thíos conas rel_id a fháil.

Paraiméadair

rest_api_key

do eochair API

PROPERTY_ID

ENTITY_ID

Caithfidh tú aitheantóir foirme do réimse a bheith ar eolas agat chun socruithe réimse a nuashonrú. Is féidir leat ENTITY_ID a fháil trí ghlaoch Fetch All Forms a luaithe a bheidh a fhios agat, beidh ort é chun an ENTITY_ID seo a chur le URL sa nasc thíos, ie change /apps/APP_ID/entities/ENTITY_ID/properties.json go /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

Tuarascálacha

Is féidir a leithéid de tréithe tuarascála a bheith inrochtana trí REST API.

name

Ainm

Faigh Tuarascálacha

Paraiméadair

rest_api_key

do eochair API

APP_ID

Aitheantas App

ENTITY_ID

Aitheantas Tábla (Foirm)

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

{"rest_api_key":"API_KEY"}

Freagra: seoltar gach tuairisc tábla ar ais.

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

Formáid

XML

Modh

GET

URL

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

Comhlacht iarrtha: seoltar gach tuairisc tábla ar ais.

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

Freagra

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

Comhaid

Faigh URL an chomhaid

D’fhonn comhaid taifead a íoslódáil caithfidh tú luachanna taifead a fháil ar dtús agus ansin beidh tú in ann comhad a íoslódáil ag baint úsáide as an nasc mar seo https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, áit FILE_NAME - ainm an chomhaid, ar féidir leat a fháil ó hash luachanna taifead, a bhfuil an chuma air mar PROPERTY_ID => LUACH, RECORD_ID - ID taifead, PROPERTY_ID - ID réimse.

Uaslódáil comhaid

D’fhonn comhad a uaslódáil i dtaifead caithfidh tú iarratas POST a dhéanamh ar an modh API upload_file le ceanntásc cineál ábhair multipart/form-data agus ina dhiaidh sin ní mór duit do thaifead a chruthú nó a nuashonrú. Mar sin an ID taifead ba cheart é a ghiniúint roimh na glaonna. Agus freisin beidh ort an ceanntásc Multipart a ghiniúint, le do thoil, lean sampla Ruby leis an rang MultipartPost thíos. Mar shampla, foghlaimeoidh tú conas an comhad a uaslódáil san fho-fhoirm freisin.

Sampla Ruby

  
    require 'open-uri'
    require 'openssl'

    require 'net/http'
    require 'json'
    require 'securerandom'

    #MultipartPost
    class MultipartPost
      BOUNDARY = "-----------RubyMultipartPost"
      EOL = "\r\n"

      def initialize uri, &block
        @params = Array.new
        @uri = URI.parse uri
        instance_eval &block if block
      end

      def params_part key, value
        @params << multipart_text(key, value)
      end

      def files_part key, filename, mime_type, content
        @params << multipart_file(key, filename, mime_type, content)
      end

      def request_body
        body = @params.map{|p| "--#{BOUNDARY}#{EOL}" << p}.join ""
        body << "#{EOL}--#{BOUNDARY}--#{EOL}"
      end

      def run
        https = Net::HTTP.new @uri.host, @uri.port
        https.use_ssl = true
        https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
        request = Net::HTTP::Post.new @uri.request_uri
        request.body = request_body
        request.set_content_type "multipart/form-data", {"boundary" => BOUNDARY}
        res = https.request request
        res.body
      end

      private
      def multipart_text key, value
        content = "Content-Disposition: form-data; name=\"#{key}\"" <<
          EOL <<
          EOL <<
          "#{value}" << EOL
      end

      def multipart_file key, filename, mime_type, content
        content = "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{filename}\"#{EOL}" <<
          "Content-Type: #{mime_type}\r\n" <<
          EOL <<
          "#{content}" << EOL
      end
    end #MultipartPost

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

      req = case method
              when "get"
                Net::HTTP::Get.new(uri.path) 
              when "post" 
                Net::HTTP::Post.new(uri.path)
              when "put"
                Net::HTTP::Put.new(uri.path)
              when "delete"
                Net::HTTP::Delete.new(uri.path)
            end

      req.body = case format
                  when "json"
                    JSON.generate(params)
                  else
                    "no"
                end
      
      req["Content-Type"] = "application/#{format}"

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

      https.use_ssl = (uri.scheme == 'https')
      https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)

      https.start do |htt| 
        htt.request(req)
      end
    end

    dtype_id = SecureRandom.urlsafe_base64

    app_id   = "bsx8kgWR9jWOBdUftcRXf9"
    entity_id = "arjadcLJzeWOi1WPddL8ol"
    property_id = "bwW68wWP1cSikQqSkhl04I"

    post_url = "https://localhost:3001/entities/#{app_id}/upload_file/#{property_id}.json?dtype_id=#{dtype_id}"

    # Path to your file
    file_path = "/home/igor/Pictures/Selection_001.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip


    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      files_part "dtype[#{property_id}]", "Selection_001.png",
        file_content_type, file.read
    end
    p multi_part.run

    # And below is the example of how to upload the file to Subform
    rest_api_key          = "API_KEY"
    subform_field_id      = "dcL8kXB8npd5pdRmk7BCoR"
    subform_file_field_id = "aVWR3cNtvdUikQn8o3yCo1"
    subform_form_id       = "cCcxjdWRXpWPTLWOjvWPfO"
    subform_dtype_id      = SecureRandom.urlsafe_base64

    file_path = "/home/igor/Pictures/Selection_002.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip

    post_url = "https://quintadb.com/entities/#{app_id}/upload_file/#{subform_file_field_id}.json?dtype_id=#{subform_dtype_id}"

    # upload file into subform record
    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      params_part "subform_field", subform_field_id
      params_part "property_id", subform_file_field_id
      params_part "subform_dtype_id", subform_dtype_id
      files_part "subforms[#{subform_field_id}][#{subform_dtype_id}][#{subform_file_field_id}]", "Selection_002.png",
        file_content_type, file.read
    end
    p multi_part.run

    text_field_on_a_form = "agW6rGWQHiWPvdWPL0oCoj"
    text_field_on_a_subform = "dcV8k6y8nhWP4JF0r6W5LI"
    params = { 
      :page => 1,
      :rest_api_key => rest_api_key,  
      values: {entity_id: entity_id, id: dtype_id, text_field_on_a_form =>  "Test"},
      subforms: {subform_field_id => {entity_id: subform_form_id, subform_dtype_id => { text_field_on_a_subform => "Test2"}}}
    }
    response = call_quinta "https://quintadb.com/apps/#{app_id}/dtypes.json", "json", "post", params

    puts response.body

Paraiméadair

rest_api_key

do eochair API

APP_ID

property_id

dtype_id

Making request (JSON)

Formáid

JSON

Modh

POST

URL

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

Comhlacht iarrtha

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

Freagra

    Uploaded

Bain comhaid

Paraiméadair

rest_api_key

do eochair API

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Ainm comhaid

Making request (JSON)

Formáid

JSON

Modh

GET

URL

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

Comhlacht iarrtha

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

Freagra

    File removed

Samplaí

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Glao ceart a chruthú leis an Modh: 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

   # Tiontaigh na paraiméadair go JSON/XML agus socraigh an cineál ábhair mar fheidhmchlár/json nó feidhmchlár/xml   Tabhair faoi deara an fhormáid XML do pharaiméadair, is í an eilimint fhréamh 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
	# Cineál ábhair a shocrú
  req["Content-Type"] = "application/#{format}"

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

  # Gach glao trí HTTPS agus teastais SSL á bhfíorú

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


# Déan cinnte do API_KEY féin a shocrú anseo
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# Beidh an freagra istigh response.body
puts response.body

Tá a fhios go bhfuil forbairt bogearraí an-tábhachtach na laethanta seo. Má dhéantar REST API do do bhogearraí a mhéadú go mór an tóir a bheidh ar do tháirge. Is API bunúsach REST é seo agus ba cheart go mbeadh go leor ann chun rudaí iontacha a chruthú. teastaíonn aon rud eile, níos mó modhanna srl., le do thoil, bíodh drogall ort teagmháil a dhéanamh linn ag am ar bith. Táimid ag tnúth le cloisteáil uait!

QuintaDB REST API

Faisnéis ghinearálta faoi ghlaonna API

Bunachar Sonraí

Foirm

Réimse

Taifead

Tuarascálacha

Comhaid

Úsáideann QuintaDB.com fianáin chun an fheidhmiúlacht láithreáin riachtanach a sholáthar agus do thaithí a fheabhsú. Trí úsáid a bhaint as ár suíomh Gréasáin, aontaíonn tú lenár mbeartas fianán.