GET File Agent Rule

The GET File Agent Rule is used to retrieve all the file agent rule details.

Method	URI
`GET`	/cdwebconsole/svc/fileagentrule

The following example shows the Command:

curl -X 'GET' \
  'https://172.20.183.160:9443/cdwebconsole/svc/fileagentrule?limit=10' \
  -H 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbmlzdHJhdG9yOjE3Mi4yMC4xODUuOTU6MTM2Mzo1MTI5NzljMi01ZGU5LTQxZjgtYTg5Ni1mZWMzMmIyNWVlYmYiLCJleHAiOjE3MTQ1MDQwOTV9.S3Wv2GCpL4hV1CXMpRAH5Ij59e2jhZMLw7nIN4VVW1tziINTwofyNpFcTU3cJNnnDjPJsH8dNwt_jQqFni0-ow' \
  -H 'Content-Type: application/json' \
  -H 'X-XSRF-TOKEN: ef0c5ea5-3afa-4a0e-83d1-e24fb395957e'

Table 1. Input Parameters
Parameter Name	Required/Optional	Description	Valid values
`offset`	`Optional`	Specifies the start index from which it will fetch the data provided by the user. Validation: String	It should be greater than or equal to 0.
priority	`Optional`	Specify File Agent Rule Priority
name	`Optional`	Specify File Agent Rule Name
nameStartWith	`Optional`	All rules starting with this String will be returned.
ruleStatus	`Optional`	Specify File Agent Rule Status.	Enabled, Disabled, Draft
startLastModified	`Optional`	Specify File Agent Rule startLastModified.	Date(mm/dd/yyyy) followed by Time(hh:mm:ss am/pm).
endLastModified	`Optional`	Specify File Agent Rule endLastModified.	Date(mm/dd/yyyy) followed by Time(hh:mm:ss am/pm).
limit	`Optional`	Specifies the number of records to be returned.

The following example shows the Sample Response:

{
  "totalRecords": 11,
  "rules": [
    {
      "comments": "Auto generated rule",
      "fileSizeEnabled": false,
      "filePathKeyvalues": "",
      "procName": "",
      "ruleStatus": "Disabled",
      "priority": 0,
      "filePathEnabled": false,
      "altFileName": "",
      "procArgs": "",
      "notifyUid": "",
      "name": "Default rule",
      "fileSizeKeyvalues": "",
      "lastModified": "Mon Feb 12 17:31:28 IST 2024",
      "procPriority": "1",
      "fileNameKeyvalues": "",
      "procClass": "1",
      "fileNameEnabled": false
    }
  ]
}