Record Model
General record response, using for data response from the kintone app
GetRecordResponse
Methods
getRecord
Get the Record data response.
Declaration
func getRecord() -> [String:FieldValue]?
Parameter
(none)
Return
HashMap<String, FieldValue>
GetRecordsResponse
Methods
getRecords
Get the Records data response.
Declaration
func getRecords() -> [[String:FieldValue]]?
Parameter
(none)
Return
ArrayList<HashMap<String, FieldValue>>
getTotalCount
Get the number of records response.
Declaration
func getTotalCount() -> Int?
Parameter
(none)
Return
Integer
AddRecordResponse
Methods
getId
Get the the ID of record added.
Declaration
func getId() -> Int?
Parameter
(none)
Return
Integer
getRevision
Get the revision number of record added.
Declaration
func getRevision() -> Int?
Parameter
(none)
Return
Integer
AddRecordsResponse
Methods
getIDs
Get the array of added records ID.
Declaration
func getIDs() -> [Int]?
Parameter
(none)
Return
ArrayList<Integer>
getRevisions
Get the array of added records revision number.
Declaration
func getRevisions() -> [Int]?
Parameter
(none)
Return
ArrayList<Integer>
UpdateRecordResponse
Methods
getRevision
Get the revision number of record updated.
Declaration
func getRevision() -> Int?
Parameter
(none)
Return
Integer
UpdateRecordsResponse
Methods
getRecords
Get the array of added records ID with revision.
Declaration
func getRecords() -> [RecordUpdateResponseItem]?
Parameter
(none)
Return
ArrayList<RecordUpdateResponseItem>
RecordUpdateResponseItem
Methods
getID
Get the the ID of record updated.
Declaration
func getID() -> Int?
Parameter
(none)
Return
Integer
getRevision
Get the revision number of record updated.
Declaration
func getRevision() -> Int?
Parameter
(none)
Return
Integer
RecordUpdateItem
Constructor
Parameter
| Name | type | Description |
|---|---|---|
| id | Integer | The ID of the record. |
| revision | Integer | The revision number of the record. |
| updateKey | RecordUpdateKey | The unique key of the record to be updated. Required, if id will not be specified. To specify this field, the field must have the "Prohibit duplicate values" option turned on. |
| record | HashMap<String, FieldValue> | The data to update record. |
Methods
(none)
RecordUpdateKey
Constructor
Parameter
| Name | type | Description |
|---|---|---|
| field | String | The field code of unique key in the kintone app. |
| value | String | The field value in the record. |
Methods
(none)
RecordUpdateStatusItem
Constructor
Parameter
| Name | type | Description |
|---|---|---|
| action | String | The Action name of the action you want. |
| assignee | String | (Optional) The next Assignee. Specify the Assignee's log in name.. |
| id | Integer | The record ID. |
| revision | Integer | (Optional) The revision number of the record before updating the status.If the specified revision is not the latest revision, the request will result in an error. |
Methods
(none)
RecordUpsertItem
Constructor
Declaration
public init(_ updateKey: RecordUpdateKey?,_ record: [String:FieldValue]?)
Parameter
| Name | Description |
|---|---|
| updateKey | The unique key of the record to be updated. Required, if id will not be specified. To specify this field, the field must have the "Prohibit duplicate values" option turned on. |
| record | The data to update record. |
Methods
getRecord
Get the Record data response.
Declaration
func getRecord() -> [String:FieldValue]?
Parameter
(none)
Return
HashMap<String, FieldValue>
getRecord
Get the Record data response by UpdateKey.
Declaration
func getRecord(_ updateKey: RecordUpdateKey?) -> [String:FieldValue]?
Parameter
| Name | Description |
|---|---|
| updateKey | The unique key of the record to be updated. Required, if id will not be specified. To specify this field, the field must have the "Prohibit duplicate values" option turned on. |
Return
HashMap<String, FieldValue>
getUpdateKey
Get the unique key of record.
Declaration
func getUpdateKey() -> RecordUpdateKey?
Parameter
(none)
Return
setRecord
Set the Record data response.
Declaration
func setRecord(_ record: [String:FieldValue]?)
Parameter
| Name | Description |
|---|---|
| record | The data to update record. |
Return
(none)
setUpdateKey
Set the unique key of record.
Declaration
func setUpdateKey(_ updateKey: RecordUpdateKey?)
Parameter
| Name | Description |
|---|---|
| updateKey | The unique key of the record to be updated. Required, if id will not be specified. To specify this field, the field must have the "Prohibit duplicate values" option turned on. |
Return
(none)