Navigation: Catalog: Files > Schemas > Schema: Files > Tables

FileSearches

Search filesSearch through files in the file manager. Does not display hidden or archived files.

Catalog: Files

Schema: Files

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 FileSearches. 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	Required	Documentation
after	☐	Offset search results by this value. The default offset is 0 and the maximum offset of items for a given search is 10,000. Narrow your search down if you are reaching this limit.
allowsAnonymousAccess	☐	Search files by access. If 'true' will show only public files; if 'false' will show only private files
before	☐	Search files updated before this timestamp. Time must be epoch time in milliseconds.
createdAt	☐	Search files by exact time of creation. Time must be epoch time in milliseconds.
createdAtGte	☐	Search files by greater than or equal to time of creation. Can be used with createdAtLte to create a range.
createdAtLte	☐	Search files by less than or equal to time of creation. Can be used with createdAtGte to create a range.
encoding	☐	Search files by specified encoding.
expiresAt	☐	Search files by exact expires time. Time must be epoch time in milliseconds.
expiresAtGte	☐	Search files by greater than or equal to expires time. Can be used with expiresAtLte to create a range.
expiresAtLte	☐	Search files by less than or equal to expires time. Can be used with expiresAtGte to create a range.
extension	☐	Search files by given extension.
fileMd5	☐	Search files by specific md5 hash.
height	☐	Search files by height of image or video.
heightGte	☐	Search files by greater than or equal to height of image or video. Can be used with heightLte to create a range.
heightLte	☐	Search files by less than or equal to height of image or video. Can be used with heightGte to create a range.
idGte	☐	Search files by greater than or equal to ID. Can be used with idLte to create a range.
idLte	☐	Search files by less than or equal to ID. Can be used with idGte to create a range.
isUsableInContent	☐	If true shows files that have been marked to be used in new content. It false shows files that should not be used in new content.
name	☐	Search for files containing the given name.
path	☐	Search files by path.
size	☐	Search files by exact file size in bytes.
sizeGte	☐	Search files by greater than or equal to file size. Can be used with sizeLte to create a range.
sizeLte	☐	Search files by less than or equal to file size. Can be used with sizeGte to create a range.
type	☐	Search files by file type.
updatedAt	☐	Search files by exact time of latest updated. Time must be epoch time in milliseconds.
updatedAtGte	☐	Search files by greater than or equal to time of latest update. Can be used with updatedAtLte to create a range.
updatedAtLte	☐	Search files by less than or equal to time of latest update. Can be used with updatedAtGte to create a range.
url	☐	Search for given URL
width	☐	Search files by width of image or video.
widthGte	☐	Search files by greater than or equal to width of image or video. Can be used with widthLte to create a range.
widthLte	☐	Search files by less than or equal to width of image or video. Can be used with widthGte to create a range.

Columns of Table Function

The columns of the table function FileSearches are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
access	varchar2	Access	☐	File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.
archived	char	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	varchar2	Default Hosting URL	☐	Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.
encoding	varchar2	Encoding	☐	Encoding of the file.
expiresAt	int64	Expires at	☐
extension	varchar2	Extension	☐	Extension of the file. ex: .jpg, .png, .gif, .pdf, etc.
fileMd5	varchar2		☐	The MD5 hash of the file.
height	int32	Height	☐	For image and video files, the height of the content.
id	varchar2	ID	☐	File ID.
isUsableInContent	char	Is Usable in Content	☐	Previously "archied". Indicates if the file should be used when creating new content like web pages.
name	varchar2	Name	☐	Name of the file.
parentFolderId	varchar2	Parent Folder ID	☐	ID of the folder the file is in.
path	varchar2	Path	☐	Path of the file in the file manager.
size	int64	Size	☐	Size of the file in bytes.
sourceGroup	varchar2		☐
type	varchar2	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	varchar2	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.

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

FileSearches

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information