Skip to content

App

Gets general information of an App, including the name, description, related Space, creator and updater information.

  • Permissions to view the App is needed.
  • API Tokens cannot be used with this API.

Constructor

Parameter

Name Type Required Description
connection Connection yes The connection module of this SDK.

Sample code

Init app module Source code 
App appManagerment = new App(connection);

Methods

getApp(appId)

Get single app

Parameter

Name Type Required Description
appId Integer yes The kintone app ID

Return

AppModel

Sample code

get App Source code 
Integer appID = 1;

App appManagerment = new App(connection);
AppModel app = appManagerment.getApp(appID);

getApps(offset, limit)

Get multiple apps

Parameter

Name Type Required Description
offset Integer (optional) The offset off data result
limit Integer (optional) The limit number of result

Return

List<AppModel>

Sample code

Get Apps Source code 
Integer offset = 10;
Integer limit = 50;

App appManagerment = new App(connection);
List app_list = appManagerment.getApps(offset, limit);

getAppsByIDs(ids, offset, limit)

Get multiple apps by list of ids

Parameter

Name Type Required Description
ids List<Integer> yes The array of app ids
offset Integer (optional) The offset off data result
limit Integer (optional) The limit number of result

Return

List<AppModel>

Sample code

get Apps By IDs Source code 
Integer offset = 1;
Integer limit = 10;
List ids = new List();

ids.add(1);
ids.add(2);
ids.add(3);

App appManagerment = new App(connection);
List app_list = appManagerment.getAppsByIDs(ids, offset, limit);

getAppsByCodes(codes, offset, limit)

Get multiple apps by a list of codes

Parameter

Name Type Required Description
codes List<String> yes The array of app codes
offset Integer (optional) The offset off data result
limit Integer (optional) The limit number of result

Return

List<AppModel>

Sample code

get Apps By Codes Source code 
Integer offset = 1;
Integer limit = 10;
List codes = new List();

codes.add('APP_CODE_1');
codes.add('APP_CODE_2');

App appManagerment = new App(connection);
List app_list = appManagerment.getAppsByCodes(codes, offset, limit);

getAppsByName(name, offset, limit)

Get multiple apps by name

Parameter

Name Type Required Description
name String yes The app name
offset Integer (optional) The offset off data result
limit Integer (optional) The limit number of result

Return

List<AppModel>

Sample code

get Apps By Name Source code 
String name = "sample_app_name";
Integer offset = 1;
Integer limit = 10;

App appManagerment = new App(connection);
List app_list = appManagerment.getAppsByName(name, offset, limit);

getAppsBySpaceIDs(spaceIds, offset, limit)

Get multiple apps by list of space's ids

Parameter

Name Type Required Description
spaceIds List<Integer> yes The array of space ids
offset Integer (optional) The offset off data result
limit Integer (optional) The limit number of result

Return

List<AppModel>

Sample code

get Apps By Space IDs Source code 
Integer offset = 1;
Integer limit = 10;
List spaceIds = new List();

App appManagerment = new App(connection);
List app_list = appManagerment.getAppsBySpaceIDs(spaceIds, offset, limit);

getFormFields(appId, lang, isPreview)

Get field of form in kintone app

Parameter

Name Type Required Description
appId Integer yes The app ID
lang LanguageSetting (optional) The language code. Support:
  • DEFAULT: Default language setting of system
  • JA: Japanese language setting
  • ZH: Chinese language setting
  • EN: English language setting
isPreview Boolean (optional) Get the app form fields with a pre-live settings.

Return

FormFields

Sample code

get FormFields Source code 
Integer appID = 1;
LanguageSetting lang = LanguageSetting.JA;
Boolean isPreview = true;

App appManagerment = new App(connection);
FormFields fields = appManagerment.getFormFields(appID, lang, isPreview);

getFormLayout(appId, isPreview)

Get layout of form in kintone app

Parameter

Name Type Required Description
appId Integer yes The kintone app id
isPreview Boolean (optional) Get the app form layout with a pre-live settings.

Return

FormLayout

Sample code

get FormLayout Source code 
Integer appID = 1;
Boolean isPreview = true;

App appManagerment = new App(connection);
FormFields fields = appManagerment.getFormLayout(appID, isPreview);

Reference