QueryTaskStatus.status

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Status of the submitted query task.

A query task can have the following statuses, which are represented by values in the task.TaskStatus enum:

  • task.TaskStatus.COMPLETE

  • task.TaskStatus.FAILED

  • task.TaskStatus.PENDING

  • task.TaskStatus.PROCESSING

Type

string (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 theStatus = myTaskStatus.status;
...
// Add additional code 

          

Related Topics

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

General Notices