Record.getCurrentSublistField(options)
Method Description |
Returns metadata about a sublist field. (dynamic mode only— see SuiteScript 2.x Standard and Dynamic Modes) This is not a valid method for use in the fieldChanged(scriptContext) or postSourcing(scriptContext) entry points of a client script. |
Returns |
|
Supported Script Types |
Client and server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Object Members |
|
Since |
2016.2 |
Parameters
The options parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
Since |
---|---|---|---|---|
|
string |
required |
The internal ID of a standard or custom sublist field. |
2015.2 |
|
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 |
Errors
Error Code |
Thrown If |
---|---|
|
A required argument is missing or undefined. |
Syntax
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 sublistFieldMetadata = objRecord.getCurrentSublistField({
sublistId: 'item',
fieldId: 'item',
});
...
// Add additional code