task.SuiteQLTaskStatus

Note:

The content in this help topic pertains to SuiteScript 2.0.

Object Description

The status of an asynchronous SuiteQL task (task.SuiteQLTask) in the NetSuite task queue.

You create a task.SuiteQLTaskStatus object using task.checkStatus(options). To check the status of a SuiteQL task, you must provide the task ID of the SuiteQL task. To submit a SuiteQL task and obtain the task ID, use SuiteQLTask.submit().

Supported Script Types

Server scripts

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

Module

N/task Module

Methods and Properties

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

Syntax

Related Topics