com.kintone.client

Class RecordClient

Object

RecordClient

public class RecordClient
extends Object

A client that operates record APIs.

Method Summary

Modifier and Type	Method and Description
AddRecordResponseBody	addRecord(AddRecordRequest request) Adds 1 record to an App.
long	addRecord(long app, Record record) Adds 1 record to an App.
AddRecordCommentResponseBody	addRecordComment(AddRecordCommentRequest request) Add a comment to a record in an app.
long	addRecordComment(long app, long recordId, RecordComment comment) Add a comment to a record in an app.
AddRecordsResponseBody	addRecords(AddRecordsRequest request) Adds multiple records to an App.
List<Long>	addRecords(long app, List<Record> records) Adds multiple records to an App.
long	countRecords(long app) Get the number of records.
long	countRecords(long app, String query) Get the number of records.
CreateCursorResponseBody	createCursor(CreateCursorRequest request) Creates a cursor so that large amount of records can be obtained from an App.
String	createCursor(long app) Creates a cursor so that large amount of records can be obtained from an App.
String	createCursor(long app, List<String> fields, String query) Creates a cursor so that large amount of records can be obtained from an App.
DeleteCursorResponseBody	deleteCursor(DeleteCursorRequest request) Deletes a cursor by specifying the cursor ID.
void	deleteCursor(String id) Deletes a cursor by specifying the cursor ID.
DeleteRecordCommentResponseBody	deleteRecordComment(DeleteRecordCommentRequest request) Delete a comment in a record in an app.
void	deleteRecordComment(long app, long recordId, long commentId) Delete a comment in a record in an app.
DeleteRecordsResponseBody	deleteRecords(DeleteRecordsRequest request) Deletes multiple records in an app.
void	deleteRecords(long app, List<Long> recordIds) Deletes multiple records in an app.
void	deleteRecords(long app, List<Long> recordIds, List<Long> revisions) Deletes multiple records in an app.
GetRecordResponseBody	getRecord(GetRecordRequest request) Retrieves details of 1 record from an App by specifying the App ID and record ID.
Record	getRecord(long app, long recordId) Retrieves details of 1 record from an App by specifying the App ID and record ID.
GetRecordCommentsResponseBody	getRecordComments(GetRecordCommentsRequest request) Retrieves multiple comments from a record in an app.
List<PostedRecordComment>	getRecordComments(long app, long recordId) Retrieves multiple comments from a record in an app.
List<PostedRecordComment>	getRecordComments(long app, long recordId, Order order, Long offset, Long limit) Retrieves multiple comments from a record in an app.
GetRecordsResponseBody	getRecords(GetRecordsRequest request) Retrieves details of multiple records from an App.
List<Record>	getRecords(long app) Retrieves details of multiple records from an App.
List<Record>	getRecords(long app, int limit, long offset) Retrieves details of multiple records from an App.
List<Record>	getRecords(long app, List<String> fields, int limit, long offset) Retrieves details of multiple records from an App.
List<Record>	getRecords(long app, List<String> fields, String query) Retrieves details of multiple records from an App by specifying a query string.
List<Record>	getRecords(long app, String query) Retrieves details of multiple records from an App by specifying a query string.
GetRecordsByCursorResponseBody	getRecordsByCursor(GetRecordsByCursorRequest request) Retrieves multiple records from an App by specifying the cursor ID.
GetRecordsByCursorResponseBody	getRecordsByCursor(String id) Retrieves multiple records from an App by specifying the cursor ID.
long	updateRecord(long app, long recordId, Record record) Updates details of 1 record in an App by specifying its record number.
long	updateRecord(long app, UpdateKey updateKey, Record record) Updates details of 1 record in an App by specifying a different unique key.
UpdateRecordResponseBody	updateRecord(UpdateRecordRequest request) Updates details of 1 record in an App by specifying its record number, or a different unique key.
long	updateRecordAssignees(long app, long recordId, List<String> assignees) Updates the Assignees of a record status, that was set with the Process Management feature.
UpdateRecordAssigneesResponseBody	updateRecordAssignees(UpdateRecordAssigneesRequest request) Updates the Assignees of a record status, that was set with the Process Management feature.
List<RecordRevision>	updateRecords(long app, List<RecordForUpdate> records) Updates details of multiple records in an App, by specifying their record numbers, or their unique keys.
UpdateRecordsResponseBody	updateRecords(UpdateRecordsRequest request) Updates details of multiple records in an App.
long	updateRecordStatus(long app, long recordId, String action) Updates the Status of a record of an App, that was set with the Process Management feature.
long	updateRecordStatus(long app, long recordId, String action, String assignee) Updates the Status of a record of an App, that was set with the Process Management feature.
UpdateRecordStatusResponseBody	updateRecordStatus(UpdateRecordStatusRequest request) Updates the Status of a record of an App, that was set with the Process Management feature.
List<RecordRevision>	updateRecordStatuses(long app, List<StatusAction> statusActions) Updates the Statuses of multiple records of an App, that were set with the Process Management feature.
UpdateRecordStatusesResponseBody	updateRecordStatuses(UpdateRecordStatusesRequest request) Updates the Statuses of multiple records of an App, that were set with the Process Management feature.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addRecord

public long addRecord(long app,
                      Record record)

Adds 1 record to an App.

Parameters:

app - the App ID

record - the record object. See Record

Returns:

the record ID of the created record

addRecord

public AddRecordResponseBody addRecord(AddRecordRequest request)

Adds 1 record to an App.

Parameters:

request - the request parameters. See AddRecordRequest

Returns:

the response data. See AddRecordResponseBody

addRecordComment

public long addRecordComment(long app,
                             long recordId,
                             RecordComment comment)

Add a comment to a record in an app.

Parameters:

app - the App ID

recordId - the record ID

comment - an object including comment details

Returns:

the comment ID

addRecordComment

public AddRecordCommentResponseBody addRecordComment(AddRecordCommentRequest request)

Add a comment to a record in an app.

Parameters:

request - the request parameters. See AddRecordCommentRequest

Returns:

the response data. See AddRecordCommentResponseBody

addRecords

public List<Long> addRecords(long app,
                             List<Record> records)

Adds multiple records to an App.

Parameters:

app - the App ID

records - a list of records. See Record

Returns:

the record IDs of the created records

addRecords

public AddRecordsResponseBody addRecords(AddRecordsRequest request)

Adds multiple records to an App.

Parameters:

request - the request parameters. See AddRecordsRequest

Returns:

the response data. See AddRecordsResponseBody

countRecords

public long countRecords(long app)

Get the number of records.

Parameters:

app - the App ID

Returns:

the number of records

countRecords

public long countRecords(long app,
                         String query)

Get the number of records.

Parameters:

app - the App ID

query - the query string

Returns:

the number of records

createCursor

public String createCursor(long app)

Creates a cursor so that large amount of records can be obtained from an App.

Parameters:

app - the App ID

Returns:

the created cursor ID

createCursor

public String createCursor(long app,
                           List<String> fields,
                           String query)

Creates a cursor so that large amount of records can be obtained from an App.

Parameters:

app - the App ID

fields - the field codes to be included in the response when using the Get Cursor API

query - the query string that will specify what records will be responded when using the Get Cursor API

Returns:

the created cursor ID

createCursor

public CreateCursorResponseBody createCursor(CreateCursorRequest request)

Creates a cursor so that large amount of records can be obtained from an App.

Parameters:

request - the request parameters. See CreateCursorRequest

Returns:

the response data. See CreateCursorResponseBody

deleteCursor

public void deleteCursor(String id)

Deletes a cursor by specifying the cursor ID.

Parameters:

id - the cursor ID

deleteCursor

public DeleteCursorResponseBody deleteCursor(DeleteCursorRequest request)

Deletes a cursor by specifying the cursor ID.

Parameters:

request - the request parameters. See DeleteCursorRequest

Returns:

the response data. See DeleteCursorResponseBody

deleteRecordComment

public void deleteRecordComment(long app,
                                long recordId,
                                long commentId)

Delete a comment in a record in an app.

Parameters:

app - the App ID

recordId - the record ID

commentId - the comment ID

deleteRecordComment

public DeleteRecordCommentResponseBody deleteRecordComment(DeleteRecordCommentRequest request)

Delete a comment in a record in an app.

Parameters:

request - the request parameters. See DeleteRecordCommentRequest

