SuiteQLTask.query

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

SuiteQL query definition for the SuiteQL task.

The SuiteQL query definition is a string that represents a SuiteQL query. For more information, see SuiteQL.

Type

string

Supported Script Types

Server scripts

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

Module

N/task Module

Parent Object

task.SuiteQLTask

Sibling Object Members

SuiteQLTask Object Members

Since

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

            // Add additional code
...
var mySuiteQLTask = task.create({
    taskType: task.TaskType.SUITE_QL
});
mySuiteQLTask.query = 'SELECT customer.entityid, customer.email FROM customer';
...
// Add additional code 

          

Related Topics

task.SuiteQLTask
N/task Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices