1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/record Module
  6. record.load.promise(options)

record.load.promise(options)

Method Description

Loads an existing record asynchronously.

Note:

The parameters and errors thrown for this method are the same as those for record.load(options). For more information about promises, see Promise Object.

Returns

Promise Object

Synchronous Version

record.load(options)

Supported Script Types

Client scripts

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

Governance

Transaction records: 10 units

Custom records: 2 units

All other records: 5 units

Module

N/record Module

Since

2015.2
Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.type

string

required

The record type.

Use the following guidelines:

  • When loading an instance of a standard NetSuite record type, set this value by using the record.Type enum.

  • When loading an instance of a custom record type, set this value by using the custom record type’s string ID. For help finding this ID, see Custom Record.

2015.2

options.id

number

required

The internal ID of the existing record instance in NetSuite. The internal ID of the record is displayed on the list page for the record type.

 

options.isDynamic

boolean

optional

Determines whether the record is loaded in dynamic mode.

  • If set to true, the record is loaded in dynamic mode.

  • If set to false, the record is loaded in standard mode.

By default, this value is false.

Note:

For additional information about standard and dynamic mode, see record.Record and SuiteScript 2.x Standard and Dynamic Modes.

2015.2

options.defaultValues

Object

optional

Name-value pairs containing default values of fields in the new record.

By default, this value is empty.

 
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 promise script example, see Promise Object.

          function loadRecord() {
    // Load an instance of a standard NetSuite record type
    var loadRecordPromise = record.load.promise({
        type: record.Type.PHONE_CALL,
        id: 712
    });

    // Note: To load an instance of a custom record type,
    // use the record type's string ID. For example: type: 'customrecord_feature' 

    loadRecordPromise.then(function(objRecord) {
        objRecord.setValue({
            fieldId: 'message',
            value: 'We will start the call with a restrospective.'
        });         
        var recordId = objRecord.save();
               
        // Add any other needed logic that shouldn't execute
        // until after the record is instantiated.
               
        log.debug({
            title: 'Record updated', 
            details: 'Updated record ID: ' + recordId
     });
                 
    }, function(e) {
        log.error({
            title: 'Unable to load record', 
            details: e.name
        });
    });
}
... 
// Add additional code

Related Topics

General Notices