Record.setSublistValue(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Sets the value of a sublist field. (standard mode only — see SuiteScript 2.x Standard and Dynamic Modes) When working in dynamic mode, set a sublist field value using the following methods: Record.selectLine(options) Record.setCurrentSublistValue(options) Record.commitLine(options) Important: When you edit a sublist line with SuiteScript, it triggers an internal validation of the sublist line. If the line validation fails, the script also fails. For example, if your script edits a closed catch up period, the validation fails and prevents SuiteScript from editing the closed catch up period. Sets a numeric value for rate and ratehighprecision fields.
Returns	record.Record
Supported Script Types	Client and server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/record Module
Sibling Object Members	Record Object Members
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.sublistId	string	required	The internal ID of the sublist. This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser.	2015.2
options.fieldId	string	required	The internal ID of a standard or custom sublist field. See, How to Find a Field's Internal ID.	2015.2
options.line	number	required	The line number of the sublist. Note that line indexing begins at 0 with SuiteScript 2.0.	2015.2
options.value	number | Date | string | array | boolean	required	The value to set the sublist field to. The value type must correspond to the field type being set. For example: Text, Radio and Select fields accept string values. Checkbox fields accept boolean values. Date and DateTime fields accept Date values. Integer, Float, Currency and Percent fields accept number values. Note: There may be a few exceptions to value and field type matching in SuiteScript. For example, the Role field on the Resource tab of project records is a multi-select field. However, in SuiteScript, this field can only accept one internal ID and does not accept an array of values. The only workaround to select multiple values for this field is to use the NetSuite UI.	2015.2

Errors

Error Code	Thrown If
INVALID_FLD_VALUE	The options.value type does not match the field type.
SSS_INVALID_SUBLIST_OPERATION	A required argument is invalid or the sublist is not editable.
SSS_MISSING_REQD_ARGUMENT	A required argument is missing or undefined.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/record Module Script Samples.

          // Add additional code
...
objRecord.setSublistValue({
    sublistId: 'item',
    fieldId: 'item',
    line: 3,
    value: true
});
...
// Add additional code 

        

Related Topics

record.Record

N/record Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices