task.checkStatus(options)
Method Description |
Returns a task status object associated with a specific task ID. You can check the status of the following task types:
|
Returns |
task.CsvImportTaskStatus | task.EntityDeduplicationTaskStatus | task.MapReduceScriptTaskStatus | task.QueryTaskStatus | task.RecordActionTaskStatus | task.ScheduledScriptTaskStatus | task.SearchTaskStatus | task.SuiteQLTaskStatus | task.WorkflowTriggerTaskStatus |
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Since |
2015.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
string |
required |
Unique ID of the task to check the status of. |
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 myTask = task.create({
taskType: task.TaskType.QUERY
});
// Submit the task
var myTaskId = myTask.submit();
// Check the status
var myTaskStatus = task.checkStatus({
taskId: myTaskId
});
...
// Add additional code