rest_doc.md

kintoneUtility.rest Specification

Record

• kintoneUtility.rest.getRecord
• kintoneUtility.rest.getRecords
• kintoneUtility.rest.getAllRecordsByQuery
• kintoneUtility.rest.postRecord
• kintoneUtility.rest.postRecords
• kintoneUtility.rest.postAllRecords
• kintoneUtility.rest.putRecord
• kintoneUtility.rest.putRecords
• kintoneUtility.rest.putAllRecords
• kintoneUtility.rest.deleteRecords
• kintoneUtility.rest.deleteAllRecords
• kintoneUtility.rest.deleteAllRecordsByQuery
• kintoneUtility.rest.upsertRecord
• kintoneUtility.rest.upsertRecords
• kintoneUtility.rest.downloadFile
• kintoneUtility.rest.uploadFile

App

• kintoneUtility.rest.getFormFields
• kintoneUtility.rest.getFormLayout
• kintoneUtility.rest.postDeployAppSettings
• kintoneUtility.rest.getAppDeployStatus
• kintoneUtility.rest.getCustomization
• kintoneUtility.rest.updateCustomization

Authentication

• kintoneUtility.rest.setUserAuth
• kintoneUtility.rest.setApiTokenAuth
• kintoneUtility.rest.setDomain
• kintoneUtility.rest.setBasicAuth
• kintoneUtility.rest.setGuestSpaceId
• kintoneUtility.rest.clearUserAuth
• kintoneUtility.rest.clearApiTokenAuth
• kintoneUtility.rest.clearDomain
• kintoneUtility.rest.clearBasicAuth
• kintoneUtility.rest.clearGuestSpaceId

kintoneUtility.rest.getRecord(param)

