Programmer un transfert

POST /api/transfers

Programme un nouveau transfert avec les informations renseignées en format JSON dans le corps de la requête.

Request Headers:  

• Authorization – Les identifiants de l’utilisateur

Request JSON Object:  

• isServer (bool) – Précise si la gateway était à l’origine du transfert
• rule (string) – L’identifiant de la règle utilisée
• 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 du fichier source
• destPath (string) – Le chemin de destination du fichier
• start (date) – La date de début du transfert (en format ISO 8601)

Status Codes:

• 202 Accepted – Le transfert a été lancé avec succès
• 400 Bad Request – Un ou plusieurs des paramètres du transfert sont invalides
• 401 Unauthorized – Authentification d’utilisateur invalide

Response Headers:  

• Location – Le chemin d’accès au nouveau transfert créé

Exemple de requête

POST https://my_waarp_gateway.net/api/transfers HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 212

{
  "isServer": false,
  "rule": "règle_1",
  "requester": "toto",
  "requested": "waarp_sftp",
  "sourcePath": "chemin/du/fichier",
  "destPath": "chemin/de/destination",
  "start": "2019-01-01T02:00:00+02:00"
}

Exemple de réponse

HTTP/1.1 202 ACCEPTED
Location: https://my_waarp_gateway.net/api/transfers/123