Always With You

MyTaskHelper REST API

The MyTaskHelper REST API is designed to unlock the potential of the data stored within your MTH database. Using this API you can achieve more then currently offered by the default MTH UI. This way we giving you ability to do with your data everything you need and in the way you need. You can create your own scripts, desktop and mobile applications for different platforms like iPhone/Android and many more. And MTH will be a place were you store, share and manage your data.

General information about API calls

All calls should contain REST API key, which could be found in menu REST API.
Result returned in JSON or XML, depending on your request.
We'll show table with a result for each call. URL will be shown in this way /apps.json, it mean that you should call https://MyTaskHelper.com/apps.json in your application. Please, notice, that all calls should use https and you have to validate servers SSL certificate.

Example (in Ruby)

Click on Example (in Ruby) link to see ruby script example. Which could be a start point for you. We'll add such examples for another programming languages later. But Ruby is fairly easy to read and understand

	
		require 'open-uri'
		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

		  # Convert the parameters into JSON/XML and set the content type as application/json or application/xml
			Notice the XML format for parameters, the root element is 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
			# Setting content type
		  req["Content-Type"] = "application/#{format}"

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

		  # All calls via HTTPS and verifying SSL certificates 

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


		# Make sure to set your own API_KEY here
		params = { 
		  :page => 1,
		  :rest_api_key => "API_KEY"
		}

		response = call_mth "https://mytaskhelper.com/apps.json", "json", "get", params
		# Response will be in response.body
		puts response.body

Database

Such database attributes can be accessible via REST API.

Attribute	Description
id	Unique database identifier. You'll need this to access this database forms and records
name	Database name
created_at	Time when database was created
updated_at	Time when database was last updated (changed records or forms)
dtypes_count	Number of entries in database
entities_count	Number of forms in project
properties_count	Number of columns in database

Get All Databases - returns your current databases.

Request parameter	Description
rest_api_key	your API key
page	Databases paginated by 20 records per page. So if you have 100 databases, page can be 1..5.

Format URL Method Request body Result

JSON

/apps.json

GET

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

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

XML

/apps.xml

GET

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

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

Get Database by ID - returns database information

Request parameter	Description
rest_api_key	your API key
ID	You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON

/apps/ID.json

GET

{"rest_api_key":"API_KEY"}

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

XML

/apps/ID.xml

GET

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

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

Get Database by Name - returns database information

Request parameter	Description
rest_api_key	your API key
Name	You have to know your database name in order to fetch database information. You can find Name using Fetch All Databases call.

Format URL Method Request body Result

JSON

/apps/search.json

GET

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

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

XML

/apps/search.xml

GET

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

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

Update Database - you can update database name

Request parameter	Description
rest_api_key	your API key
name	New database name
ID	You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON

/apps/ID.json

PUT

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

							
							{"database":{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
							               "name"            : "New database name",
							               "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
							               }
							}

XML

/apps/ID.xml

PUT

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

							
								<?xml version="1.0" encoding="UTF-8"?>
								  <database>
								    <id>aOWO_dVXHdHie1WeGFE8k2</id>
								    <name>New database name</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>

Delete Database - destroy database

Request parameter	Description
rest_api_key	your API key
ID	You have to know your database identifier in order to fetch database information. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON

/apps/ID.json

DELETE

{"rest_api_key":"API_KEY"}

							

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

XML

/apps/ID.xml

DELETE

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

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

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

Create Database - add new database

Request parameter	Description
rest_api_key	your API key
database_name	Database name
form_name	Form name. You can't create database without form. Because it doesn't make sense to have database without forms.

Format URL Method Request body Result

JSON

/apps.json

POST

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

							
							{"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"              : "aOWO_dVXHdHie1WeGFE8k2",
																	 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
																	 "name"            : "Form 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
									              }
							
							}

XML

/apps.xml

POST

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

							
								<?xml version="1.0" encoding="UTF-8"?>
								  <database>
									  <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>
										<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>
								  </databases>

In case of error. You'll get error message, i.e. Such project name already exist.

Form

Such form attributes can be accessible via REST API.

Attribute	Description
id	Unique form identifier. You'll need this to access this form and form records
name	Form name
desc	Form description
post_action	List of email notifications recipients
target_page	Redirect to URL. This is the URL form submitter will be redirected to after filling the form.
position	Form position. It shows the order it will be fetched.
sort_by	Form field ID by which records current sorted
asc	true or false. Which mean DESC or ASC sort order
per_page	How many records fetched per page.
allow_delete	true or false. When true, web users will be able to delete records from integrated database
allow_database	true or false. When true, web users will be able to see records on integrated database
send_emails	true or false. Send or not to send email notifications about new submission.
new_widget	Form widget settings Hash
records_widget	Database widget settings Hash
settings	Form settings Hash

