Consulter une entrée de l’historique

GET /api/history/(int: history_id)

Obsolète depuis la version 0.5.0: Les propriétés sourceFilename et destFilename de la réponse ont été remplacées par les propriétés localFilepath et remoteFilepath.

Renvoie les informations du transfert portant l’identifiant history_id.

En-têtes de requête:

• 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

Objet JSON de réponse:

• id (number) – L’identifiant local du transfert

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

• isServer (bool) – Indique si Waarp 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) – Déprécié. Le nom du fichier avant le transfert

• destFilename (string) – Déprécié. Le nom du fichier après le transfert

• 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, 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 pour consulter une entrée de l’historique

GET https://my_waarp_gateway.net/api/history/1 HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse pour la consultation d’une entrée d’historique

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

{
  "id": 1,
  "isServer": true,
  "isSend": false,
  "rule": "règle_sftp",
  "account": "compte_sftp",
  "remote": "serveur_sftp",
  "protocol": "sftp",
  "localFilepath": "/chemin/local/fichier1",
  "remoteFilepath": "/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 }
}