Consulter un transfert¶
-
GET
/api/transfers/
(int: transfer_id)¶ Renvoie les informations du transfert portant l’identifiant
transfer_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 est à l’origine du transfert
- isSend (bool) – Précise le sens de transfert du fichier
- rule (string) – L’identifiant de la règle de transfert
- requester (string) – Le nom du compte ayant demandé le transfert
- requested (string) – Le nom du serveur/partenaire auquel le transfert a été demandé
- sourcePath (string) – Le chemin d’origine du fichier
- destPath (string) – Le chemin de destination du fichier
- start (date) – La date de début du transfert
- status (string) – Le statut actuel du transfert (PLANNED, RUNNING, PAUSED ou INTERRUPTED)
- step (string) – L’étape actuelle du transfert (NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS ou FINALIZATION)
- progress (number) – La progression (en octets) du transfert de données
- taskNumber (number) – Le numéro du traitement en cours d’exécution
- 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/transfers/1 HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Exemple de réponse
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 290 { "id": 1, "isServer": true, "rule": "règle_1", "requester": "toto", "requested": "waarp_sftp", "sourcePath": "chemin/source/fichier1", "destPath": "chemin/dest/fichier1", "start": "2019-01-01T02:00:00+02:00", "status": "RUNNING", "step": "DATA", "progress": 123456, }