Lister les règles¶

GET /v2/rules¶

Renvoie l’ensemble des règles de transfert conformes aux filtres passés en paramètres de requête. Les règles peuvent être filtrées par mode de transmission. Les paramètres offset et limit permettent de fixer un numéro de départ et un nombre maximal de règles désirées, afin de ne renvoyer qu’un sous-ensemble de la liste demandée. Le paramètre order spécifie dans quel ordre les règles doivent être ordonées.

Query Parameters

limit (integer) – Fixe le nombre maximal de règles pouvant être inclues dans la réponse. Utile lorsque le nombre d’entrées sélectionnées par les filtres est trop important pour tenir dans un seule message.
offset (integer) –
Indice de la première entrée à inclure dans la réponse. Généralement utilisé en combinaison avec le paramètre limit pour restreindre l’ensemble des hôtes à renvoyer.

Attention : Si le offset est plus grand que le nombre total de réponses, aucune entrée ne sera renvoyée.
order (string) – Spécifie l’attribut à utiliser pour trier les éléments de la réponse, ainsi que le sens du tri. Ce paramètre devrait donc être le nom d’un attribut d’hôte préfixé par « asc » ou « desc », correspondant respectivement à l’ordre croissant et décroissant.
modeTrans (string) – Si ce paramètre est défini, la réponse ne contiendra que les règles utilisant ce mode de transfert.

Example request:

GET /v2/rules 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": [
        {
            "name": "string",
            "hostIds": [
                "string"
            ],
            "modeTrans": "send",
            "recvPath": "string",
            "sendPath": "string",
            "archivePath": "string",
            "workPath": "string",
            "rPreTasks": [
                {
                    "type": "LOG",
                    "arguments": "string",
                    "delay": 1
                }
            ],
            "rPostTask": [
                {
                    "type": "LOG",
                    "arguments": "string",
                    "delay": 1
                }
            ],
            "rErrorTasks": [
                {
                    "type": "LOG",
                    "arguments": "string",
                    "delay": 1
                }
            ],
            "sPreTasks": [
                {
                    "type": "LOG",
                    "arguments": "string",
                    "delay": 1
                }
            ],
            "sPostTasks": [
                {
                    "type": "LOG",
                    "arguments": "string",
                    "delay": 1
                }
            ],
            "sErrorTasks": [
                {
                    "type": "LOG",
                    "arguments": "string",
                    "delay": 1
                }
            ]
        }
    ]
}

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