invantive documentation
Foros de Soporte de InvantiveIniciar Sesión / Registrarse

BackgroundApiOperationsByRequestId: Visma.net Financials Operaciones de API en segundo plano por ID de solicitud

read only REST

  • Catálogo: VismaNet
  • Esquema: Background
  • Etiqueta: Operaciones de API en segundo plano por ID de solicitud

Obtiene el estado de una operación de API en segundo plano iniciada previamente

Solo puede recuperar datos.

Fuente de la API

  • Punto final: /v1/background/{requestId}
  • Operación: get /v1/background/{requestId}

Características de rendimiento

Characteristic Value
Latencia media de acceso (ms) 155
Número de filas escaneadas por minuto 29,100
Número de filas de queries puntuales por minuto 387

El resultado se puede almacenar en la Caché del cliente.

Parámetros

Name Tipo de Datos Required Default Documentation
requestId ``

Columnas de la Tabla

A continuación se muestran las columnas de la tabla BackgroundApiOperationsByRequestId. Cada columna tiene un tipo de datos SQL. Se debe proporcionar un nuevo valor no nulo para cada columna requerida en todo momento durante la inserción y la actualización.

Name Tipo de Datos Label Required Marks Documentation
COMPANY_CODE varchar2(30) Código de empresa writable Código de partición que segmenta los datos.
COMPANY_NAME varchar2(240) Nombre de la Compañía writable Nombre de la partición.
contentLocation varchar2 Ubicación del contenido filtros en la plataforma, modificables, contentLocation El URI desde el que el cliente puede obtener la respuesta de la operación de API en segundo plano, si hay alguna disponible.
errorMessage varchar2 Mensaje de Error filtros en la plataforma, modificables, errorMessage Cualquier mensaje de error durante el procesamiento de la solicitud de operación de API en segundo plano.Tenga en cuenta que cualquier respuesta de error del endpoint real se puede obtener llamando a la dirección ContentLocation desde la respuesta de notificación del webhook o desde el documento de estado en segundo plano.
finishedUtc datetime Finalizado (UTC) filtros en la plataforma, modificables, finishedUtc Momento en que terminó el procesamiento de la operación de API en segundo plano
hasRequestContent char Contiene el contenido de la solicitud filtros en la plataforma, modificables, hasRequestContent Indica si la solicitud de la operación de API en segundo plano tiene contenido de solicitud.
hasResponseContent char Contiene contenido de respuesta filtros en la plataforma, modificables, hasResponseContent Indica si la operación de API en segundo plano terminó con un contenido de respuesta o no.El valor solo se actualiza cuando la operación de API en segundo plano finaliza.
id guid ID filtros en la plataforma, modificables, id Identifica una operación de API en segundo plano iniciada
originalUri varchar2 itgen_vnet_originaluri filtros en la plataforma, modificables, originalUri El endpoint que se solicitó procesar como operación de API en segundo plano.
receivedUtc datetime itgen_vnet_receivedutc filtros en la plataforma, modificables, receivedUtc Momento en que se solicitó la operación de API en segundo plano
reference varchar2 itgen_vnet_reference filtros en la plataforma, modificables, reference
responseHeaders varchar2 itgen_vnet_responseheaders writable Cualquier encabezado de respuesta de la operación de API en segundo plano finalizada.El texto JSON del objeto anidado.
startedUtc datetime itgen_vnet_startedutc filtros en la plataforma, modificables, startedUtc Momento en que se inició el procesamiento de la operación de API en segundo plano
status varchar2 Status filtros en la plataforma, modificables, status Estado actual de una operación de API en segundo plano.Los valores posibles son 'Started', 'Finished' y 'Failed'.
statusCode int32 itgen_vnet_statuscode filtros en la plataforma, modificables, statusCode El código de estado HTTP de la operación de API en segundo plano finalizada.El valor es 0 cuando la operación no ha terminado.
webhookAddress varchar2 itgen_vnet_webhookaddress filtros en la plataforma, modificables, webhookAddress El URI del webhook utilizado para notificar cuando la operación de API en segundo plano finaliza, o 'none' si no hay notificación configurada

Notas de la Versión

Cambios introducidos en cada versión en las tablas, columnas, atributos y capacidades del controlador: