Record.setSublistText(options)

Method Description

Sets the value of a sublist field by a text representation. (standard mode only — see SuiteScript 2.x Standard and Dynamic Modes)

When working in dynamic mode, set a sublist field text using the following methods:

Sets a string value with a "%" 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, Finding Internal IDs of Record Fields.	2015.2
`options.line`	number	required	The line number for the field. Note that line indexing begins at 0 with SuiteScript 2.x.	2015.2
`options.text`	string	required	The text to set the value to.	2015.2

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, Finding Internal IDs of Record Fields.

2015.2

options.line

number

required

The line number for the field. Note that line indexing begins at 0 with SuiteScript 2.x.

2015.2

options.text

string

required

The text to set the value to.

2015.2

Errors

Error Code	Thrown If
`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.

Error Code

Thrown If

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.setSublistText({
    sublistId: 'item',
    fieldId: 'item',
    line: 3,
    text: 'value'
});
...
// Add additional code

Parameters

Errors

Syntax

Related Topics