Skip to content

Record

Provide manipulate functions on records: get, update, delete, update the record status & assignees in the kintone app

Constructor

Parameter

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

Sample code

Init record module

Source code 


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

let kintoneRecord = new kintone.Record(connection);

Methods

getRecord(appID, recordID)

Retrieves details of 1 record from an app.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordID Integer yes The record ID in kintone app

Return

Promise

Sample code

Get record

Source code 

let appID = /*{your_app_id}*/;
let recordID = {your_record_id};
kintoneRecord.getRecord(appID, recordID)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getRecords(appID, query, fieldsCode, isShowTotalCount)

Retrieves details of multiple records from an app using a query string.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
query String (optional) The query string that will specify what records will be responded.
fields Array<String> (optional) List of field codes you want in the response.
isShowTotalCount Boolean (optional) If "true", the request will retrieve total count of records match with query conditions.

Return

Promise

Sample code

Get records

Source code 

let appID = /*{your_app_id}*/;
let query = '{your_query_string}';
let fieldsCode = [
    '{your_field_code}',
    // another fieldCode
]
let isShowTotalCount = /*{your_decide_true_or_false}*/;
kintoneRecord.getRecords(appID, query, fieldsCode, isShowTotalCount)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

addRecord(appID, recordData)

Add one record to an app.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordData JSONObject (optional) The record data to be add to kintone app. About the format, please look the sample below or reference at the end of this page

Return

Promise

Sample code

Add record

Source code 

let appID = /*{your_app_id}*/;
let recordData = {
    YourFieldCode: {
        value: 'Value Of YourFieldCode'
    },
    // Another fieldcode here
};
kintoneRecord.addRecord(appID, recordData)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

addRecords(appID, recordsData)

Add multiple records to an app.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordsData Array<JSONObject> yes List of records data to be add to kintone app. About the format, please look the sample below or reference at the end of this page.

Return

Promise

Sample code

Add multi records

Source code 

let appID = /*{your_app_id}*/;
let recordData = {
    YourFieldCode: {
        value: 'Value Of YourFieldCode'
    },
    // Another fieldcode here
};
let recordsData = [
    recordData,
    // another recordData
];
kintoneRecord.addRecords(appID, recordsData)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

updateRecordById(appID, recordID, recordData, revision)

Updates details of 1 record in an app by specifying its record number.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordID Integer yes The record ID on kintone app
recordData JSONObject yes The record data to be update in kintone app. About the format, please look the sample below or reference at the end of this page.
revision Integer (optional) The revision number of record

Return

Promise

Sample code

Update record by ID

Source code 

let appID = /*{your_app_id}*/;
let recordID = /*{your_record_id}*/;
let recordData = {
    YourFieldCode: {
        value: 'Value Of YourFieldCode'
    },
    // Another fieldcode here
};
let revision = /*{revision_of_record}*/;
kintoneRecord.updateRecordById(appID, recordID, recordData, revision)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

updateRecordByUpdateKey(appID, updateKey, recordData, revision)

Updates details of 1 record in an app by unique key.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
updateKey JSONObject yes The unique key of the record to be updated. About the format, please look the sample below or reference at the end of this page.
recordData JSONObject yes The record data will be added to kintone app. About the format, please look the sample below or reference at the end of this page.
revision Integer (optional) The revision number of record

Return

Promise

Sample code

Update record by UpdateKey

Source code 

let appID = /*{your_app_id}*/;
let updateKey = {
    field: '{your_fieldcode}',
    value: '{your_fieldcode_value}'
};
let recordData = {
    YourFieldCode: {
        value: 'Value Of YourFieldCode'
    },
    // Another fieldcode here
};
let revision = /*{revision_of_record}*/;
kintoneRecord.updateRecordByUpdateKey(appID, updateKey, recordData, revision)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

updateRecords(appID, recordsData)

Updates details of multiple records in an app, by specifying their record number, or a different unique key.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordsData Array<JSONObject> yes The record data will be added to kintone app. About the format, please look the sample below or reference at the end of this page.

Return

Promise

Sample code

Update multi records

Source code 

let appID = /*{your_app_id}*/;
let recordData = {
    YourFieldCode: {
        value: 'Value Of YourFieldCode'
    },
    // Another fieldcode here
};
let recordDataUpdate = {
    id: /*{your_record_id}*/, // Optional. Required, if updateKey will not be specified.
    updateKey: { // Optional. Required, if id will not be specified.
        field: '{your_field_code}',
        value: '{your_field_code_value}'
    },
    record: recordData,
    revision: /*{record_revision_number}*/ // Optional
};
let recordsDataUpdate = [
    recordDataUpdate,
    // Another recordDataUpdate
]
kintoneRecord.updateRecords(appID, recordsDataUpdate)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

deleteRecords(appID, recordIDs)

