QueryTaskStatus.query

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description	Query definition for the submitted query task. The query definition is a query.Query object. To use this object, you must load the N/query module in your script and create a query using query.create(options) or load a query using query.load(options). For more information, see N/query Module. This property references the same query that is specified by the QueryTask.query property in the corresponding task.QueryTask object.
Type	query.Query (read-only)
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Module	N/task Module
Parent Object	task.QueryTaskStatus
Sibling Object Members	QueryTaskStatus Object Members
Since	2020.2

Errors

Error Code	Thrown If
READ_ONLY_PROPERTY	You try to set the value of this property after the task.QueryTaskStatus object is created.

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
...
// myQueryTask is an existing task.QueryTask object
var myTaskId = myQueryTask.submit();
var myTaskStatus = task.checkStatus({
    taskId: myTaskId
});
var theQuery = myTaskStatus.query;
...
// Add additional code 

          

Related Topics

task.QueryTaskStatus

N/task Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices