ExportAsyncTaskByTaskId |
Get the status of the export including the URL to download the fileReturns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE
Catalog: Exports
Schema: Advanced
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ExportAsyncTaskByTaskId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
taskId |
|
☑ |
|
|
Columns of Table Function
The columns of the table function ExportAsyncTaskByTaskId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
completedAt |
datetime |
Completed at |
☐ |
The timestamp when the export was completed, in ISO 8601 format. |
links |
varchar2 |
Links |
☐ |
A collection of related links associated with the export. |
numErrors |
int32 |
Number of Errors |
☐ |
The number of errors encountered during the export process. |
requestedAt |
datetime |
Requested at |
☐ |
The timestamp when the export request was made, in ISO 8601 format. |
result |
varchar2 |
|
☐ |
The URL of the resulting file if the export status is COMPLETE. |
startedAt |
datetime |
Started at |
☐ |
The timestamp when the export process started, in ISO 8601 format. |
status |
varchar2 |
Status |
☐ |
The current status of the export, which can be PENDING, PROCESSING, COMPLETE or CANCELED. |