Navigation: Catalog: DataDictionary > Schemas > Schema: Invantive > Tables

HTTPDOWNLOAD

Catalog: DataDictionary

Schema: Invantive

This is a read-only table function. The Data Dictionary API may not support changing the data or the Invantive UniversalSQL driver for Data Dictionary does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Data Dictionary API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function HTTPDOWNLOAD. 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	Default Value	Documentation
acceptMimeType	☐		OBSOLETE. Value of Accept HTTP request header.
basicAuthenticationPassword	☐		Password for basic HTTP authentication.
basicAuthenticationUser	☐		User for basic HTTP authentication.
binaryPayload	☐		Binary payload to send along. Overruled by text payload when both present.
cacheKey	☐		Value to make the memory and/or disk cache location unique for your type of request.
contentType	☐		Value of Content-Type HTTP request header.
cookies	☐		Cookie name and values encoded as an URL query.
diskCache	☐		Use HTTP disk cache.
diskCacheMaxAgeSec	☐		The maximum age of a HTTP disk cache entry to be valid.
headers	☐		HTTP request header key/value pairs encoded as an URL query.
ignoreInvalidCertificate	☐		Ignore web certificate errors. Defaults to false.
ignoreWebError	☐		Ignore web errors. Defaults to false.
method	☐	GET	Method.
minimumDurationMs	☐		Extend the execution of the HTTP download to take at least this many milliseconds.
postSleepMs	☐		Post-execution delay in milliseconds.
preSleepMs	☐		Pre-execution delay in milliseconds.
textPayload	☐		Text payload to send along. Overrules binary payload when both present.
timeoutMs	☐	30000	Timeout in milliseconds.
url	☑		URL to download.
userAgent	☐		OBSOLETE. Value of User Agent.

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
BYTES_RETRIEVED	int64	Bytes Retrieved	☑
CACHE_CONTROL	varchar2	Cache Control	☐
CERTIFICATE_DATE_NOT_AFTER	date	Certificate not After	☐
CERTIFICATE_DATE_NOT_BEFORE	date	Certificate not Before	☐
CERTIFICATE_ISSUER	varchar2	Certificate Issuer	☐
CERTIFICATE_SERIAL_NUMBER	varchar2	Certificate Serial Number	☐
CERTIFICATE_SIGNATURE_ALGORITHM	varchar2	Certificate Signature Algorithm	☐
CERTIFICATE_SUBJECT	varchar2	Certificate Subject	☐
CONTENT_DISPOSITION	varchar2	Content Disposition	☐
CONTENTS_BLOB	blob	Binary Contents	☐
CONTENTS_CHAR	clob	Character Contents	☐
DATE_RETRIEVAL_UTC	datetime	Retrieval Date (UTC)	☑
DEPTH	int32	Depth	☑
ERROR_MESSAGE_CODE	varchar2	Error Code	☐
ERROR_MESSAGE_TEXT	varchar2	Error Text	☐
ETAG	varchar2	ETag	☐
EXPIRES	datetime	Expires	☐
HOST_ON_HSTS_PRELOAD_LIST	boolean	Host on HSTS Preload List	☐
HTTP_STATUS_CODE	int32	HTTP Status Code	☐
INCLUDE_INVANTIVE_SOURCE_HEADERS	boolean	Include Invantive Source Headers	☑
LAST_MODIFIED	datetime	Last Modified	☐
MANAGED_THREAD_ID	int32	Managed Thread ID	☐	Managed thread ID.
MAX_AUTOMATIC_REDIRECTIONS	int32	Maximum Number of Automatic Redirections	☑
MIME_TYPE	varchar2	MIME Type	☐
PARENT_URL	varchar2	Parent URL	☐
REQUEST_CONTENT_TYPE	varchar2	Request Content Type	☐
REQUEST_COOKIES	varchar2	Cookies	☐
REQUEST_HEADERS	varchar2	Request Headers	☐
REQUEST_ID	varchar2(60)	Request ID	☐	Request ID.
REQUEST_METHOD	varchar2	HTTP Request Method	☐
REQUEST_PAYLOAD_BLOB_LENGTH	int64	Request Payload BLOB Length	☐
REQUEST_PAYLOAD_BLOB	blob	Request Payload BLOB	☐
REQUEST_TIMEOUT_INITIAL_MS	int64	Request Timeout Initial (ms)	☑
REQUEST_TIMEOUT_MAX_ON_RETRY_MS	int64	Request Timeout Maximum On Retry (ms)	☑
RESPONSE_HEADER_AGE	int32	Age	☐
RESPONSE_HEADER_CONNECTION	varchar2	Connection	☐
RESPONSE_HEADER_CONTENT_LANGUAGE	varchar2	Content Language	☐
RESPONSE_HEADER_CONTENT_LENGTH	int64	Content Length	☐
RESPONSE_HEADER_CONTENT_MD5	varchar2	Content MD5	☐
RESPONSE_HEADER_CONTENT_SECURITY_POLICY	varchar2	Content Security Policy	☐
RESPONSE_HEADER_DATE	date	Date	☐
RESPONSE_HEADER_EXPECT_CT	varchar2	Expect CT	☐
RESPONSE_HEADER_FEATURE_POLICY	varchar2	Feature Policy	☐
RESPONSE_HEADER_KEEP_ALIVE	varchar2	Keep Alive	☐
RESPONSE_HEADER_PERMISSIONS_POLICY	varchar2	Permissions Policy	☐
RESPONSE_HEADER_REFERRER_POLICY	varchar2	Referrer Policy	☐
RESPONSE_HEADER_SERVER	varchar2	Server	☐
RESPONSE_HEADER_STRICT_TRANSPORT_SECURITY	varchar2	Strict Transport Security	☐
RESPONSE_HEADER_TRANSFER_ENCODING	varchar2	Transfer Encoding	☐
RESPONSE_HEADER_VIA	varchar2	Via	☐
RESPONSE_HEADER_X_ASPNET_MVC_VERSION	varchar2	ASP.Net MVC Version (extension)	☐
RESPONSE_HEADER_X_ASPNET_VERSION	varchar2	ASP.Net Version (extension)	☐
RESPONSE_HEADER_X_CACHE	varchar2	Cache (extension)	☐
RESPONSE_HEADER_X_CONTENT_TYPE_OPTIONS	varchar2	Content Type Options (extension)	☐
RESPONSE_HEADER_X_FRAME_OPTIONS	varchar2	Frame Options (extension)	☐
RESPONSE_HEADER_X_POWERED_BY	varchar2	Powered by (extension)	☐
RESPONSE_HEADER_X_ROBOTS_TAG	varchar2	Robots Tag (extension)	☐
RESPONSE_HEADER_X_XSS_PROTECTION	varchar2	XSS Protection (extension)	☐
RETRIEVAL_DURATION_MS	int64	Retrieval Duration (ms)	☑
RETRIEVAL_SUCCESSFUL	boolean	Retrieval is Successful	☑
RETURNED_URL	varchar2	Returned URL	☐
SOURCE	varchar2	Data Source	☐
TASK_ID	int32	Task ID	☐	Task ID.
UID	guid	UID	☑
URL	varchar2	URL	☐
USER_AGENT	varchar2	HTTP User Agent	☐

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.

Data Dictionary Data Model

HTTPDOWNLOAD

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information