Returns:

the response data. See DeleteRecordCommentResponseBody

deleteRecords

public void deleteRecords(long app,
                          List<Long> recordIds)

Deletes multiple records in an app.

Parameters:

app - the app ID

recordIds - a list of record IDs that will be deleted

deleteRecords

public void deleteRecords(long app,
                          List<Long> recordIds,
                          List<Long> revisions)

Deletes multiple records in an app.

Parameters:

app - the app ID

recordIds - a list of record IDs that will be deleted

revisions - the expected revision numbers. The first id number will correspond to the first revision number in the list, the second id to the second revision number, and so on.

deleteRecords

public DeleteRecordsResponseBody deleteRecords(DeleteRecordsRequest request)

Deletes multiple records in an app.

Parameters:

request - the request parameters. See DeleteRecordsRequest

Returns:

the response data. See DeleteRecordsResponseBody

getRecord

public Record getRecord(long app,
                        long recordId)

Retrieves details of 1 record from an App by specifying the App ID and record ID.

Parameters:

app - the App ID

recordId - the record ID

Returns:

the record object. See Record

getRecord

public GetRecordResponseBody getRecord(GetRecordRequest request)

Retrieves details of 1 record from an App by specifying the App ID and record ID.

Parameters:

request - the request parameters. See GetRecordRequest

Returns:

the response data. See GetRecordResponseBody

getRecordComments

public List<PostedRecordComment> getRecordComments(long app,
                                                   long recordId)

Retrieves multiple comments from a record in an app.

Parameters:

app - the App ID

recordId - the record ID

Returns:

a list of comments

getRecordComments

public List<PostedRecordComment> getRecordComments(long app,
                                                   long recordId,
                                                   Order order,
                                                   Long offset,
                                                   Long limit)

Retrieves multiple comments from a record in an app.

Parameters:

app - the App ID

recordId - the record ID

order - the sort order of the Comment ID. Specifying Order.ASC will sort the comments in ascending order, and Order.DESC will sort the comments in descending order.

offset - This skips the retrieval of the first number of comments.

limit - the number of records to retrieve

Returns:

a list of comments. See PostedRecordComment

getRecordComments

public GetRecordCommentsResponseBody getRecordComments(GetRecordCommentsRequest request)

Retrieves multiple comments from a record in an app.

Parameters:

request - the request parameters. See GetRecordCommentsRequest

Returns:

the response data. See GetRecordCommentsResponseBody

getRecords

public List<Record> getRecords(long app)

Retrieves details of multiple records from an App.

Parameters:

app - the App ID

Returns:

a list of records. See Record

getRecords

public List<Record> getRecords(long app,
                               int limit,
                               long offset)

Retrieves details of multiple records from an App.

Parameters:

app - the App ID

limit - the maximum number of records to be retrieved

offset - This skips retrieving the first number of records.

Returns:

a list of records. See Record

getRecords

public List<Record> getRecords(long app,
                               List<String> fields,
                               int limit,
                               long offset)

Retrieves details of multiple records from an App.

Parameters:

app - the App ID

fields - the field codes to be included in the response. Ignoring this parameter will return all accessible fields that exist in the App.

limit - the maximum number of records to be retrieved

offset - This skips retrieving the first number of records.

Returns:

a list of records. See Record

getRecords

public List<Record> getRecords(long app,
                               String query)

Retrieves details of multiple records from an App by specifying a query string.

Parameters:

app - the App ID

query - the query string that specifies what records to include in the response

Returns:

a list of records. See Record

getRecords

public List<Record> getRecords(long app,
                               List<String> fields,
                               String query)

Retrieves details of multiple records from an App by specifying a query string.

Parameters:

app - the App ID

fields - the field codes to be included in the response. Ignoring this parameter will return all accessible fields that exist in the App.

query - the query string that specifies what records to include in the response

Returns:

a list of records. See Record

getRecords

public GetRecordsResponseBody getRecords(GetRecordsRequest request)

Retrieves details of multiple records from an App.

Parameters:

request - the request parameters. See GetRecordsRequest

Returns:

the response data. See GetRecordsResponseBody

getRecordsByCursor

public GetRecordsByCursorResponseBody getRecordsByCursor(String id)

