Consulter une règle

GET /v2/rules/{id}

Si elle existe, renvoie les informations de la règle demandée sous forme d’un objet JSON.

Example request:

GET /v2/rules/{id} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    La règle remandée a été trouvée.

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "name": "example",
        "hostIds": [
            "server1",
            "server2"
        ],
        "modeTrans": "send",
        "recvPath": "in/",
        "sendPath": "out/",
        "archivePath": "arch/",
        "workPath": "work/",
        "rPreTasks": [
            {
                "type": "ZIP",
                "arguments": "file.txt work/",
                "delay": 1
            }
        ],
        "rPostTask": [
            {
                "type": "MOVERENAME",
                "arguments": "arch/file.bak"
            }
        ],
        "rErrorTasks": [
            {
                "type": "RESCHEDULE",
                "arguments": "-delay 3600000 -case ConnectionImpossible,ServerOverloaded,Shutdown"
            }
        ],
        "sPreTasks": [],
        "sPostTasks": [
            {
                "type": "ZIP",
                "arguments": "file.zip work/",
                "delay": 0
            }
        ],
        "sErrorTasks": [
            {
                "type": "DELETE"
            }
        ]
    }
    

  • 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.