Ajouter un transfert

POST /v2/transfers

Initialise un nouveau transfert sur le serveur avec les attributs définis dans le corps de la requête. Les informations sur le transfert créé sont renvoyées dans la réponse ainsi que l’URI pour le consuter.

Example request:

POST /v2/transfers HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "ruleName": "default",
    "filename": "example_file.txt",
    "requested": "server2",
    "blockSize": 65536,
    "fileInfo": "This is comment example.",
    "start": "1970-01-01T01:00:00+00:00"
}
Status Codes
  • 201 Created

    Le nouveau transfert a été créé avec succès.

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/json
    
    {
        "id": 1,
        "globalStep": "NOTASK",
        "globalLastStep": "NOTASK",
        "step": 0,
        "rank": 0,
        "status": "TOSUBMIT",
        "stepStatus": "",
        "originalFilename": "out/file_example.txt",
        "filename": "in/file_example.txt",
        "ruleName": "default",
        "blockSize": 65536,
        "fileInfo": "{\"ORIGINALSIZE\":1024}",
        "transferInfo": "This is comment example.",
        "start": "1970-01-01T01:00:00+00:00",
        "stop": "1970-01-01T02:00:00+00:00",
        "requester": "server1",
        "requested": "server2"
    }
    

  • 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
            }
        ]
    }
    

Response Headers
  • transferURI – L’URI d’accès pour consulter le transfert.