Get All Forms - fetch all database forms

Request parameter	Description
rest_api_key	your API key
ID	You have to know your database identifier in order to fetch database forms. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Format URL Method Request body Result

JSON

/apps/ID/entities.json

GET

{"rest_api_key":"API_KEY"}

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

XML

/apps/ID/entities.xml

GET

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

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

Get Form by ID - returns form information

Request parameter	Description
rest_api_key	your API key
APP_ID	You have to know your database identifier in order to fetch form information. You can find APP_ID using Fetch All Forms call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json
ID	You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities/1da1dVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON

/apps/APP_ID/entities/ID.json

GET

{"rest_api_key":"API_KEY"}

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

XML

/apps/APP_ID/entities/ID.xml

GET

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

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

Get Form by Name - returns form information

Request parameter	Description
rest_api_key	your API key
Database name	You have to know your database name in order to fetch form information. You can find Database Name using Fetch All Databases call.
Form name	You have to know your form name in order to fetch form information. You can find Form Name using Fetch All Forms call.

Format URL Method Request body Result

JSON

/apps/search/entities/search.json

GET

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

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

XML

/apps/search/entities/search.xml

GET

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

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

Update Form - you can update such form attributes

Request parameter Description

rest_api_key your API key

name New form name. See all available attributes here

