Filtrer l’historique

GET /api/history

Renvoie une liste des entrées de l’historique de transfert remplissant les critères donnés en paramètres de requête.

Request Headers:
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 Les valeurs possibles sont : id+, id-, start+, start-, status+, status-, rule+ et rule-. (défaut: start+)

  • source (string) – Filtre uniquement les transferts provenant de l’agent renseigné. Peut être renseigné plusieurs fois pour filtrer plusieurs sources.

  • dest (string) – Filtre uniquement les transferts à destination de l’agent renseigné. Peut être renseigné plusieurs fois pour filtrer plusieurs destinations.

  • rule (string) – Filtre uniquement les transferts avec la règle renseignée. Peut être renseigné plusieurs fois pour filtrer plusieurs règles.

  • protocol ([sftp]) – Filtre uniquement les transferts utilisant le protocole renseigné. Peut être renseigné plusieurs fois pour filtrer plusieurs protocoles.

  • status (string) – Filtre uniquement les transferts ayant le statut renseigné. Valeurs possibles: CANCELLED ou DONE. Peut être renseigné plusieurs fois pour filtrer plusieurs status.

  • start (date) – Filtre uniquement les transferts ayant commencé après la date renseignée. La date doit être renseignée en format ISO 8601 tel qu’il est spécifié dans la RFC 3339.

  • stop (date) – Filtre uniquement les transferts ayant terminé avant la date renseignée. La date doit être renseignée en format ISO 8601 tel qu’il est spécifié dans la RFC 3339.

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:
  • history (array) – La liste des transferts demandés

Response JSON Array of Objects:
  • 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)

  • requester (string) – Le nom du compte ayant demandé le transfert

  • requested (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 (OBSOLÈTE: remplacé par “localFilepath” & “remoteFilepath”)

  • destFilename (string) – Le nom du fichier après le transfert (OBSOLÈTE: remplacé par “localFilepath” & “remoteFilepath”)

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

  • remoteFilepath (string) – Le chemin d’accès au fichier sur le partenaire distant

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

  • 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 ou DONE)

  • step (string) – La dernière étape 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 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)

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


Exemple de requête

GET https://my_waarp_gateway.net/api/history?limit=10&order=desc&rule=regle_sftp&start=2019-01-01T00:00:00+02:00&stop=2019-01-01T04: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: 293

{
  "history": [{
    "id": 1,
    "rule": "règle_sftp",
    "source": "compte_sftp_1",
    "dest": "serveur_sftp_1",
    "protocol": "sftp",
    "localPath": "/chemin/local/fichier1",
    "remotePath": "/chemin/distant/fichier1",
    "start": "2019-01-01T01:00:00+02:00",
    "stop": "2019-01-01T02:00:00+02:00",
    "status": "DONE",
    "transferInfo": { "key1": "val1", "key2": 2, "key3": true }
  },{
    "id": 2,
    "rule": "règle_sftp",
    "source": "compte_sftp_2",
    "dest": "serveur_sftp_1",
    "protocol": "sftp",
    "localPath": "/chemin/local/fichier2",
    "remotePath": "/chemin/distant/fichier2",
    "start": "2019-01-01T02:00:00+02:00",
    "stop": "2019-01-01T03:00:00+02:00",
    "status": "CANCELLED",
    "step": "DATA",
    "progress": 123456
  }]
}