CurrentRecord.insertLine(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Inserts a sublist line.

Returns

currentRecord.CurrentRecord

Supported Script Types

Client scripts

For more information, see SuiteScript 2.x Client Script Type.

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

number

required

The line number to insert. Note that line indexing begins at 0 with SuiteScript 2.0.

2016.2

options.ignoreRecalc

boolean

optional

If set to true, scripting recalculation is ignored.

The default value is false.

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 
...
objRecord.insertLine({
    sublistId: 'item',
    line: 3,
    ignoreRecalc: true
});
... 
//Add additional code 

        

Related Topics

currentRecord.CurrentRecord
N/currentRecord Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices