Error Handling

KintoneRestAPIError

When the API request responds with a status code other than 200, the client raises KintoneRestAPIError.

KintoneRestAPIError has the following properties:

Name	Type	Description
id	String	The ID of the error.
code	String	The code of the error, to specify the type of error it is.
status	Number	The HTTP status of the response.
headers	Object	The HTTP headers of the response.
message	String	The error message.
bulkRequestIndex	Number or `undefined`	The index of the failed request when executing bulkRequest and one of the requests fails. This value is `undefined` otherwise.

The following methods could throw KintoneAllRecordsError.

KintoneAllRecordsError has the following properties.

Name	Type	Description
processedRecordsResult	Object	The result of the records that have been processed successfully. This is the same type specified in the Returns section of each method.
unprocessedRecords	Array	The records that have not been processed. This is a part of `records` passed as an argument.
error	KintoneRestAPIError	The instance of `KintoneRestAPIError`
errorIndex	Number or `undefined`	The index that an error ocurred.

Suppose we want to add 5000 records by using addAllRecords,
and there's an invalid parameter at 2500th record (records[2499]) that raised an error.

In this case, rest-api-client split the records into 3 chunks of records, and the result of each chunk is the following:

records[0] - records[1999] (2000 records) ... Success. All records are added to Kintone.
records[2000] - records[3999] (2000 records) ... Fail. All records are not added to Kintone.
records[4000] - records[4999] (1000 records) ... Unprocessed. All records are not added to Kintone.

Then the properties of KintoneAllRecordsError is:

Name	Content
processedRecordsResult	`{ records: results[0] - results[1999] }`
unprocessedRecords	`records[2000] - records[4999]`
error	An instance of `KintoneRestAPIError`
errorIndex	`2499` (If Kintone returns) or `undefined`