# Consulter un transfert

GET /api/transfers/(int: transfer_id)

  Obsolète depuis la version 0.4.0: Les propriétés `sourcePath` et `destPath` de la réponse ont été remplacées par les propriétés `localFilepath` et `remoteFilepath`.

  Obsolète depuis la version 0.4.0: La propriété `trueFilepath` de la réponse a été remplacée par la propriété `localFilepath`.

  Obsolète depuis la version 0.5.0: La propriété `startDate` de la réponse a été remplacée par la propriété `start`.

  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 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) – Le nom 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

    - srcFilename (string) – Le nom du fichier source.

    - destFilename (string) – Le nom du fichier destination.

    - 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

    - stop (date) – La date de fin du transfert (si le transfert est terminé)

    - status (string) – Le statut actuel du transfert (valeurs possibles: `PLANNED`, `RUNNING`, `PAUSED`, `INTERRUPTED`, `ERROR`, `DONE` ou `CANCELLED`)

    - step (string) – L’étape actuelle du transfert (valeurs possibles: `StepNone`, `StepSetup`, `StepPreTasks`, `StepData`, `StepPostTasks`, `StepErrorTasks` ou `StepFinalization`)

    - 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)

    - transferInfo (object) – Des informations de transfert personnalisées sous la forme d’une liste de pairs clé:valeur, c’est-à-dire sous forme d’un objet JSON.

    - remainingAttempts (number) – Le nombre de tentatives automatiques restantes. Ce nombre n’inclue donc pas la tentative originale du transfert.

    - nextAttempt (string) – La date de la prochaine tentative du transfert. À noter que ce champ est nul pendant que le transfert est en cours ou si le transfers n’a plus de tentatives restantes.

    - nextRetryDelay (number) – Le délai (en secondes) entre la dernière tentative du transfert et la prochaine.

    - retryIncrementFactor (number) – Le facteur par lequel le délai ci-dessus sera multiplié à chaque nouvelle tentative.

    - trueFilepath (string) – Déprécié. Le chemin local complet du fichier

    - sourcePath (string) – Déprécié. Le fichier source du transfer

    - destPath (string) – Déprécié. Le fichier destination du transfer

    - startDate (date) – Déprécié. La date de début du transfert

  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,
        "remoteID": "123456789"
        "rule": "règle_1",
        "isServer": true,
        "isSend": false,
        "requester": "toto",
        "requested": "waarp_sftp",
        "protocol": "sftp",
        "localFilepath": "/chemin/local/fichier1",
        "remoteFilepath": "/chemin/distant/fichier1",
        "filesize": 1234,
        "start": "2019-01-01T02:00:00+02:00",
        "status": "ERROR",
        "step": "DATA",
        "errorCode": "TeDataTransfer",
        "errorMsg": "error during data transfer",
        "progress": 567,
        "transferInfo": {
          "key1": "val1",
          "key2": 2,
          "key3": true
        },
        "remainingTries": 3,
        "nextAttempt": "2019-01-01T03:00:00+02:00",
        "nextRetryDelay": 3600,
        "retryIncrementFactor": 1.5
      }