BackgroundApiOperationsByRequestId : Visma.net Financials Opérations API en arrière-plan par ID de requête
read only REST
- Catalogue :
VismaNet - Schéma :
Background - Libellé : Opérations API en arrière-plan par ID de requête
Obtient l'état d'une opération API en arrière-plan précédemment lancée
Permet uniquement de récupérer des données.
Source de l'API
- Point de terminaison :
/v1/background/{requestId} - Opération :
get /v1/background/{requestId}
Caractéristiques de performance
| Characteristic | Value |
|---|---|
| Latence moyenne d'accès (ms) | 155 |
| Nombre de lignes par minute en mode de balayage complet | 29,100 |
| Nombre de lignes de requêtes ponctuelles par minute | 387 |
Le résultat peut être mis en cache côté client.
Paramètres
| Name | Type de données | Required | Default | Documentation |
|---|---|---|---|---|
request |
`` |
Colonnes de table
Les colonnes de la table BackgroundApiOperationsByRequestId sont présentées ci-dessous. Chaque colonne possède un type de données SQL. Une nouvelle valeur non nulle doit être fournie pour chaque colonne requise à tout moment lors de l'insertion et de la mise à jour.
| Name | Type de données | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Code d'entreprise | writable | Code de partition, segmentant les données. | |
COMPANY_ |
varchar2 |
Nom de société | writable | Nom de la partition. | |
content |
varchar2 |
Emplacement du contenu | filtres sur la plateforme, modifiables, content |
L'URI à partir de laquelle le client peut obtenir la réponse de l'opération API en arrière-plan, si une réponse est disponible. | |
error |
varchar2 |
Message d'Erreur | filtres sur la plateforme, modifiables, error |
Tout message d'erreur survenu pendant le traitement de la requête d'opération API en arrière-plan.Notez que toute réponse d'erreur du point de terminaison réel peut être obtenue en appelant l'adresse ContentLocation depuis la réponse de notification webhook ou le document d'état en arrière-plan. | |
finished |
datetime |
Terminé (UTC) | filtres sur la plateforme, modifiables, finished |
Moment où le traitement de l'opération API en arrière-plan a été terminé | |
has |
char |
Contenu de la requête | filtres sur la plateforme, modifiables, has |
Indique si la requête d'opération API en arrière-plan contient ou non un contenu de requête. | |
has |
char |
Contient le contenu de la réponse | filtres sur la plateforme, modifiables, has |
Indique si l'opération API en arrière-plan s'est terminée avec un contenu de réponse ou non.La valeur n'est mise à jour que lorsque l'opération API en arrière-plan est terminée. | |
id |
guid |
ID | filtres sur la plateforme, modifiables, id |
Identifie une opération API en arrière-plan lancée | |
original |
varchar2 |
itgen_vnet_originaluri | filtres sur la plateforme, modifiables, original |
Le point de terminaison dont le traitement en tant qu'opération API en arrière-plan a été demandé. | |
received |
datetime |
itgen_vnet_receivedutc | filtres sur la plateforme, modifiables, received |
Moment où l'opération API en arrière-plan a été demandée | |
reference |
varchar2 |
itgen_vnet_reference | filtres sur la plateforme, modifiables, reference |
||
response |
varchar2 |
itgen_vnet_responseheaders | writable | Tous les en-têtes de réponse de l'opération API en arrière-plan terminée.Le texte JSON de l'objet imbriqué. | |
started |
datetime |
itgen_vnet_startedutc | filtres sur la plateforme, modifiables, started |
Moment où le traitement de l'opération API en arrière-plan a été démarré | |
status |
varchar2 |
Status | filtres sur la plateforme, modifiables, status |
État actuel d'une opération API en arrière-plan.Valeurs possibles : « Started », « Finished » et « Failed ». | |
status |
int32 |
itgen_vnet_statuscode | filtres sur la plateforme, modifiables, status |
Le code d'état HTTP de l'opération API en arrière-plan terminée.La valeur est 0 tant que l'opération n'est pas terminée. | |
webhook |
varchar2 |
itgen_vnet_webhookaddress | filtres sur la plateforme, modifiables, webhook |
L'URI webhook utilisé pour notifier la fin de l'opération API en arrière-plan, ou « none » si aucune notification n'est configurée |
Notes de Version
Quels ont été les changements apportés à chaque version au niveau des tables, des colonnes, des attributs et des fonctionnalités du chauffeur :