Lister les transferts¶

GET /api/transfers¶

Renvoie une liste des transferts remplissant les critères donnés en paramètre de requête.

Request Headers:
	Authorization – Les identifiants de l’utilisateur
Parameters:	limit (int) – Le nombre maximum de résultats souhaités (défaut: 20) offset (int) – Le numéro du premier résultat souhaité (défaut: 0) sort (string) – Le paramètre selon lequel les transferts seront triés. Valeurs possibles : `start+`, `start-`, `id+`, `id-`, `status+`, `status-`. (défaut: start+) remote (int) – Filtre uniquement les transferts avec le partenaire renseigné. Peut être renseigné plusieurs fois pour filtrer plusieurs partenaires. account (int) – Filtre uniquement les transferts avec le compte renseigné. Peut être renseigné plusieurs fois pour filtrer plusieurs comptes. rule (int) – Filtre uniquement les transferts avec la règle renseignée. Peut être renseigné plusieurs fois pour filtrer plusieurs règles. status (string) – Filtre uniquement les transferts ayant le statut renseigné. Valeurs possibles : `PLANNED`, `RUNNING`, `PAUSED`. Peut être renseigné plusieurs fois pour filtrer plusieurs status. start (date) – Filtre uniquement les transferts dont la date est ultérieure à celle renseignée.
Status Codes:	200 OK – La liste a été renvoyée avec succès 400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides 401 Unauthorized – Authentification d’utilisateur invalide
Response JSON Object:
	transfers (array) – La liste des transferts demandés
Response JSON Array of Objects:
	id (number) – L’identifiant unique du transfert isServer (bool) – Précise si la gateway était à 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?limit=10&order=desc&rule=1&start=2019-01-01T01:00:00+02:00 HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 249

{
  "transfers": [{
    "id": 1,
    "isServer": false,
    "rule": "règle_1",
    "requester": "toto",
    "requested": "waarp_sftp",
    "source": "chemin/source/fichier1",
    "destination": "chemin/dest/fichier1",
    "start": "2019-01-01T02:00:00+02:00",
    "status": "RUNNING",
    "step": "DATA",
    "progress": 123456,
  },{
    "id": 2,
    "isServer": true,
    "rule": "règle_2",
    "requester": "tata",
    "requested": "sftp_serveur",
    "source": "chemin/source/fichier2",
    "destination": "chemin/dest/fichier2",
    "start": "2019-01-01T03:00:00+02:00",
    "status": "PLANNED"
  }]
}