Record.getMatrixSublistValue(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Gets the value for the associated field in the matrix. (standard and dynamic mode — see SuiteScript 2.x Standard and Dynamic Modes)
Returns	number | Date | string | array | boolean
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 that contains the matrix. 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 the matrix field. See, How to Find a Field's Internal ID.	2015.2
options.column	number	required	The column number for the field. Note that column indexing begins at 0 with SuiteScript 2.0.	2015.2
options.line	number	required	The line number for the field. Note that line indexing begins at 0 with SuiteScript 2.0.	2015.2

Errors

Error Code	Thrown If
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/record Module Script Samples.

          // Add additional code
...
var value = objRecord.getMatrixSublistValue({
    sublistId: 'item',
    fieldId: 'item',
    column: 12,
    line: 3
});
...
// Add additional code 

        

Related Topics

record.Record

N/record Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices