HubSpot API Data Model
FileById |
Get file.Get file by ID.
Catalog: Files3
Schema: Files
Label: {res:itgen_hubspot_filebyid_plural}
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 FileById. 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 |
|---|---|---|---|---|
fileId |
string |
☑ |
|
ID of the desired file. |
Columns of Table Function
The columns of the table function FileById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
access |
string |
Access |
☐ |
File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE. |
archived |
boolean |
Archived |
☐ |
If the file is deleted. |
archivedAt |
datetime |
Archived at |
☐ |
Deletion time of the file object. |
createdAt |
datetime |
Created at |
☐ |
Creation time of the file object. |
defaultHostingUrl |
string |
Default Hosting URL |
☐ |
Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file. |
encoding |
string |
Encoding |
☐ |
Encoding of the file. |
expiresAt |
int64 |
Expires at |
☐ |
|
extension |
string |
Extension |
☐ |
Extension of the file. ex: .jpg, .png, .gif, .pdf, etc. |
height |
int32 |
Height |
☐ |
For image and video files, the height of the content. |
id |
string |
ID |
☐ |
File ID. |
isUsableInContent |
boolean |
Is Usable in Content |
☐ |
Previously "archied". Indicates if the file should be used when creating new content like web pages. |
name |
string |
Name |
☐ |
Name of the file. |
parentFolderId |
string |
Parent Folder ID |
☐ |
ID of the folder the file is in. |
path |
string |
Path |
☐ |
Path of the file in the file manager. |
size |
int64 |
Size |
☐ |
Size of the file in bytes. |
type |
string |
Type |
☐ |
Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER. |
updatedAt |
datetime |
Updated at |
☐ |
Timestamp of the latest update to the file. |
url |
string |
URL |
☐ |
URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain. |
width |
int32 |
Width |
☐ |
For image and video files, the width of the content. |
18-12-2024 20:09 Version 24.1.33-BETA+5180
