Lister les transferts

Nouveau dans la version 3.4.0: Ajout du paramètre followId

GET /v2/transfers

Renvoie une liste des transferts monitorés par le serveur respectant les filtres donnés en paramètres de requête, ou simplement le décompte si countOrder=true est passé en paramètre.

Query Parameters

• limit (integer) – Nombre maximal de transferts pouvant être inclus dans la réponse.

• offset (integer) – Indice de la première entrée à inclure dans la réponse.

• order (string) – Ordre dans lequel les réponses seront triées. Valeurs possibles : ascId, descId, ascFile, descFile, ascStart, descStart, ascStop, descStop

• ruleName (string) – Filter les transferts par règle de transfert.

• partner (string) – Filtrer les transferts par partenaire.

• status (string) – Filtrer les transferts par statut. Valeurs possibles : TOSUBMIT, NOTUPDATED, RUNNING, INTERRUPTED, DONE, INERROR, UNKNOWN

• filename (string) – Filtrer les transferts par fichier.

• startTrans (string) – Filtrer les transferts commençant après cette date (format ISO-8601).

• stopTrans (string) – Filtrer les transferts commençant avant cette date (format ISO-8601).

• followId (string) – Identifiant FollowId à rechercher dans les transferts.

• countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.

Example request:

GET /v2/transfers HTTP/1.1
Host: example.com

Status Codes

• 200 OK –

  La requête s’est déroulée avec succès.

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "totalResults": 1,
      "results": [
          {
              "id": 1,
              "globalStep": "NOTASK",
              "globalLastStep": "NOTASK",
              "step": 1,
              "rank": 1,
              "status": "TOSUBMIT",
              "stepStatus": "string",
              "originalFilename": "string",
              "filename": "string",
              "ruleName": "string",
              "blockSize": 1,
              "fileInfo": "string",
              "transferInfo": "string",
              "start": "2021-08-18T12:47:27.252876",
              "stop": "2021-08-18T12:47:27.252876",
              "requester": "string",
              "requested": "string"
          }
      ]
  }
  

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

  Example response:

  HTTP/1.1 400 Bad Request
  Content-Type: application/json
  
  {
      "errors": [
          {
              "message": "Query parameter 'startTrans' : illegal value 'not_a_date'.",
              "errorCode": 4
          },
          {
              "message": "Query parameter 'status' : illegal value 'not_a_status'.",
              "errorCode": 4
          }
      ]
  }