Please enable JavaScript to view this site.

Data Dictionary Data Model Data Dictionary Forums

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

Data Type

Required

Default Value

Documentation

acceptMimeType

string

☐

 

OBSOLETE. Value of Accept HTTP request header.

basicAuthenticationPassword

string

☐

 

Password for basic HTTP authentication.

basicAuthenticationUser

string

☐

 

User for basic HTTP authentication.

binaryPayload

byte[]

☐

 

Binary payload to send along. Overruled by text payload when both present.

cacheKey

string

☐

 

Value to make the memory and/or disk cache location unique for your type of request.

contentType

string

☐

 

Value of Content-Type HTTP request header.

cookies

string

☐

 

Cookie name and values encoded as an URL query.

diskCache

boolean

☐

 

Use HTTP disk cache.

diskCacheMaxAgeSec

int32

☐

 

The maximum age of a HTTP disk cache entry to be valid.

headers

string

☐

 

HTTP request header key/value pairs encoded as an URL query.

ignoreInvalidCertificate

boolean

☐

 

Ignore web certificate errors. Defaults to false.

ignoreWebError

boolean

☐

 

Ignore web errors. Defaults to false.

method

string

☐

GET

Method.

minimumDurationMs

int32

☐

 

Extend the execution of the HTTP download to take at least this many milliseconds.

postSleepMs

int32

☐

 

Post-execution delay in milliseconds.

preSleepMs

int32

☐

 

Pre-execution delay in milliseconds.

textPayload

string

☐

 

Text payload to send along. Overrules binary payload when both present.

timeoutMs

int32

☐

30000

Timeout in milliseconds.

url

string

☑

 

URL to download.

userAgent

string

☐

 

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

string

Cache Control

☐

 

CERTIFICATE_DATE_NOT_AFTER

datetime

Certificate not After

☐

 

CERTIFICATE_DATE_NOT_BEFORE

datetime

Certificate not Before

☐

 

CERTIFICATE_ISSUER

string

Certificate Issuer

☐

 

CERTIFICATE_SERIAL_NUMBER

string

Certificate Serial Number

☐

 

CERTIFICATE_SIGNATURE_ALGORITHM

string

Certificate Signature Algorithm

☐

 

CERTIFICATE_SUBJECT

string

Certificate Subject

☐

 

CONTENT_DISPOSITION

string

Content Disposition

☐

 

CONTENTS_BLOB

byte[]

Binary Contents

☐

 

CONTENTS_CHAR

string

Character Contents

☐

 

DATE_RETRIEVAL_UTC

datetime

Retrieval Date (UTC)

☑

 

DEPTH

int32

Depth

☑

 

ERROR_MESSAGE_CODE

string

Error Code

☐

 

ERROR_MESSAGE_TEXT

string

Error Text

☐

 

ETAG

string

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

string

MIME Type

☐

 

PARENT_URL

string

Parent URL

☐

 

REQUEST_CONTENT_TYPE

string

Request Content Type

☐

 

REQUEST_COOKIES

string

Cookies

☐

 

REQUEST_HEADERS

string

Request Headers

☐

 

REQUEST_ID

string(60)

Request ID

☐

Request ID.

REQUEST_METHOD

string

HTTP Request Method

☑

 

REQUEST_PAYLOAD_BLOB_LENGTH

int64

Request Payload BLOB Length

☐

 

REQUEST_PAYLOAD_BLOB

byte[]

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

string

Connection

☐

 

RESPONSE_HEADER_CONTENT_LANGUAGE

string

Content Language

☐

 

RESPONSE_HEADER_CONTENT_LENGTH

int64

Content Length

☐

 

RESPONSE_HEADER_CONTENT_MD5

string

Content MD5

☐

 

RESPONSE_HEADER_CONTENT_SECURITY_POLICY

string

Content Security Policy

☐

 

RESPONSE_HEADER_DATE

datetime

Date

☐

 

RESPONSE_HEADER_EXPECT_CT

string

Expect CT

☐

 

RESPONSE_HEADER_FEATURE_POLICY

string

Feature Policy

☐

 

RESPONSE_HEADER_KEEP_ALIVE

string

Keep Alive

☐

 

RESPONSE_HEADER_PERMISSIONS_POLICY

string

Permissions Policy

☐

 

RESPONSE_HEADER_REFERRER_POLICY

string

Referrer Policy

☐

 

RESPONSE_HEADER_SERVER

string

Server

☐

 

RESPONSE_HEADER_STRICT_TRANSPORT_SECURITY

string

Strict Transport Security

☐

 

RESPONSE_HEADER_TRANSFER_ENCODING

string

Transfer Encoding

☐

 

RESPONSE_HEADER_VIA

string

Via

☐

 

RESPONSE_HEADER_X_ASPNET_MVC_VERSION

string

ASP.Net MVC Version (extension)

☐

 

RESPONSE_HEADER_X_ASPNET_VERSION

string

ASP.Net Version (extension)

☐

 

RESPONSE_HEADER_X_CACHE

string

Cache (extension)

☐

 

RESPONSE_HEADER_X_CONTENT_TYPE_OPTIONS

string

Content Type Options (extension)

☐

 

RESPONSE_HEADER_X_FRAME_OPTIONS

string

Frame Options (extension)

☐

 

RESPONSE_HEADER_X_POWERED_BY

string

Powered by (extension)

☐

 

RESPONSE_HEADER_X_ROBOTS_TAG

string

Robots Tag (extension)

☐

 

RESPONSE_HEADER_X_XSS_PROTECTION

string

XSS Protection (extension)

☐

 

RETRIEVAL_DURATION_MS

int64

Retrieval Duration (ms)

☑

 

RETRIEVAL_SUCCESSFUL

boolean

Retrieval is Successful

☑

 

RETURNED_URL

string

Returned URL

☐

 

SOURCE

string

Data Source

☑

 

TASK_ID

int32

Task ID

☐

Task ID.

UID

guid

UID

☑

 

URL

string

URL

☑

 

USER_AGENT

string

HTTP User Agent

☐

 

 

18-10-2024 06:49 Version 24.0.345-PROD+4945

X

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.
  
Disclaimer