Deletes multiple records in an app.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordIDs Array<Integer> yes The list ids of record will be delete.

Return

Promise

Sample code

Delete multi record

Source code 

let appID = /*{your_app_id}*/;
let recordIDs = [/*your_record_id*/]
kintoneRecord.deleteRecords(appID, recordIDs)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

deleteRecordsWithRevision(appID, idsWithRevision)

Deletes multiple records in an app with revision.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
idsWithRevision JSONObject yes JSONObject format by HashTable<Integer, Integer> (key: The Id of record, value: The Revision of record.)

Return

Promise

Sample code

Delete record with revision

Source code 

let appID = /*{your_app_id}*/;
let idsWithRevision = {
    /*your_record_id: revision_of_record*/
}
kintoneRecord.deleteRecordsWithRevision(appID, idsWithRevision)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

updateRecordAssignees(appID, recordID, assignees, revision)

Update assignees of a record.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordID Integer yes The record ID of kintone app
assignees Array<String> yes The user code(s) of the assignee(s)
revision Integer (option) The revision number of record

Return

Promise

Sample code

update record Assignees

Source code 

let appID = /*{your_app_id}*/;
let recordID = /*{your_record_id}*/;
let assignees = [/*your_assignee(s)*/];
let revision = /*{revision_of_record}*/;

kintoneRecord.updateRecordAssignees(appID, recordID, assignees, revision)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

updateRecordStatus(appID, recordID, actionName, assignee, revision)

Updates the Status of a record of an app.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID.
recordID Integer yes The record ID on kintone app.
actionName String yes The Action name will be run.
assignee String (Conditionally required) The next Assignee. Specify the Assignee's log in name.
Required, if the "Assignee List" of the current status is set to "User chooses one assignee from the list to take action", and a selectable assignee exists.
assignee Integer (optional) The revision of record

Return

Promise

Sample code

Update record status

Source code 

let appID = /*{your_app_id}*/;
let recordID = /*{your_record_id}*/;
let actionName = /*{your_action_name}*/;
let assignee = '/*your_assignee(s)*/';
let revision = /*{revision_of_record}*/;

kintoneRecord.updateRecordStatus(appID, recordID, actionName, assignee, revision)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

updateRecordsStatus(appID, recordsStatusUpdate)

Updates the Status of multiple records of an app.

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordsStatusUpdate Array<JSONObject> yes The recod status data. See belowsample codee or reference at the end of this page to know format.

Return

Promise

Sample code

Update multi record status

Source code 

let appID = /*{your_app_id}*/;
let recordStatusUpdateItem = {
    id: /*your_record_id*/,
    action: '/*your_action_name*/',
    assignee: '/*your_assignee*/',
    revision: /*your_record_revision*/
}
let recordsStatusUpdate = [
    recordStatusUpdateItem,
    /*another data like recordStatusUpdateItem*/
];
kintoneRecord.updateRecordsStatus(appID, recordsStatusUpdate)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

getComments(appID, recordID, order, offset, limit)

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordID Integer yes The kintone app ID
order String (optional) The sort order of the Comment ID. Please select asc or desc
offset Integer (optional) The number of first comments will be ignored.
limit Integer (optional) The number of records to retrieve.

Return

Promise

Sample code

Get comments

Source code 

let appID = /*{your_app_id}*/;
let recordID = /*{your_record_id}*/;
let order = /*{your_order_type}*/; // asc or desc
let offset = /*{your_offset_number}*/;
let limit = /*{your_limit number}*/;
kintoneRecord.getComments(appID, recordID, order, offset, limit)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

addComment(appID, recordID, commentContent)

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordID Integer yes The kintone app ID
commentContent JSONObject yes About the format, please look the sample below or reference at the end of this page.

Return

Promise

Sample code

Add comment

Source code 

let appID = /*{your_app_id}*/;
let recordID = /*{your_record_id}*/;
let commentContent = {
    text: '/*your_comment_content*/',
    mentions: [
        {
            code: '/*your_member_code*/',
            type: '/*your_member_type*/' // either `USER` or `GROUP` or `ORGANIZATION`
        },
        // another mention here
    ]
};
kintoneRecord.addComment(appID, recordID, commentContent)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

deleteComment(appID, recordID, commentID)

Parameter

Name Type Required Description
appID Integer yes The kintone app ID
recordID Integer yes The record ID on kintone app
commentID Integer yes The comment ID on kintone record

Return

Promise

Sample code

Delete comment

Source code 

let appID = /*{your_app_id}*/;
let recordID = /*{your_record_id}*/;
let commentID = /*{your_comment_id}*/;
kintoneRecord.deleteComment(appID, recordID, commentID)
    .then((rsp) => {
        console.log(rsp);
    })
    .catch((err) => {
        // This SDK return err with KintoneAPIExeption
        console.log(err.get());
    });

Reference