Record.getSublistSubrecord(options)

Method Description

Gets the subrecord associated with a sublist field. (standard mode only — see SuiteScript 2.x Standard and Dynamic Modes)

When working in dynamic mode, get a sublist subrecord using the following methods:

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 column indexing begins at 0 with SuiteScript 2.x.	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 column indexing begins at 0 with SuiteScript 2.x.

2015.2

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

Parameters

Syntax

Related Topics