Please enable JavaScript to view this site.

Document Cloud Data Model DocumentCloud Forums

Navigation: Schema: Native > Tables

NATIVEPLATFORMSCALARREQUESTS: DocumentCloud Native Platform Scalar Requests

Direct access to native API.

Catalog: DocumentCloud

Schema: Native

Alias: npt

Label: Native Platform Scalar Requests

Documentation:

The NativePlatformScalarRequests table provides direct access to the native API protocol over an established connection to the DocumentCloud API server. It will contain a new row for every row inserted with a native API request in PAYLOAD_TEXT with the results of unaltered forwarding of the payload to the DocumentCloud API server.

Retrieve: true

Insert: true

Update: false

Delete: false

View Columns

The columns of the view NATIVEPLATFORMSCALARREQUESTS are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name

Data Type

Label

Required

Documentation

BLOB_PREFERRED

boolean

BLOB Preferred

☑

Indicator whether a BLOB result is preferred over text.

BOL_RESPONSE_CACHE_MAX_AGE_SEC

int32

Response Cache Maximum Age (sec)

☐

Maximum age in seconds of Bridge Online response cache entries to be used.

CONTENT_TYPE

string(240)

Content Type

☐

 

DATE_ENDED

datetime

End Date

☑

 

DATE_STARTED

datetime

Start Date

☑

 

DRY_RUN

boolean

Run without Actions

☑

 

DURATION_MS

int32

Duration (ms)

☑

 

ERROR_MESSAGE_CODE

string(30)

Error Message Code

☐

 

ERROR_MESSAGE_TEXT

string(32000)

Error Message Text

☐

 

FAIL_ON_ERROR

boolean

Fail on Error

☑

Whether to raise an exception when processing the native request triggered an error from the provider.

HTTP_DISK_CACHE_MAX_AGE_SEC

int32

HTTP Disk Cache Maximum Age (sec)

☐

Maximum age in seconds of HTTP disk cache entries to be used.

HTTP_DISK_CACHE_SAVE

boolean

Save HTTP Disk Cache

☐

Whether results can be stored in HTTP disk cache.

HTTP_DISK_CACHE_USE

boolean

Use HTTP Disk Cache

☐

Whether results can be fetched from HTTP disk cache.

HTTP_MEMORY_CACHE_MAX_AGE_SEC

int32

HTTP Memory Cache Maximum Age (sec)

☐

Maximum age in seconds of HTTP memory cache entries to be used.

HTTP_MEMORY_CACHE_SAVE

boolean

Save HTTP Memory Cache

☐

Whether results can be stored in HTTP memory cache.

HTTP_MEMORY_CACHE_USE

boolean

Use HTTP Memory Cache

☐

Whether results can be fetched from HTTP memory cache.

HTTP_METHOD

string(30)

HTTP Method

☐

 

HTTP_STATUS_CODE

int16

HTTP Status Code

☐

 

ORIG_SYSTEM_GROUP

string(4000)

Original System Group

☐

 

ORIG_SYSTEM_REFERENCE

string(4000)

Original System Reference

☐

 

PAYLOAD_TEXT

string

Payload

☐

 

RESULT_BLOB

byte[]

Result BLOB

☐

 

RESULT_DATE_TIME_UTC

datetime

 

☐

 

RESULT_NUMBER

decimal

 

☐

 

RESULT_TEXT

string

Result Text

☐

 

SUCCESSFUL

boolean

Succesful

☑

 

TIMEOUT_SEC

int32

Timeout (sec)

☐

Timeout in seconds.

TRANSACTION_ID

int32

Transaction ID

☑

Incrementing ID of the transaction.

URL

string(4000)

URL

☐

 

 

15-06-2022 21:30 Version 22.0.232-PROD+3445

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