action.find(options)

Method Description

Performs a search for available record actions. If only the recordType parameter is specified, all actions available for the record type are returned. If the recordId parameter is also specified, then only actions that qualify for execution on the given record instance are returned. If the id parameter is specified, then only the action with the specified action ID is returned.

This method returns a plain JavaScript object of NetSuite record actions available for the record type. The object contains one or more action.Action objects. If there are no available actions for the specified record type, an empty object is returned.

If the recordId is specified in this call, the actions that are found are considered qualified. You do not have to provide the recordId to execute a qualified action.

Returns

Object

Supported Script Types

Client and server scripts

For more 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	optional	The action ID.

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

optional

The action ID.

Errors

Error Code	Thrown If
`RECORD_DOES_NOT_EXIST`	The specified record ID 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`	The `options.recordType` parameter is missing or undefined.

Error Code

Thrown If

RECORD_DOES_NOT_EXIST

The specified record ID 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

The options.recordType parameter is missing or undefined.

Syntax

Important:

The following code snippet shows the syntax for this member. It is not a functional example. For a complete script example, see N/action Module Script Samples.

          // Add additional code
...
var actions = action.find({
    recordType: 'timebill',
    recordId: recordId
});
...
// Add additional code

Parameters

Errors

Syntax

Related Topics