Ajouter un filewatcher¶
- POST /api/filewatchers¶
Ajoute un nouveau filewatcher.
- Request Headers:
Authorization – Les identifiants de l’utilisateur REST.
- Request JSON Object:
flow (string) – Le nom du flux auquel le filewatcher appartient.
disabled (bool) – Indique si le filewatcher est désactivé au démarrage.
interval (string) – La fréquence à laquelle le filewatcher interrogera le partenaire distant pour obtenir la liste des fichiers à récupérer.
pattern (string) – Le pattern de fichier à matcher (format `glob<https://en.wikipedia.org/wiki/Glob_(programming)>`_.
noDuplicateCheck (bool) – Indique si la détection de doublons est désactivée. Par défaut, le filewatcher ignore les fichiers qui ont déjà été récupérés lors d’un précédent passage. Mettre à true désactive cette vérification.
partner (string) – Le partenaire interrogé par le filewatcher.
account (string) – Le compte utilisé pour l’authentification.
client (string) – Le client utilisé pour la requête.
rule (string) – La règle à utiliser pour les transferts.
- Status Codes:
201 Created – Le filewatcher a été créé avec succès
400 Bad Request – Requête invalide
401 Unauthorized – Authentification REST invalide
403 Forbidden – L’utilisateur REST n’a pas le droit d’effectuer cette action
- Response Headers:
Location – Le chemin d’accès au nouveau filewatcher créé
Exemple de requête
POST https://my_waarp_gateway.net/api/filewatchers HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Content-Length: 195 { "flow": "my-filewatcher", "disabled": false, "interval": "5m", "pattern": "*.txt", "noDuplicateCheck": false, "partner": "my-partner", "account": "my-account", "client": "my-client", "rule": "my-rule" }
Exemple de réponse
HTTP/1.1 201 CREATED Location: https://my_waarp_gateway.net/api/filewatchers/my-filewatcher