SuiteQLTask.submit()
Method Description |
Submits the SuiteQL task for asynchronous processing. This method returns a unique ID for the SuiteQL task. When the submission is successful, this method adds the script IDs of any dependent tasks (added using SuiteQLTask.addInboundDependency(options)) to the SuiteQLTask.inboundDependencies property. Use the task.SuiteQLTaskStatus object to view the status of a submitted SuiteQL task. The task.checkStatus(options) method returns a task.SuiteQLTaskStatus object when you specify a task ID that represents a SuiteQL task. |
Returns |
string |
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
100 units |
Module |
|
Parent Object |
|
Sibling Object Members |
|
Since |
2020.2 |
Errors
Error Code |
Thrown If |
---|---|
|
A dependent map/reduce script task is already submitted and is not complete. |
|
The status of the script deployment record for the specified dependent map/reduce script task has a value other than “Not Scheduled”. |
|
A dependent scheduled script task is already submitted and is not complete. |
|
The status of the script deployment record for the specified dependent scheduled script task has a value other than “Not Scheduled”. |
|
A script deployment record for the specified dependent script task is not available for one of the following reasons:
|
|
The same dependent task is passed to this method more than one time. |
|
The specified dependent task is not found. |
|
A SuiteQL task with the specified script ID is not found. |
|
The SuiteQL task was already submitted and completed successfully. |
|
The SuiteQL task cannot be submitted due to an unexpected error. |
|
The SuiteQLTask.filePath property specifies a folder and not a file. |
|
A required property is not specified. |
|
The SuiteQLTask.fileId property or SuiteQLTask.filePath property references a file that does not exist. |
|
You do not have permission to access the file specified by the SuiteQLTask.fileId property or SuiteQLTask.filePath. |
Syntax
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
...
var mySuiteQLTask = task.create({
taskType: task.TaskType.SUITE_QL
});
// Submit the task
var myTaskId = mySuiteQLTask.submit();
// Check the task status
var myStatus = task.checkStatus({
taskId: myTaskId
});
...
// Add additional code