FileSignedUrlByFileId |
Get signed URL to access private file.Generates signed URL that allows temporary access to a private file.
Catalog: BETA
Schema: Files
Label: {res:itgen_hubspot_filesignedurlbyfileid_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 FileSignedUrlByFileId. 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 |
---|---|---|---|---|
expirationSeconds |
int64 |
☐ |
|
How long in seconds the link will provide access to the file. |
fileId |
string |
☑ |
|
ID of file. |
size |
string |
☐ |
|
For image files. This will resize the image to the desired size before sharing. Does not affect the original file, just the file served by this signed URL. (Waarden: thumb, icon, medium, preview) |
upscale |
boolean |
☐ |
|
If size is provided, this will upscale the image to fit the size dimensions. |
Columns of Table Function
The columns of the table function FileSignedUrlByFileId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
expiresAt |
datetime |
Expires at |
☐ |
Timestamp of when the URL will no longer grant access to the file. |
extension |
string |
Extension |
☐ |
Extension of the requested file. |
height |
int32 |
Height |
☐ |
For image and video files. The height of the file. |
name |
string |
Name |
☐ |
Name of the requested file. |
size |
int32 |
Size |
☐ |
Size in bytes of the requested file. |
type |
string |
Type |
☐ |
Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER. |
url |
string |
URL |
☐ |
Signed URL with access to the specified file. Anyone with this URL will be able to access the file until it expires. |
width |
int32 |
Width |
☐ |
For image and video files. The width of the file. |
18-12-2024 20:09 Version 24.1.33-BETA+5180