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

Record.removeSublistSubrecord(options)

Method Description

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

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

  1. Record.selectLine(options)

  2. Record.hasCurrentSublistSubrecord(options)

  3. Record.removeCurrentSublistSubrecord(options)

  4. Record.commitLine(options)

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 in the sublist that contains the subrecord to remove. Note that line 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
...
objRecord.removeSublistSubrecord({
    sublistId: 'item',
    fieldid: 'item',
    line: 3
});
...
// Add additional code

Related Topics

General Notices