SuiteQLTaskStatus.params

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description	Parameters for the SuiteQL query. The specified parameters are substituted into the SuiteQL query string (represented by SuiteQLTask.query) when you submit the SuiteQL task using SuiteQLTask.submit(). This property references the same set of parameters that are specified by the SuiteQLTask.params property in the corresponding task.SuiteQLTask object.
Type	Array<string | boolean | number> (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.

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 theParams = myTaskStatus.params;
...
// Add additional code 

          

Related Topics

task.SuiteQLTaskStatus

N/task Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices