QueryTaskStatus.fileId

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Internal ID of the CSV file that query results are exported to.

This property references the same CSV file that is specified by the QueryTask.fileId property or QueryTask.filePath property in the corresponding task.QueryTask object.

Type

number (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 theFileId = myTaskStatus.fileId;
...
// Add additional code 

          

Related Topics

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

General Notices