invantive documentation
Invantive SupportforenAnmelden / Eintragen

BackgroundApiOperationsByRequestId: Visma.net Financials Hintergrund-API-Vorgänge nach Anfrage-ID

read only REST

  • Katalog: VismaNet
  • Schema: Background
  • Bezeichnung: Hintergrund-API-Vorgänge nach Anfrage-ID

Ruft den Status eines zuvor gestarteten Hintergrund-API-Vorgangs ab

Es können nur Daten abgerufen werden.

API-Quelle

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

Leistungsmerkmale

Characteristic Value
Durchschnittliche Zugriffsverzögerung (ms) 155
Anzahl der Vollscan-Zeilen pro Minute 29,100
Anzahl der Query-Zeilen pro Minute 387

Das Ergebnis kann auf dem Client im Cache zwischengespeichert werden.

Parameter

Name Datentyp Required Default Documentation
requestId ``

Tabellenspalten

Die Spalten der Tabelle BackgroundApiOperationsByRequestId sind unten aufgeführt. Jede Spalte hat einen SQL-Datentyp. Beim Einfügen und Aktualisieren muss für jede erforderliche Spalte jederzeit ein neuer Wert angegeben werden der nicht Null ist.

Name Datentyp Label Required Marks Documentation
COMPANY_CODE varchar2(30) Firmencode writable Partitionscode, der die Daten segmentiert.
COMPANY_NAME varchar2(240) Firmenname writable Name der Partition.
contentLocation varchar2 Speicherort des Inhalts Filter auf der Plattform, beschreibbar, contentLocation Die URI, über die der Client die Antwort des Hintergrund-API-Vorgangs abrufen kann, sofern verfügbar.
errorMessage varchar2 Fehlermeldung Filter auf der Plattform, beschreibbar, errorMessage Etwaige Fehlermeldung bei der Verarbeitung der Anfrage des Hintergrund-API-Vorgangs.Beachten Sie, dass eine Fehlerantwort des eigentlichen Endpunkts über den Aufruf der ContentLocation-Adresse aus der Webhook-Benachrichtigungsantwort oder dem Hintergrundstatusdokument abgerufen werden kann.
finishedUtc datetime Beendet (UTC) Filter auf der Plattform, beschreibbar, finishedUtc Zeitpunkt, zu dem die Verarbeitung des Hintergrund-API-Vorgangs abgeschlossen wurde
hasRequestContent char Enthält den Inhalt der Anfrage Filter auf der Plattform, beschreibbar, hasRequestContent Gibt an, ob die Anfrage des Hintergrund-API-Vorgangs einen Anfrageinhalt hat.
hasResponseContent char Enthält Antwortinhalt Filter auf der Plattform, beschreibbar, hasResponseContent Gibt an, ob der Hintergrund-API-Vorgang mit einem Antwortinhalt beendet wurde.Der Wert wird nur aktualisiert, wenn der Hintergrund-API-Vorgang abgeschlossen ist.
id guid ID Filter auf der Plattform, beschreibbar, id Identifiziert einen gestarteten Hintergrund-API-Vorgang
originalUri varchar2 itgen_vnet_originaluri Filter auf der Plattform, beschreibbar, originalUri Der Endpunkt, dessen Verarbeitung als Hintergrund-API-Vorgang angefordert wurde.
receivedUtc datetime itgen_vnet_receivedutc Filter auf der Plattform, beschreibbar, receivedUtc Zeitpunkt, zu dem der Hintergrund-API-Vorgang angefordert wurde
reference varchar2 itgen_vnet_reference Filter auf der Plattform, beschreibbar, reference
responseHeaders varchar2 itgen_vnet_responseheaders writable Alle Antwortheader des abgeschlossenen Hintergrund-API-Vorgangs.Der JSON-Text des verschachtelten Objekts.
startedUtc datetime itgen_vnet_startedutc Filter auf der Plattform, beschreibbar, startedUtc Zeitpunkt, zu dem die Verarbeitung des Hintergrund-API-Vorgangs begonnen wurde
status varchar2 Status Filter auf der Plattform, beschreibbar, status Aktueller Status eines Hintergrund-API-Vorgangs.Mögliche Werte sind 'Started', 'Finished' und 'Failed'.
statusCode int32 itgen_vnet_statuscode Filter auf der Plattform, beschreibbar, statusCode Der HTTP-Statuscode des abgeschlossenen Hintergrund-API-Vorgangs.Der Wert ist 0, solange der Vorgang nicht abgeschlossen ist.
webhookAddress varchar2 itgen_vnet_webhookaddress Filter auf der Plattform, beschreibbar, webhookAddress Die Webhook-URI, die zur Benachrichtigung verwendet wird, wenn der Hintergrund-API-Vorgang abgeschlossen ist, oder 'none', wenn keine Benachrichtigung konfiguriert ist

Anmerkungen zu dieser Version

Was hat sich in den Tabellen, Spalten, Attributen und Funktionen des Treibers mit jeder neuen Version geändert: