The FieldWriteOptions class provides functions that set the options for updating or creating fields in a record on a ServiceNow instance.

Table 1. Properties
Name Type Description
queryItems Map<String, String> Collection of request query items that represent the write options.

FieldWriteOptions - FieldWriteOptions(vararg options: FieldWriteOptions.Options)

Sets the options for writing or creating fields in a record on your ServiceNow instance.

Table 2. Parameters
Name Type Description
vararg options FieldWriteOptions.Options Options to set when creating or writing to fields.
Valid values:
  • TREAT_INPUT_VALUES_AS_DISPLAY_VALUES: Specified field values should be saved as the display values. If this value isn't set to true, the passed values are assumed to be the actual field values.
  • SUPPRESS_AUTO_SYS_FIELD: Suppress auto-generation of system fields.

Example

The following code example shows how to call this function.

// Update assigned_to field using actual value (syd_id of user)
val response = runCatching {
    getNowTableService()?.updateRecord("sys_id_of_record", "sn_customerservice_case", mapOf("assigned_to" to "<sys_id_of_user>"))?.execute()
}

// Update assigned_to field using display value
val fieldWriteOptions = FieldWriteOptions(FieldWriteOptions.Options.TREAT_INPUT_VALUES_AS_DISPLAY_VALUES)
val response = runCatching {
    getNowTableService()?.updateRecord("sys_id_of_user", "sn_customerservice_case", mapOf("assigned_to" to "John Doe"))?.execute()
}