kintone REST API Request

Introduction

The kintone REST API Request allows you to run kintone REST APIs from your JavaScript code.
You'll find that you are limited to several actions when just completely relying on the JavaScript API - for example, you'll need to use the kintone REST API if you need to retrieve data of all the records inside your app.
This is where you will use the kintone REST API Request, to run the REST API.

kintone REST API Requestkintone.api()

Function

kintone.api(pathOrUrl, method, params, callback, opt_errback)

Request Parameters

Response

A kintone.Promise object will be returned if the callback parameter is ignored. Otherwise, there will be no response

Sample Request

kintone.events.on('app.record.index.show', function(event) {
	
	//The function called on success
	var callback = function(event){
		alert(event['record']['text_0']['value']);
	}

	//The function called on error
	var opt_errback = function(event){
		var errmsg = 'There was an error when retrieving the data';     
		if (event.message !== undefined){
			errmsg += '\n' + event.message;
		}
		alert(errmsg);
	}

	//kintone REST API Request calling the kintone Get Record API
	kintone.api('/k/v1/record', 'GET', {app: 1, id: 7}, callback, opt_errback);
});

Sample Request using Promises

kintone.events.on('app.record.create.submit', function(event) {
	return kintone.api('/k/v1/records', 'GET',  {app: 20}).then(function(resp) {
		alert("First pop-up");
	}).then(function(){
		alert("Second pop-up");//This should appear after the function before is resolved.
	}).catch(function(error) {
		var errmsg = 'There was an error when retrieving the data';      
  		 //If an error is included in the response message, show it
  		 if (error.message !== undefined){
  		 	errmsg += '\n' + error.message;
  		 }
  		 alert(errmsg);
  		});
});

Limitations

File upload/downloads cannot be run. You will need to retrieve the CSRF token, and run an HTTP request.

Get URLkintone.api.url()

Function

kintone.api.url(path,detectGuestSpace)

Request Parameters

Response

A URL string.

Sample Response

https://{subdomain}.kintone.com/k/v1/records.json

Sample Request

var url = kintone.api.url('/k/v1/records');
console.log(url);

Get URL (including query)kintone.api.urlForGet()

Function

kintone.api.urlForGet(path, params,opt_detectGuestSpace)

Request Parameters

Response

A URL string including a query string, with URL encoded parameters.

Sample Response

https://{subdomain}.kintone.com/k/v1/records.json?app=7&fields[0]=text_0

Sample Request

var urlForGet = kintone.api.urlForGet('/k/v1/records', {app: 7,fields: ["text_0"]});
console.log(decodeURIComponent(urlForGet));

Get CSRF Tokenkintone.getRequestToken()

Function

kintone.getRequestToken()

Request Parameters

None

Response

A string.

Available Period

86400 seconds (1 day) from the last access.

Sample Response

19324485-251e-2f6h-9332-824c9933g53e

Sample Request

var token = kintone.getRequestToken();
console.log(token); 

Sample for APIs using Query Strings

https://{subdomain}.kintone.com/k/v1/records.json?__REQUEST_TOKEN__=19324485-251e-2f6h-9332-824c9933g53e

Sample for APIs using JSON

{
    "__REQUEST_TOKEN__": "19324485-251e-2f6h-9332-824c9933g53e"
}

Request headers needed with the APIs