SuiteQLTaskStatus.taskId

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

ID of the submitted SuiteQL task.

This property references the same task ID that is returned by SuiteQLTask.submit() when you submit the task for asynchronous 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.SuiteQLTaskStatus

Sibling Object Members

SuiteQLTaskStatus 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.SuiteQLTaskStatus object is created.

Error Code

Thrown If

READ_ONLY_PROPERTY

You try to set the value of this property after the task.SuiteQLTaskStatus 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
...
// mySuiteQLTask is an existing task.SuiteQLTask object
var myTaskId = mySuiteQLTask.submit();
var myTaskStatus = task.checkStatus({
    taskId: myTaskId
});
var theTaskId = myTaskStatus.taskId;
...
// Add additional code

Errors

Syntax

Related Topics