

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 sample

Source code


const kintone = require('kintone-nodejs-sdk');

let kintoneApp = new kintone.App(connection);

Methods

getApp(appID)

Get single app

Parameter

Name	Type	Required	Description
appID	Integer	yes	The kintone app ID

Return

Promise

Sample code

Get app sample

Source code

let appID = {your_app_id};
kintoneApp.getApp(appID)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

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

Promise

Sample code

Get apps sample

Source code

let limit = /*{your_limit_number}*/;
let offset = /*{your_offset_number}*/;
kintoneApp.getApps(offset, limit)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getAppsByIDs(ids, offset, limit)

Get multiple apps by list of ids

Parameter

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

Return

Promise

Sample code

Get apps sample

Source code

let appIDs = [{YOUR_APP_ID_1}, {YOUR_APP_ID_2}, {YOUR_APP_ID_n}];
let limit = /*{your_limit_number}*/;
let offset = /*{your_offset_number}*/;
kintoneApp.getAppsByIDs(appIDs, offset, limit)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getAppsByCodes(codes, offset, limit)

Get multiple apps by a list of codes name

Parameter

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

Return

Promise

Sample code

Get apps sample

Source code

let codes = ['YOUR_APP_CODE_1', 'YOUR_APP_CODE_2'];
let limit = /*{your_limit_number}*/;
let offset = /*{your_offset_number}*/;
kintoneApp.getAppsByCodes(codes, offset, limit)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getAppsByName(name, offset, limit)

Get multiple apps by name

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

Promise

Sample code

Get apps sample

Source code

let name = 'your app name';
let limit = /*{your_limit_number}*/;
let offset = /*{your_offset_number}*/;
kintoneApp.getAppsByName(name, offset, limit)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getAppsBySpaceIDs(spaceIDs, offset, limit)

Get multiple apps by list of space's ids

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

Return

Promise

Sample code

Get apps sample

Source code

let spaceIDs = [];
let limit = /*{your_limit_number}*/;
let offset = /*{your_offset_number}*/;
kintoneApp.getAppsBySpaceIDs(spaceIDs, offset, limit)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getFormFields(appID, langCode, isPreview)

Get field of form in kintone app

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

Return

Promise

Sample code

Get app form field sample

Source code

let appID = {your_app_id};
let langCode = {language_code}; // Ex: JA
kintoneApp.getFormFields(appID, langCode)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

// Get a pre-live (preview) form fields
let appID = {your_app_id};
let langCode = {language_code}; // Ex: JA
let isPreview = true;
kintoneApp.getFormFields(appID, langCode, isPreview)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getFormLayout(appID, isPreview)

Get layout of form in kintone app

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

Promise

Sample code

Get form layout sample

Source code

let appID = {your_app_id};
// Get form layout
kintoneApp.getFormLayout(appID)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

// Get a preview (pre-live) form layout
let isPreview = true;
kintoneApp.getFormLayout(appID, isPreview)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

Reference

Get Appon developer network
Get Appson developer network
Get Form fieldson developer network
Get Form Layouton developer network