1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/currentRecord Module
  6. currentRecord.CurrentRecord
  7. CurrentRecord.getSublistField(options)

CurrentRecord.getSublistField(options)

Method Description

Returns a field object from a sublist.

Use Record.getCurrentSublistField(options) if you are working with the current and non-committed line.

This is not a valid method for use in the fieldChanged(scriptContext), pageInit(scriptContext), and postSourcing(scriptContext) entry points of a client script.

Returns

currentRecord.Field

Supported Script Types

Client scripts

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

Governance

None

Module

N/currentRecord Module

Since

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

2016.2

options.fieldId

string

required

The internal ID of a standard or custom sublist field.

See Finding Internal IDs of Record Fields.

2016.2

options.line

number

required

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

2016.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.
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/currentRecord Module Script Samples.

          //Add additional code 
...
var objField = objRecord.getSublistField({
    sublistId: 'item',
    fieldId: 'item',
    line: 3
});
... 
//Add additional code

Related Topics

General Notices