Retrieves multiple records from an App by specifying the cursor ID.

Parameters:

id - the cursor ID

Returns:

the response data. See GetRecordsByCursorResponseBody

getRecordsByCursor

public GetRecordsByCursorResponseBody getRecordsByCursor(GetRecordsByCursorRequest request)

Retrieves multiple records from an App by specifying the cursor ID.

Parameters:

request - the request parameters. See GetRecordsByCursorRequest

Returns:

the response data. See GetRecordsByCursorResponseBody

updateRecord

public long updateRecord(long app,
                         long recordId,
                         Record record)

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

Parameters:

app - the App ID

recordId - the record ID

record - the record object. See Record

Returns:

the revision number of the record

updateRecord

public long updateRecord(long app,
                         UpdateKey updateKey,
                         Record record)

Updates details of 1 record in an App by specifying a different unique key.

Parameters:

app - the App ID

updateKey - the unique key of the record to be updated

record - the record object. See Record

Returns:

the revision number of the record

updateRecord

public UpdateRecordResponseBody updateRecord(UpdateRecordRequest request)

Updates details of 1 record in an App by specifying its record number, or a different unique key.

Parameters:

request - the request parameters. See UpdateRecordRequest

Returns:

the response data. See UpdateRecordResponseBody

updateRecordAssignees

public long updateRecordAssignees(long app,
                                  long recordId,
                                  List<String> assignees)

Updates the Assignees of a record status, that was set with the Process Management feature.

Parameters:

app - the App ID

recordId - the record ID

assignees - the user codes of the Assignee(s)

Returns:

the revision number of the record after updating the Assignees

updateRecordAssignees

public UpdateRecordAssigneesResponseBody updateRecordAssignees(UpdateRecordAssigneesRequest request)

Updates the Assignees of a record status, that was set with the Process Management feature.

Parameters:

request - the request parameters. See UpdateRecordAssigneesRequest

Returns:

the response data. See UpdateRecordAssigneesResponseBody

updateRecords

public List<RecordRevision> updateRecords(long app,
                                          List<RecordForUpdate> records)

Updates details of multiple records in an App, by specifying their record numbers, or their unique keys.

Parameters:

app - the App ID

records - a list of objects that include id/updateKey, revision and record objects

Returns:

a list of record revisions. See RecordRevision

updateRecords

public UpdateRecordsResponseBody updateRecords(UpdateRecordsRequest request)

Updates details of multiple records in an App.

Parameters:

request - the request parameters. See UpdateRecordsRequest

Returns:

the response data. See UpdateRecordsResponseBody

updateRecordStatus

public long updateRecordStatus(long app,
                               long recordId,
                               String action)

Updates the Status of a record of an App, that was set with the Process Management feature.

Parameters:

app - the App ID

recordId - the record ID

action - the Action name of the action to run

Returns:

the revision number of the record after updating the status

updateRecordStatus

public long updateRecordStatus(long app,
                               long recordId,
                               String action,
                               String assignee)

Updates the Status of a record of an App, that was set with the Process Management feature.

Parameters:

app - the App ID

recordId - the record ID

action - the Action name of the action to run

assignee - the next Assignee. Specify the Assignee's code.

Returns:

the revision number of the record after updating the status

updateRecordStatus

public UpdateRecordStatusResponseBody updateRecordStatus(UpdateRecordStatusRequest request)

Updates the Status of a record of an App, that was set with the Process Management feature.

Parameters:

request - the request parameters. See UpdateRecordStatusRequest

Returns:

the response data. See UpdateRecordStatusResponseBody

updateRecordStatuses

public List<RecordRevision> updateRecordStatuses(long app,
                                                 List<StatusAction> statusActions)

Updates the Statuses of multiple records of an App, that were set with the Process Management feature.

Parameters:

app - the App ID

statusActions - a list including information of the status actions to proceed

Returns:

a list of record revisions. See RecordRevision

updateRecordStatuses

public UpdateRecordStatusesResponseBody updateRecordStatuses(UpdateRecordStatusesRequest request)

Updates the Statuses of multiple records of an App, that were set with the Process Management feature.

Parameters:

request - the request parameters. See UpdateRecordStatusesRequest

Returns:

the response data. See UpdateRecordStatusesResponseBody