invantive documentation
Invantive Support ForumsAanmelden / Inschrijven

BackgroundApiOperationsByRequestId: Visma.net Financials Achtergrond-API-bewerkingen op aanvraag-ID

read only REST

  • Catalogus: VismaNet
  • Schema: Background
  • Label: Achtergrond-API-bewerkingen op aanvraag-ID

Haalt de status op van een eerder gestarte achtergrond-API-bewerking

Kan alleen gegevens ophalen.

API-bron

  • Eindpunt: /v1/background/{requestId}
  • Operatie: get /v1/background/{requestId}

Prestatiekenmerken

Characteristic Value
Gemiddelde toegangsvertraging (ms) 155
Aantal rijen per minuut bij volledige scan 29,100
Aantal rijen per minuut in een Query 387

Het resultaat kan op de client in de Cache worden opgeslagen.

Parameters

Name Datatype Required Default Documentation
requestId ``

Tabelkolommen

De kolommen van de tabel BackgroundApiOperationsByRequestId worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype. Voor elke vereiste kolom moet bij het invoegen en bijwerken steeds een nieuwe, niet-lege waarde worden opgegeven.

Name Datatype Label Required Marks Documentation
COMPANY_CODE varchar2(30) Bedrijfscode writable Partitiecode, die de gegevens segmenteert.
COMPANY_NAME varchar2(240) Naam bedrijf writable Naam van de partitie.
contentLocation varchar2 Inhoudslocatie filters op het platform, beschrijfbaar, contentLocation De uri waarvandaan de client de respons van de achtergrond-API-bewerking kan ophalen, indien beschikbaar.
errorMessage varchar2 Foutmelding filters op het platform, beschrijfbaar, errorMessage Eventuele foutmelding tijdens de verwerking van het verzoek voor de achtergrond-API-bewerking.Let op: een eventuele foutrespons van het eigenlijke eindpunt kan worden opgevraagd door het ContentLocation-adres aan te roepen uit de webhook-meldingsrespons of het achtergrondstatusdocument.
finishedUtc datetime Voltooid (UTC) filters op het platform, beschrijfbaar, finishedUtc Tijdstip waarop de verwerking van de achtergrond-API-bewerking is voltooid
hasRequestContent char Heeft Verzoek Inhoud filters op het platform, beschrijfbaar, hasRequestContent Geeft aan of het verzoek voor de achtergrond-API-bewerking al dan niet een verzoekinhoud heeft.
hasResponseContent char Heeft Reactie-inhoud filters op het platform, beschrijfbaar, hasResponseContent Geeft aan of de achtergrond-API-bewerking al dan niet is afgesloten met een responsinhoud.De waarde wordt alleen bijgewerkt wanneer de achtergrond-API-bewerking is voltooid.
id guid ID filters op het platform, beschrijfbaar, id Identificeert een gestarte achtergrond-API-bewerking
originalUri varchar2 itgen_vnet_originaluri filters op het platform, beschrijfbaar, originalUri Het eindpunt waarvan verwerking als achtergrond-API-bewerking is aangevraagd.
receivedUtc datetime itgen_vnet_receivedutc filters op het platform, beschrijfbaar, receivedUtc Tijdstip waarop de achtergrond-API-bewerking is aangevraagd
reference varchar2 itgen_vnet_reference filters op het platform, beschrijfbaar, reference
responseHeaders varchar2 itgen_vnet_responseheaders writable Eventuele responseheaders van de voltooide achtergrond-API-bewerking.De JSON-tekst van het geneste object.
startedUtc datetime itgen_vnet_startedutc filters op het platform, beschrijfbaar, startedUtc Tijdstip waarop de verwerking van de achtergrond-API-bewerking is gestart
status varchar2 Status filters op het platform, beschrijfbaar, status Huidige status van een achtergrond-API-bewerking.Mogelijke waarden zijn 'Started', 'Finished' en 'Failed'.
statusCode int32 itgen_vnet_statuscode filters op het platform, beschrijfbaar, statusCode De HTTP-statuscode van de voltooide achtergrond-API-bewerking.De waarde is 0 wanneer de bewerking nog niet is voltooid.
webhookAddress varchar2 itgen_vnet_webhookaddress filters op het platform, beschrijfbaar, webhookAddress De webhook-uri die wordt gebruikt om een melding te sturen wanneer de achtergrond-API-bewerking is voltooid, of 'none' als geen melding is geconfigureerd

Release Notes

Wat is er per release veranderd in de tabellen, kolommen, attributen en mogelijkheden van de driver: