invantive documentation
Invantive Support ForumsLog In / Sign Up

BackgroundApiOperationsByRequestId: Visma.net Financials Background API Operations by Request ID

read only REST

  • Catalog: VismaNet
  • Schema: Background
  • Label: Background API Operations by Request ID

Gets the state of a previously started background API operation

Can only retrieve data.

API Source

  • Endpoint: /v1/background/{requestId}
  • Operation: get /v1/background/{requestId}

Performance Characteristics

Characteristic Value
Average access latency (ms) 155
Full scan rows per minute 29,100
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
requestId ``

Table Columns

The columns of the table BackgroundApiOperationsByRequestId 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 and update.

Name Data Type Label Required Marks Documentation
COMPANY_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
contentLocation varchar2 Content Location filters on the platform, writable, contentLocation The uri from where the client can get the response from the background API operation, if any is available.
errorMessage varchar2 Error Message filters on the platform, writable, errorMessage 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 Finished (UTC) filters on the platform, writable, finishedUtc Time when background API operation was finished processing
hasRequestContent char Has Request Content filters on the platform, writable, hasRequestContent Indicates whether or not the background API operation request has a request content.
hasResponseContent char Has Response Content filters on the platform, writable, hasResponseContent Indicates whether or not the background API operation ended with a response content. Value is updated only when background API operation is finished.
id guid ID filters on the platform, writable, id Identifies a started background API operation
originalUri varchar2 itgen_vnet_originaluri filters on the platform, writable, originalUri The endpoint that was requested to be processed as a background API operation.
receivedUtc datetime itgen_vnet_receivedutc filters on the platform, writable, receivedUtc Time when background API operation was requested
reference varchar2 itgen_vnet_reference filters on the platform, writable, reference
responseHeaders varchar2 itgen_vnet_responseheaders writable Any response headers from the finished background API operation. The JSON text of the nested object.
startedUtc datetime itgen_vnet_startedutc filters on the platform, writable, startedUtc Time when processing of background API operation was started
status varchar2 Status filters on the platform, writable, status Current status of a background API operation. Possible values are 'Started', 'Finished' and 'Failed'.
statusCode int32 itgen_vnet_statuscode filters on the platform, writable, statusCode The Http Status Code of the finished background API operation. Value is 0 when operation is not done.
webhookAddress varchar2 itgen_vnet_webhookaddress filters on the platform, writable, webhookAddress The webhook uri used to notify when background API operation is finished, or 'none' if no notification is configured

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: