1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/record Module
  6. record.Record
  7. Record.getSublistText(options)

Record.getSublistText(options)

Method Description

Returns the value of a sublist field in a text representation.

(standard mode only — see SuiteScript 2.x Standard and Dynamic Modes)

Gets a string value with a "%" for rate and ratehighprecision fields.

Returns

string

Note:

For multiselect fields, returns an array.

Supported Script Types

Client and server scripts.

For more information, see SuiteScript 2.x Script Types.

Limitations exist on how this method can be used in standard (deferredDynamic) mode. For details, refer to the description of the SSS_INVALID_API_USAGE error code in the Errors table.

In dynamic mode, you can use getSublistText() without limitation.

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
Errors

Error Code

Thrown If

SSS_INVALID_API_USAGE

Invoked in certain cases when deferredDynamic mode is being used.

For example, if Record.isDynamic is set to false, this error can be invoked in both of the following situations:

  • If the record object was created by record.copy(), record.create(), or record.transform(), and the script attempts to use getSublistText() without first using setSublistText() for the same field.

  • If the record object was created by record.load(), and the script uses setSublistValue() on a field before using getSublistText() for the same field.

This guidance also affects user event scripts that instantiate records by using the newRecord or oldRecord object provided by the script context. These records always use deferredDynamic mode. For that reason, this error appears in both of the following situations:

  • When a user event script executes on a record that is being newly created, and the script attempts to use getSublistText() without first using setSublistText() for the same field.

  • When a user event script executes on an existing record, and the script uses setSublistValue() on a field before using getSublistText() for the same field.

For more information, see SuiteScript 2.x Standard and Dynamic Modes.

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
...
var sublistFieldName = objRecord.getSublistText({
    sublistId: 'item',
    fieldId: 'item',
    line: 3
});
...
// Add additional code

Related Topics

General Notices