Please enable JavaScript to view this site.

Made in EU
Visma.net Financials Forums

Visma.net Financials API Data Model

Navigation: Schema: Background > Tables

BackgroundBackgroundApiOperationByrequestId

Gets the state of a previously started background API operation

Catalog: VismaNet

Schema: Background

The data in this table is partitioned per value of the COMPANY_CODE column.

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

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function BackgroundBackgroundApiOperationByrequestId. 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

COMPANY_CODE

string

☐

 

Partition to retrieve data from.

requestId

string

☑

 

 

 

Columns of Table Function

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

Name

Data Type

Label

Required

Documentation

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

contentLocation

string

 

☐

The uri from where the client can get the response from the background API operation, if any is available.

errorMessage

string

 

☐

Any error message during processing of background API operation request. Note that any error response from the actual endpoint can be obtained by calling the ContentLocation address from the webhook notifaction response or the background state document.

finishedUtc

datetime

 

☐

Time when background API operation was finished processing

hasRequestContent

boolean

 

☐

Indicates whether or not the background API operation request has a request content.

hasResponseContent

boolean

 

☐

Indicates whether or not the background API operation ended with a response content. Value is updated only when background API operation is finished.

id

string

ID

☐

Identifies a started background API operation

originalUri

string

 

☐

The endpoint that was requested to be processed as a background API operation.

receivedUtc

datetime

 

☐

Time when background API operation was requested

reference

string

 

☐

 

responseHeaders

string

 

☐

Any response headers from the finished background API operation.

startedUtc

datetime

 

☐

Time when processing of background API operation was started

status

string

Status

☐

Current status of a background API operation. Possible values are 'Started', 'Finished' and 'Failed'.

statusCode

int32

 

☐

The Http Status Code of the finished background API operation. Value is 0 when operation is not done.

webhookAddress

string

 

☐

The webhook uri used to notify when background API operation is finished, or 'none' if no notification is configured

 

22-12-2022 21:03 Version 22.1.101-BETA+3681

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