Consulter une entrée de l’historique¶
-
GET
/api/history/
(int: history_id)¶ Renvoie les informations du transfert portant l’identifiant
history_id
.Request Headers: - Authorization – Les identifiants de l’utilisateur
Status Codes: - 200 OK – Les informations du transfert ont été renvoyées avec succès
- 401 Unauthorized – Authentification d’utilisateur invalide
- 404 Not Found – Le transfert demandé n’existe pas
Response JSON Object: - id (number) – L’identifiant unique du transfert
- isServer (bool) – Précise si la gateway était à l’origine du transfert
- isSend (bool) – Précise si le transfert était entrant ou sortant
- account (string) – Le nom du compte ayant demandé le transfert
- remote (string) – Le nom du partenaire avec lequel le transfert a été effectué
- protocol (string) – Le protocole utilisé pour le transfert
- sourceFilename (string) – Le nom du fichier avant le transfert
- destFilename (string) – Le nom du fichier après le transfert
- rule (string) – Le nom de la règle de transfert
- start (date) – La date de début du transfert
- stop (date) – La date de fin du transfert
- status (string) – Le statut final du transfert (
CANCELLED
,DONE
ouERROR
) - step (string) – La dernière étape du transfert (
NONE
,PRE TASKS
,DATA
,POST TASKS
,ERROR TASKS
ouFINALIZATION
) - progress (number) – La progression (en octets) du transfert de données
- taskNumber (number) – Le numéro du dernier traitement exécuté
- errorCode (string) – Le code d’erreur du transfert (si une erreur s’est produite)
- errorMsg (string) – Le message d’erreur du transfert (si une erreur s’est produite)
Exemple de requête
GET https://my_waarp_gateway.net/api/history/1 HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Exemple de réponse
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 176 { "id": 1, "isServer": true, "isSend": false, "rule": "règle_sftp", "account": "compte_sftp", "remote": "serveur_sftp", "protocol": "sftp", "sourceFilename": "source/du/fichier", "destFilename": "destination/du/fichier", "start": "2019-01-01T01:00:00+02:00", "stop": "2019-01-01T02:00:00+02:00", "status": "DONE", }