invantive documentation
Forum di supporto InvantiveAccedi / Registrati

BackgroundApiOperationsByRequestId: Operazioni API in background Visma.net Financials per ID richiesta

read only REST

  • Catalogo: VismaNet
  • Schema: Background
  • Etichetta: Operazioni API in background per ID richiesta

Ottiene lo stato di un'operazione API in background avviata in precedenza

È possibile solo recuperare i dati.

Codice sorgente dell'API

  • Punto finale: /v1/background/{requestId}
  • Operazione: get /v1/background/{requestId}

Caratteristiche prestazionali

Characteristic Value
Latenza media di accesso (ms) 155
Righe di scansione completa al minuto 29,100
Numero di righe di Query al minuto 387

Il risultato può essere memorizzato nella memoria cache sul client.

Parametri

Name Tipo di dati Required Default Documentation
requestId ``

Colonne della tabella

Di seguito sono riportate le colonne della tabella BackgroundApiOperationsByRequestId. Ogni colonna ha un tipo di dati SQL. Un nuovo valore non nullo deve essere fornito per ogni colonna richiesta in ogni momento durante l'inserimento e l'aggiornamento.

Name Tipo di dati Label Required Marks Documentation
COMPANY_CODE varchar2(30) Codice aziendale writable Codice di partizione, che segmenta i dati.
COMPANY_NAME varchar2(240) Nome dell'impresa writable Nome della partizione.
contentLocation varchar2 Posizione del contenuto filtri sulla piattaforma, modificabili, contentLocation L'URI da cui il client può ottenere la risposta dall'operazione API in background, se disponibile.
errorMessage varchar2 Messaggio di errore filtri sulla piattaforma, modificabili, errorMessage Eventuale messaggio di errore durante l'elaborazione della richiesta di operazione API in background.Si noti che qualsiasi risposta di errore dall'endpoint effettivo può essere ottenuta richiamando l'indirizzo ContentLocation dalla risposta della notifica webhook o dal documento di stato in background.
finishedUtc datetime Terminato (UTC) filtri sulla piattaforma, modificabili, finishedUtc Ora in cui l'operazione API in background è stata completata
hasRequestContent char Contiene il contenuto della richiesta filtri sulla piattaforma, modificabili, hasRequestContent Indica se la richiesta dell'operazione API in background include un contenuto di richiesta.
hasResponseContent char Contiene il contenuto della risposta filtri sulla piattaforma, modificabili, hasResponseContent Indica se l'operazione API in background si è conclusa con un contenuto di risposta.Il valore viene aggiornato solo quando l'operazione API in background è terminata.
id guid ID filtri sulla piattaforma, modificabili, id Identifica un'operazione API in background avviata
originalUri varchar2 itgen_vnet_originaluri filtri sulla piattaforma, modificabili, originalUri L'endpoint richiesto per essere elaborato come operazione API in background.
receivedUtc datetime itgen_vnet_receivedutc filtri sulla piattaforma, modificabili, receivedUtc Ora in cui è stata richiesta l'operazione API in background
reference varchar2 itgen_vnet_reference filtri sulla piattaforma, modificabili, reference
responseHeaders varchar2 itgen_vnet_responseheaders writable Eventuali intestazioni di risposta dell'operazione API in background completata.Il testo JSON dell'oggetto annidato.
startedUtc datetime itgen_vnet_startedutc filtri sulla piattaforma, modificabili, startedUtc Ora in cui è stata avviata l'elaborazione dell'operazione API in background
status varchar2 Status filtri sulla piattaforma, modificabili, status Stato corrente di un'operazione API in background.I valori possibili sono 'Started', 'Finished' e 'Failed'.
statusCode int32 itgen_vnet_statuscode filtri sulla piattaforma, modificabili, statusCode Il codice di stato HTTP dell'operazione API in background completata.Il valore è 0 quando l'operazione non è terminata.
webhookAddress varchar2 itgen_vnet_webhookaddress filtri sulla piattaforma, modificabili, webhookAddress L'URI del webhook utilizzato per notificare quando l'operazione API in background è terminata, oppure 'none' se non è configurata alcuna notifica

Note di rilascio

Cosa è cambiato, versione per versione, nelle tabelle, nelle colonne, negli attributi e nelle funzionalità del driver: