Lister les filewatchers

GET /api/filewatchers

Renvoie une liste des filewatchers connus.

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 ([flow+|flow-]) – Le paramètre selon lequel les filewatchers seront triés (défaut: flow+)

Response JSON Object:

• filewatchers (array) – La liste des filewatchers demandés

Response JSON Array of Objects:

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

• 200 OK – La liste a été renvoyée 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

Exemple de requête

GET https://my_waarp_gateway.net/api/filewatchers?limit=10&sort=flow+ HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "filewatchers": [{
    "flow": "my-filewatcher",
    "disabled": false,
    "interval": "5m",
    "pattern": "*.txt",
    "noDuplicateCheck": false,
    "partner": "my-partner",
    "account": "my-account",
    "client": "my-client",
    "rule": "my-rule"
  }]
}