APP_ID You have to know your database identifier in order to update form information. You can find APP_ID using Fetch All Forms call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID You have to know your form identifier in order to update form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ID.json PUT {"rest_api_key":"API_KEY",
"name":"New form name"}
{"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 } }

XML /apps/APP_ID/entities/ID.xml PUT <?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New form name</rest_api_key>
</api_call_params>
<?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>

Delete form - destroy form

Request parameter Description

rest_api_key your API key

APP_ID You have to know your database identifier in order to delete form. You can find APP_ID using Fetch All Forms call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

ID You have to know your form identifier in order to delete form. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ID.json DELETE {"rest_api_key":"API_KEY"}
{"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 } ]}

XML /apps/APP_ID/entities/ID.xml DELETE <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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>

Create Form - create database form.

Request parameter Description

rest_api_key your API key

name Form name

APP_ID You have to know your database identifier in order to create form. You can find ID using Fetch All Databases call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities.json POST {"rest_api_key":"API_KEY",
"name":"New form"}
{"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 } }

XML /apps/APP_ID/entities.xml POST <?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>
<?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>

Field

Such field attributes can be accessible via REST API.

Attribute Description

id Unique field identifier. You'll need this to access this field

entity_id Field's form identifier.

name Field name

desc Field description

type_name Field type name. Can by one of: 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

default Default field value

validate_options Field validation options

position Field position on form

visible Visible field on integrated database widget? Can be true or false

size Field size

cols Table field columns

rows Table field rows

Get form fields - fetch all form fields

Request parameter Description

rest_api_key your API key

APP_ID You have to know your database identifier in order to fetch form information. You can find APP_ID using Fetch All Forms call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

entity_id You have to know your form identifier in order to fetch form information. You can find ID using Fetch All Forms call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities.json to /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ID/properties.json GET {"rest_api_key":"API_KEY"}
{"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 } ]}

XML /apps/APP_ID/entities/ID/properties.xml GET <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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>

Get Field - you can get such field attributes

Request parameter Description

rest_api_key your API key

APP_ID You have to know your database identifier in order to update field settings. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ENTITY_ID You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ID You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ENTITY_ID/properties/ID.json GET {"rest_api_key":"API_KEY"}
{"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 } }

XML /apps/APP_ID/entities/ENTITY_ID/properties/ID.xml GET <?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>
<?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>

Get Field by Name - you can get such field attributes

Request parameter Description

rest_api_key your API key

Database name You have to know your database name in order to fetch form information. You can find Database Name using Fetch All Databases call.

Form name You have to know your form name in order to fetch form information. You can find Form Name using Fetch All Forms call.

Field name You have to know your field name in order to update field settings. You can find field name using Fetch All Form Fields call.

Format URL Method Request body Result

JSON /apps/search/entities/search/properties/search.json GET {"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1", "field_name": "Field Name 1"}
{"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 } }

XML /apps/search/entities/search/properties/search.xml GET <?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>
<?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>

Update Field - you can update such field attributes

Request parameter Description

rest_api_key your API key

name New field name. See all available attributes here

APP_ID You have to know your field's form identifier in order to update field settings. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ENTITY_ID You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ID You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ENTITY_ID/properties/ID.json PUT {"rest_api_key":"API_KEY",
"name":"New field name"}
{"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 } }

XML /apps/APP_ID/entities/ENTITY_ID/properties/ID.xml PUT <?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>
<?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>

Delete field - deletes form field

Request parameter Description

rest_api_key your API key

APP_ID You have to know your field's form identifier in order to update field settings. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ENTITY_ID You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

ID You have to know your field identifier in order to update field settings. You can find ID using Fetch All Form Fields call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties/ID.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ENTITY_ID/properties/ID.json DELETE {"rest_api_key":"API_KEY"}
{"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 } ]}

XML /apps/APP_ID/entities/ENTITY_ID/properties/ID.json DELETE <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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>

Create Field - adds new form field

Request parameter Description

rest_api_key your API key

name Form field name

type_name Field type name. Can by one of: 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

APP_ID You have to know your field's database identifier in order to update field settings. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

ENTITY_ID You have to know your field's form identifier in order to update field settings. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/entities/ENTITY_ID/properties.json to /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Format URL Method Request body Result

JSON /apps/APP_ID/entities/ENTITY_ID/properties.json POST {"rest_api_key":"API_KEY", :name => "Field name 1", :type_name => "string"}
{"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 } }

XML /apps/APP_ID/entities/ENTITY_ID/properties.xml POST <?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>
<?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>

Record

Such record attributes can be accessible via REST API.

Attribute Description

id Unique record identifier. You'll need this to access this record.

page Records paginated by per_page records per page.

app_id Record's database identifier.

entity_id Record's form identifier.

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

approved If database moderation enabled this attributes triggers record's visibility in integrated database

created_at Time when record was created.

updated_at Time when record was last updated.

Get records - fetch all form records

Request parameter Description

rest_api_key your API key

APP_ID You have to know your database identifier in order to fetch records. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/entity/ENTITY_ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/entity/asd987asdasd97asd.json

ENTITY_ID You have to know your form identifier in order to fetch records. You can find ENTITY_ID using Fetch All Forms call. Once you know it, you'll need to add this ENTITY_ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/entity/ENTITY_ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/entity/asd987asdasd97asd.json

Format URL Method Request body Result

JSON /apps/APP_ID/dtypes/entity/ENTITY_ID.json GET {"rest_api_key":"API_KEY"}
{"records":[ { "id":"bYWQnuBajdBOkAW4BdMmki", "app_id":"ddIbpcNSncW5xcHxpdHCoW", "entity_id":"aEWQZdIXfahOqWvcvwrGTP", "values":{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa", "cMW6pcTSjbWOFdTCkBtmkN":"ddd"}, "approved":false, "created_at":"2011-09-17T10:40:40-05:00", "updated_at":"2011-09-17T10:40:40-05:00" }, { "id":"dcQSkdWO1odA5HAmkYWOix", "app_id":"ddIbpcNSncW5xcHxpdHCoW", "entity_id":"aEWQZdIXfahOqWvcvwrGTP", "values":{"aNW4nkW5bdUjldO8oKuSku":"1", "aMW4HKWR9bnOoGWQbpWQS4":"test", "cMW6pcTSjbWOFdTCkBtmkN":"test2"}, "approved":false, "created_at":"2011-09-17T04:28:10-05:00", "updated_at":"2011-09-17T04:28:10-05:00" } ] }

XML /apps/APP_ID/dtypes/entity/ENTITY_ID.xml GET <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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>

Fetch view's records - fetch all view's records

Request parameter Description

rest_api_key your API key

Database name You have to know your database name in order to fetch form information. You can find Database Name using Fetch All Databases call.

Form name You have to know your form name in order to fetch form information. You can find Form Name using Fetch All Forms call.

View You have to know your view name in order to fetch records.

Format URL Method Request body Result

JSON /apps/search/dtypes/entity/search.json GET {"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1", "view" => "aaa"}
{"records":[ { "id":"bYWQnuBajdBOkAW4BdMmki", "app_id":"ddIbpcNSncW5xcHxpdHCoW", "entity_id":"aEWQZdIXfahOqWvcvwrGTP", "values":{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa", "cMW6pcTSjbWOFdTCkBtmkN":"ddd"}, "approved":false, "created_at":"2011-09-17T10:40:40-05:00", "updated_at":"2011-09-17T10:40:40-05:00" } ] }

XML /apps/search/dtypes/entity/search.xml GET <?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>
<view>aaa</view>
</api_call_params>
<?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> </records>

Get record - you can fetch such record attributes

Request parameter Description

rest_api_key your API key

APP_ID You have to know your database identifier in order to fetch record. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/entity/ENTITY_ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/entity/asd987asdasd97asd.json

ID You have to know your record identifier in order to fetch record information. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Format URL Method Request body Result

JSON /apps/APP_ID/dtypes/ID.json GET {"rest_api_key":"API_KEY"}
{"record": { "id":"bYWQnuBajdBOkAW4BdMmki", "app_id":"ddIbpcNSncW5xcHxpdHCoW", "entity_id":"aEWQZdIXfahOqWvcvwrGTP", "values":{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa", "cMW6pcTSjbWOFdTCkBtmkN":"ddd"}, "approved":false, "created_at":"2011-09-17T10:40:40-05:00", "updated_at":"2011-09-17T10:40:40-05:00" } }

XML /apps/APP_ID/dtypes/ID.xml GET <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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>

Update record - you can update such record attributes

Request parameter Description

rest_api_key your API key

values Record values hash, where key is form field id.

APP_ID You have to know your database identifier in order to fetch record. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/entity/ENTITY_ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/entity/asd987asdasd97asd.json

ID You have to know your record identifier in order to fetch record information. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Format URL Method Request body Result

JSON /apps/APP_ID/dtypes/ID.json PUT {"rest_api_key":"API_KEY", :values => {"aNW4nkW5bdUjldO8oKuSku" => 3, "aMW4HKWR9bnOoGWQbpWQS4" => "b", "cMW6pcTSjbWOFdTCkBtmkN" => "c"}}
{"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" } }

XML /apps/APP_ID/dtypes/ID.xml PUT <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3, "aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values><rest_api_key>cQWOm2rCnhxiolpML2rajB</rest_api_key> <rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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 record - deletes record

Request parameter Description

rest_api_key your API key

APP_ID You have to know your database identifier in order to delete record. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/entity/ENTITY_ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/entity/asd987asdasd97asd.json

ID You have to know your record identifier in order to delete record. You can find ID using Fetch All Records call. Once you know it, you'll need to add this ID to URL in the link below, i.e. change /apps/APP_ID/dtypes/ID.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

Format URL Method Request body Result

JSON /apps/APP_ID/dtypes/ID.json DELETE {"rest_api_key":"API_KEY"}
{"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" } }

XML /apps/APP_ID/dtypes/ID.xml DELETE <?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> </api_call_params>
<?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>

Create record - Adds new database record

Request parameter Description

rest_api_key your API key

ID You have to generate 22 characters long URL-safe base64 UUID (Universally Unique IDentifier). For example, in Ruby. Then you'll need to pass this identifiers to 'values' hash. I.e. :values => {"id" => ID}, change to :values => {"id" => "22adadVXHdHie1WeGFE8k2"}

APP_ID You have to know your database identifier in order to delete record. You can find APP_ID using Fetch All Databases call. Once you know it, you'll need to add this APP_ID to URL in the link below, i.e. change /apps/APP_ID/dtypes.json to /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes.json

ENTITY_ID You have to know your form identifier in order to submit record to this form. You can find ENTITY_ID using Fetch All forms call. Once you know it, you'll need to add this ENTITY_ID to 'values' hash, i.e. :values => {"entity_id" => ENTITY_ID}, change to :values => {"entity_id" => "asdWO_dVXHdHie1WeGFE8k2"}

Format URL Method Request body Result

JSON /apps/APP_ID/dtypes.json POST {"rest_api_key":"API_KEY", :values => {"entity_id" => ENTITY_ID, "id" => ID}}
{"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" } }

XML /apps/APP_ID/dtypes.xml POST <?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>
<?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>

It is well known that software development is very important these days. Having REST API for your software will increase your product popularity very much.

This is a basic REST API and it should be enough to create great things. However, if you need anything else, more methods etc., please, feel free to contact us at any time. We look forward to hear from you!

Explore	Community	Support	About MyTaskHelper
Home	Referrals	Help Center	MTH Blog
Sign Up	Twitter	FAQs	Our Team
Articles	Facebook	Votebox	Terms of Service
Pricing	Forums	About	Policies
Features	News	Contact Us