ServerRequest.getSublistValue(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Returns the value of a sublist line item.

Returns

string

Supported Script Types

Server scripts

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

Governance

None

Module

N/http Module

Parent Object

http.ServerRequest

Sibling Object Members

ServerRequest Object Members

Since

2015.2

Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.group

string

required

The sublist internal ID.

2015.2

options.line

string

required

The sublist line number.

Note:

Sublist index starts at 0.

2015.2

options.name

string

required

The sublist line item ID (name of the field).

2015.2

Errors

Error Code

Message

Thrown If

SSS_MISSING_REQD_ARGUMENT

Missing a required argument: {param name}

The options.group or options.line parameter is not specified.

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

          // Add additional code 
...
serverRequest.getSublistValue({
    group: 'item',
    name: 'amount',
    line: '2'
});
...
// Add additional code 

        

Related Topics

http.ServerRequest
N/http Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices