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 local du transfert

• remoteID (string) – L’identifiant global du transfert

• isServer (bool) – Indique si la gateway est agit en tant que serveur (true) ou en tant que client (false)

• isSend (bool) – Indique si le transfert est un envoi (true) ou une réception (false)

• 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é

• protocol (string) – Le protocole utilisé pour effectuer le transfert

• trueFilepath (string) – Le chemin local complet du fichier (OBSOLÈTE: remplacé par “localFilepath”)

• sourcePath (string) – Le fichier source du transfer (OBSOLÈTE: remplacé par “localFilepath” & “remoteFilepath”)

• destPath (string) – Le fichier destination du transfer (OBSOLÈTE: remplacé par “localFilepath” & “remoteFilepath”)

• localFilepath (string) – Le chemin du fichier sur le disque local

• remoteFilepath (string) – Le chemin du fichier sur le partenaire distant

• filesize (number) – La taille du fichier (-1 si inconnue)

• start (date) – La date de début du transfert

• status (string) – Le statut actuel du transfert (PLANNED, RUNNING, PAUSED, INTERRUPTED ou ERROR)

• step (string) – L’étape actuelle du transfert (NONE, SETUP, 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",
  "protocol": "sftp",
  "localFilepath": "/chemin/local/fichier1",
  "remoteFilepath": "/chemin/distant/fichier1",
  "start": "2019-01-01T02:00:00+02:00",
  "status": "RUNNING",
  "step": "DATA",
  "progress": 123456,
}