Record.insertLine(options)

Method Description

Inserts a sublist line.

When you insert a line with this method, all succeeding lines are moved and the total line count is increased. Essentially, succeeding lines are committed to a new sublist line with a new line number.

(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.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.line`	number	required	The line number to insert. Note that line indexing begins at 0 with SuiteScript 2.x.	2015.2
`options.ignoreRecalc`	boolean	optional	If set to true, scripting recalculation is ignored. The default value is false.	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.line

number

required

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

2015.2

options.ignoreRecalc

boolean

optional

If set to true, scripting recalculation is ignored.

The default value is false.

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

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 that uses insertLine(), see Creating a Landed Cost Sublist Subrecord Example.

          // Add additional code
...
objRecord.insertLine({
    sublistId: 'attendee',
    line: 2,
   });
objRecord.setCurrentSublistValue({
    sublistId: 'attendee',
    fieldId: 'attendee',
    value: 838
   });
objRecord.commitLine({
    sublistId: 'attendee'
   });
...
// Add additional code

Parameters

Errors

Syntax

Related Topics