Filter.join

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Join ID for the search filter as a string.

Type

string (read-only)

Supported Script Types

Client and server scripts

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

Module

N/search Module

Since

2015.2

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/search Module Script Samples.

          // Add additional code 
...
// Create a filter joined to another record type. When you create a joined filter:
// - The name property is the field ID of the field in the joined record that you are filtering on
// - The join property is the field ID of the field in the current record that contains the record
//   type you want to join to
// - The operator property is the operator to use to filter the results
// - The values property contains the values to use to filter the results
search.createFilter({
    name: 'joined_record_field_id'
    join: 'current_record_field_id',
    operator: search.Operator.IS,
    values: ['valueToFilter']
});
...
// Add additional code

Syntax

Related Topics