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.getSubrecord(options)

Record.getSubrecord(options)

Method Description

Gets the subrecord for the associated field.

This method is not available for subrecords.

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

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.fieldId

string

required

The internal ID of a standard or custom body field.

See, Finding Internal IDs of Record Fields.

2015.2
Errors

Error Code

Thrown If

FIELD_1_IS_DISABLED_YOU_CANNOT_APPLY_SUBRECORD_OPERATION_ON_THIS_FIELD

The specified field is disabled.

FIELD_1_IS_NOT_A_SUBRECORD_FIELD

The specified field is not a subrecord field.

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 sublistFieldValue = objRecord.getSubrecord({
    fieldId: 'idnumber'
});
...
// Add additional code

Related Topics

General Notices