• Get a single record.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.id	Number	Yes	The Record ID.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getRecord({
  app: 542,
  id: 18616,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.getRecords(param)

• Get multiple records.
• The maximum number of records that can be retrieved is 500.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The App ID.
param.query	String	Optional	The query string that will specify what records will be responded. If nothing is specified, fields will be returned from all accessible records. The query detail
param.fields	Array	Optional	The field codes that you want in the response. If nothing is specified, all accessible fields in the app will be returned.
param.totalCount	Boolean	Optional	If set to "true", the request will retrieve the total count of records that were retrieved that match the query conditions. If ignored, null is returned for the totalCount value.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getRecords({
  app: 542,
  query: 'Number > 0 limit 500 offset 100',
  fields: ['String', 'Number'],
  totalCount: true,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.getAllRecordsByQuery(param)

• Get all records indicated by query.
• Can't indicate limit and offset of query.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The App ID.
param.query	String	Optional	The query string that will specify what records will be responded. If nothing is specified, fields will be returned from all accessible records. The query detail Can't indicate limit and offset.
param.fields	Array	Optional	The field codes that you want in the response. If nothing is specified, all accessible fields in the app will be returned.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getAllRecordsByQuery({
  app: 542,
  query: 'Number > 0',
  fields: ['String', 'Number'],
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.postRecord(param)

• Insert a record to kintone app.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.record	Object	Optional	Field codes and values are specified in this object. If ignored, the record will be added with default field values. If field codes that don't exist are specified, these will be ignored.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var record = {
  Number: {
    value: 1234
  },
  String: {
    value: 'string'
  },
};
kintoneUtility.rest.postRecord({
  app: 542,
  record: record,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.postRecords(param)

• Insert up to 2000 records to kintone app.
• If the records are over 2000, It is thrown Error.
• If request is failed, no record is inserted.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.records	Array	Yes	Holds an array of record objects.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var records = [
  {
    Number: {
      value: 1234
    },
    String: {
      value: 'string1'
    },
  },
  {
    Number: {
      value: 5678
    },
    String: {
      value: 'string2'
    },
  }
];
kintoneUtility.rest.postRecords({
  app: 542,
  records: records,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.postAllRecords(param)

• Can insert over 2000 records to kintone app, but can't do rollback.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.records	Array	Yes	Holds an array of record objects.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var records = [
  {
    Number: {
      value: 1234
    },
    String: {
      value: 'string1'
    },
  },
  {
    Number: {
      value: 5678
    },
    String: {
      value: 'string2'
    },
  }
];
kintoneUtility.rest.postAllRecords({
  app: 542,
  records: records,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.putRecord(param)

• Update a record to kintone app.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.id	Number	No (Required, if updateKey will not be specified)	The record ID.
param.updateKey	Object	No (Required, if id will not be specified)	To specify this field, the field must have the "Prohibit duplicate values" option turned on.
param.updateKey.field	String	No (Required, if updateKey will be specified)	The field code of unique key.
param.updateKey.value	String	No (Required, if updateKey will be specified)	The value of unique key.
param.revision	Number	Optional	The expected revision number. If the value does not match, an error will occur and the record will not be updated. If the value is not specified or is -1, the revision number will not be checked.
param.record	Object	Optional	Field codes and values are specified in this object. If ignored, the record will not be updated.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var record = {
  Number: {
    value: 1234
  },
  String: {
    value: 'string'
  },
};
//update by id
kintoneUtility.rest.putRecord({
  app: 542,
  id: 18616,
  record: record,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});
//update by unique key
kintoneUtility.rest.putRecord({
  app: 542,
  updateKey: {
    field: 'unique_field_code',
    value: 'unique_field_value'
  },
  record: record,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.putRecords(param)

• Update up to 2000 records to kintone app.
• If the records are over 2000, It is thrown Error.
• If request is failed, no record is Updated.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.records	Array	Yes	Array of record objects that include id/updateKey, revision and record objects.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var records = [
  {
    id: 18616,
    record: {
      Number: {
        value: 1234
      },
      String: {
        value: 'string1'
      },
    },
  },
  {
    id: 18617,
    record: {
      Number: {
        value: 5678
      },
      String: {
        value: 'string2'
      },
    },
  }
];
kintoneUtility.rest.putRecords({
  app: 542,
  records: records,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.putAllRecords(param)

• Can update over 2000 records to kintone app, but can't do rollback.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	kintone app ID.
param.records	Array	Yes	Array of record objects that include id/updateKey, revision and record objects.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var records = [
  {
    updateKey: {
      field: 'unique_field_code',
      value: 'unique_field_value1'
    },
    record: {
      Number: {
        value: 1234
      },
      String: {
        value: 'string1'
      },
    },
  },
  {
    updateKey: {
      field: 'unique_field_code',
      value: 'unique_field_value2'
    },
    record: {
      Number: {
        value: 5678
      },
      String: {
        value: 'string2'
      },
    },
  }
];
kintoneUtility.rest.putAllRecords({
  app: 542,
  records: records,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.deleteRecords(param)

• Can't delete over 2000 records.
• If the records are over 2000, It is thrown Error.
• If request is failed, no record is deleted.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.ids	Array	Yes	Array of record IDs that will be deleted.
param.revisions	Array	Optional	The expected revision number. The first id number will correspond to the first revision number in the array, the second id to the second revision number, and so on. If the revision number does not match, an error will occur and no records will be deleted. If the revision number is left blank or is -1, the revision number will not be checked for the corresponding record ID.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var ids = [
  18619,
  18618
];
kintoneUtility.rest.deleteRecords({
  app: 542,
  ids: ids,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.deleteAllRecords(param)

• Delete all records by indicating query.
• Can delete over 2000 records, but can't do rollback.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	kintone app ID.
param.ids	Array	Yes	Array of record IDs that will be deleted.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var ids = [
  18619,
  18618
];
kintoneUtility.rest.deleteAllRecords({
  app: 542,
  ids: ids,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.deleteAllRecordsByQuery(param)

• Can delete over 2000 records, but can't do rollback.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The App ID.
param.query	String	Optional	The query string that will specify what records will be responded. If nothing is specified, fields will be returned from all accessible records. The query detail Can't indicate limit and offset.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.deleteAllRecordsByQuery({
  app: 542,
  query: 'Number > 0',
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.upsertRecord(param)

• Insert or update a record to kintone app.
• Insert the record if the updateKey doesn't exists.
• Update the record if the updateKey exists.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.updateKey	Object	Yes	To specify this field, the field must have the "Prohibit duplicate values" option turned on.
param.updateKey.field	String	Yes	The field code of unique key.
param.updateKey.value	String	Yes	The value of unique key.
param.revision	Number	Optional	The expected revision number. If the value does not match, an error will occur and the record will not be updated. If the value is not specified or is -1, the revision number will not be checked.
param.record	Object	Optional	Field codes and values are specified in this object. If ignored, the record will not be updated.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var record = {
  Number: {
    value: 1234
  }
};
kintoneUtility.rest.upsertRecord({
  app: 542,
  updateKey: {
    field: 'String',
    value: 'string2'
  },
  record: record
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});;

kintoneUtility.rest.upsertRecords(param)

• insert or update up to 1500 records to kintone app.
• If the records are over 1500, It is thrown Error.
• Insert the records if the updateKey doesn't exists.
• Update the records if the updateKey exists.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.records	Array	Yes	Holds an array of objects that include updateKey, revision and record objects.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

var records = [
  {
    updateKey: {
      field: 'String',
      value: 'string1'
    },
    record: {
      Number: {
        value: 12345
      }
    }
  },
  {
    updateKey: {
      field: 'String',
      value: 'string2'
    },
    record: {
      Number: {
        value: 123456
      }
    }
  }
];
kintoneUtility.rest.upsertRecords({
  app: 542,
  records: records,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.downloadFile(param)

• Download a file attached to record.
• You can get file key by "kintoneUtility.rest.getRecord" or "kintoneUtility.rest.getRecords".

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.fileKey	String	Yes	The file key that you want to download.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.downloadFile({
  fileKey: '20170403061310F33E961E5B7C43079759269996409F50150',
  isGuest: false
}).then(function(response) {
  console.log(response); //Blob
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.uploadFile(param)

• Upload a file to kintone.
• Should specify Blob format data.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.fileName	String	Yes	The file name you will upload.
param.blob	Object	Yes	The blob format data.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.uploadFile({
  fileName: 'sample.txt',
  blob: new Blob(['Sample Text File'], {type:'text\/plain'}),
  isGuest: false
}).then(function(response) {
  console.log(response); //fileKey
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.getFormFields(param)

• Get the list of fields and field settings of an App.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.lang	String	Optional	The localized language to retrieve the data in: default: retrieves the default names en: retrieves the localized English names zh: retrieves the localized Chinese names ja: retrieves the localized Japanese names user: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. *If the user language setting is set to "Use Web browser settings", the settings set in the Accept-Language header will be used. If there is no Accept-Language header, the language set in the "Localization" settings in the System Administrator's menu will be used.
param.isPreview	Boolean	Optional	The default is false, to be true if you want to get pre-live setting.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getFormFields({
  app: 542,
  lang: 'default',
  isPreview: false,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.getFormLayout(param)

• Get the field layout info of a form in an App.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.isPreview	Boolean	Optional	The default is false, to be true if you want to get pre-live setting.
param.isGuest	Boolean	Optional	The default is false, to be true if the app is belonged to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getFormLayout({
  app: 542,
  isPreview: false,
  isGuest: false
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.postDeployAppSettings(param)

• Deploy the apps to the production environments.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.apps	Object	Yes	The array of the app information.
param.apps[].app	Number	Yes	The app ID.
param.apps[].revision	Number	Optional	The expected revision number. If the value does not match, an error will occur and the record will not be updated. If the value is not specified or is -1, the revision number will not be checked.
param.revert	Boolean	Optional	Default: false. Set true if you want to revert the deploy when some error occur during it.
param.isPreview	Boolean	Optional	Default: false. Set true if you want to get pre-live setting.
param.isGuest	Boolean	Optional	Default: false. Set true if the app belongs to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.postDeployAppSettings({
  apps: [
    { app: 542 },
  ],
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.getAppDeployStatus(param)

• Get the status of the deployments of the apps.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.apps	Number[]	Yes	The array of the ids of the apps.
param.isGuest	Boolean	Optional	Default: false. Set true if the app belongs to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getAppDeployStatus({
  apps: [ 542 ],
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.getCustomization(param)

• Gets the JavaScript and CSS Customization settings of an App.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.isPreview	Boolean	Optional	Default: false. Set true if you want to get pre-live setting.
param.isGuest	Boolean	Optional	Default: false. Set true if the app belongs to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.getCustomization({
  app: 542,
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.updateCustomization(param)

• Updates the JavaScript and CSS Customization settings of an App.

Parameter

Name	Data type	Required	Description
param	Object	Yes
param.app	Number	Yes	The app ID.
param.scope	String	Optional	The target to apply this setting: ALL, ADMIN, or NONE.
param.desktop	Object	Optional	Customize files for the desktop app.
param.desktop.js	Object[]	Optional	JavaScript files information.
param.desktop.js[].type	String	Yes	The type of the file: URL or FILE.
param.desktop.js[].url	String	Optional	The URL of the file. Required when URL is specified as the type.
param.desktop.js[].file	Object	Optional	The information of the uploaded file. Required when FILE is specified as the type.
param.desktop.js[].file.fileKey	String	Yes	The file key of the uploaded file.
param.desktop.css	Object[]	Optional	CSS files information.
param.desktop.css[].type	String	Yes	The type of the file: URL or FILE.
param.desktop.css[].url	String	Optional	The URL of the file. Required when URL is specified as the type.
param.desktop.css[].file	Object	Optional	The information of the uploaded file. Required when FILE is specified as the type.
param.desktop.css[].file.fileKey	String	Yes	The file key of the uploaded file.
param.mobile	Object	Optional	Customize files for the mobile app.
param.mobile.js	Object[]	Optional
param.mobile.js[].type	String	Yes	The type of the file: URL or FILE.
param.mobile.js[].url	String	Optional	The URL of the file. Required when URL is specified as the type.
param.mobile.js[].file	Object	Optional	The information of the uploaded file. Required when FILE is specified as the type.
param.mobile.js[].file.fileKey	String	Yes	The file key of the uploaded file.
param.revision	Number	Optional	The expected revision number. If the value does not match, an error will occur and the record will not be updated. If the value is not specified or is -1, the revision number will not be checked.
param.isGuest	Boolean	Optional	Default: false. Set true if the app belongs to a guest space.

Response

Promise Object

Sample

kintoneUtility.rest.updateCustomization({
  app: 542,
  desktop: {
    js: [
      {
        type: 'FILE',
        file: { fileKey: 'xxxxxxxxxxxxxxxx' },
      }
    ],
    css: [
      {
        type: 'FILE',
        file: { fileKey: 'xxxxxxxxxxxxxxxx' },
      }
    ],
  },
}).then(function(response) {
  console.log(response);
}).catch(function(error) {
  console.log(error);
});

kintoneUtility.rest.setUserAuth(loginName, password)

• Specify login name and password when execute API except for user logged in to kintone.

Parameter

Name	Data type	Required	Description
loginName	String	Yes	The login name for user authentication.
password	String	Yes	The password for user authentication.

Response

None

Sample

kintoneUtility.rest.setUserAuth('loginName', 'password');

kintoneUtility.rest.setApiTokenAuth(apiToken)

• Specify API token when you need to execute API by token.

Parameter

Name	Data type	Required	Description
apiToken	String	Yes	The API Token that will be created by app.

Response

None

Sample

kintoneUtility.rest.setApiTokenAuth('vZCkStSK3SD7zyHh17auyRrBJajjFrVaffit738');

kintoneUtility.rest.setDomain(domain)

• Specify the domain when you need.
• In many cases it is not necessary.

Parameter

Name	Data type	Required	Description
domain	String	Yes	Your kintone's domain. (e.g. 'sample.cybozu.com')

Response

None

Sample

kintoneUtility.rest.setDomain('sample.cybozu.com');

kintoneUtility.rest.setBasicAuth(userName, password)

• Specify user name and password for basic authentication when you need.
• In many cases it is not necessary.

Parameter

Name	Data type	Required	Description
userName	String	Yes	The user name for basic authentication.
password	String	Yes	The password for basic authentication.

Response

None

Sample

kintoneUtility.rest.setBasicAuth('userName', 'password');

kintoneUtility.rest.setGuestSpaceId(guestSpaceId)

• Can specify guest space ID.
• isGuest parameter is not necessary when you use "kintoneUtility.rest.setGuestSpaceId".

Parameter

Name	Data type	Required	Description
guestSpaceId	Number	Yes	The guest space ID to which the application belongs.

Response

None

Sample

kintoneUtility.rest.setGuestSpaceId('12');

kintoneUtility.rest.clearUserAuth()

• Clear the info that you set by "kintoneUtility.rest.setUserAuth".

Parameter

None

Response

None

Sample

kintoneUtility.rest.clearUserAuth();

kintoneUtility.rest.clearApiTokenAuth()

• Clear the info that you set by "kintoneUtility.rest.setApiTokenAuth".

Parameter

None

Response

None

Sample

kintoneUtility.rest.clearApiTokenAuth();

kintoneUtility.rest.clearDomain()

• Clear the info that you set by "kintoneUtility.rest.setDomain".

Parameter

None

Response

None

Sample

kintoneUtility.rest.clearDomain();

kintoneUtility.rest.clearBasicAuth()

• Clear the info that you set by "kintoneUtility.rest.setBasicAuth".

Parameter

None

Response

None

Sample

kintoneUtility.rest.clearBasicAuth();

kintoneUtility.rest.clearGuestSpaceId()

• Clear the info that you set by "kintoneUtility.rest.setGuestSpaceId".

Parameter

None

Response

None

Sample

kintoneUtility.rest.clearGuestSpaceId();