action.get.promise(options)

Method Description	Returns an executable record action for the specified record type asynchronously. If the recordId parameter is specified, the action object is returned only if the specified action can be executed on the specified record instance. Note: The parameters and errors thrown for this method are the same as those for action.get(options). For more information about promises, see Promise Object.
Returns	Promise Object
Synchronous Version	action.get(options)
Supported Script Types	Client scripts For additional information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/action Module
Sibling Object Members	N/action Module Members
Since	2018.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.recordType	string	required	The record type. For a list of record types, see record.Type.
options.recordId	string	optional	The record instance ID.
options.id	string	required	The ID of the action. For a list of action IDs, see Supported Record Actions.

Errors

Error Code	Thrown If
RECORD_DOES_NOT_EXIST	The specified record instance does not exist.
SSS_INVALID_ACTION_ID	The specified action does not exist on the specified record type. – or – The action exists, but cannot be executed on the specified record instance.
SSS_INVALID_RECORD_TYPE	The specified record type is invalid.
SSS_MISSING_REQD_ARGUMENT	A required parameter is missing.

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.

          // Add additional code
...
action.get.promise({
    recordType: 'timebill',
    id: 'approve'
}).then(function(action) {
    // Process the action object
});
...
// Add additional code 

        

Related Topics

N/action Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices