Get a list of rules with empty comments

Get a list of rules with empty comments for a specific device.

For information about rules with empty comments rules, see POLICY OPTIMIZATION page.

Resource Name:

/afa/api/v1/rule/policy-optimization/{deviceTreeName}/withoutcomment

Request Method: GET

Request Parameters:

Element

Type

Description

deviceTreeName
Mandatory

string

Tree name of the device.

(To get the entity name for a device, see Device names in the ASMS APIs. If the entity is a group, use the name from the UI).
pageNumber
optional		 Integer The page number to include in the response. Default value : 0 (Value 0 means first page).
pageSize
optional		 Integer The number of results to include on each page in the response. Default value : 50.
ruleDisplayType
optional 		string

Determines the amount of details included in the response.

Available values :

  • BASIC: The source, destination and service contain network objects and services that only have canonized names.

  • FULL: The source destination and service contain the all network objects and services.

  • DISPLAY: Source, destination and service are partially filled and contain icons and NAT type data.

  • SLIM: Similar to the BASIC but without a link

Response:

Code

Description
200

Operation completed successfully

400

Validation error

401

Unauthorized

Request examples 

curl -X GET "https://[localhost]/afa/api/v1/rule/policy-optimization/{deviceTreeName}/withoutcomment?pageNumber=0&pageSize=50&ruleDisplayType=DISPLAY" -H "accept: */*"

Response examples

Copy 
{
  "content": [
    {
      "deviceId": 22800,
      "ruleId": "from_DMZ_to_DMZ_name_Jonathan",
      "ruleNum": "1",
      "source": [
        {
          "canonizedName": "any-ipv4",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "destination": [
        {
          "canonizedName": "any-ipv4",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "originalName": "any",
          "canonizedName": "any",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "deny",
      "comment": [
        ""
      ],
      "enable": "enable",
      "log": "enabled",
      "link": "rule_from_DMZ_to_DMZ_name_Jonathan",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "name": [
          {
            "value": "Jonathan"
          }
        ],
        "linenum": [
          {
            "value": "1861"
          }
        ],
        "from": [
          {
            "value": "DMZ"
          }
        ],
        "time": [
          {
            "value": ""
          }
        ],
        "to": [
          {
            "value": "DMZ"
          }
        ]
      },
      "isValidUserSourceModel": true
    },
    {
      "deviceId": 22800,
      "ruleId": "from_Global_to_Global_name_Jonathan",
      "ruleNum": "4",
      "source": [
        {
          "canonizedName": "any-ipv4",
          "invalidNamedObject": false
        }
      ],
      "isNegateSource": false,
      "destination": [
        {
          "canonizedName": "any-ipv4",
          "invalidNamedObject": false
        }
      ],
      "isNegateDestination": false,
      "service": [
        {
          "originalName": "any",
          "canonizedName": "any",
          "invalidNamedObject": false
        }
      ],
      "isNegateService": false,
      "action": "deny",
      "comment": [
        ""
      ],
      "enable": "enable",
      "log": "disabled",
      "link": "rule_from_Global_to_Global_name_Jonathan",
      "documentation": {
        "business criticality": "",
        "business partner": "",
        "documentation": "",
        "business applications": ""
      },
      "additionalData": {
        "name": [
          {
            "value": "Jonathan"
          }
        ],
        "linenum": [
          {
            "value": "1931"
          }
        ],
        "from": [
          {
            "value": "Global"
          }
        ],
        "to": [
          {
            "value": "Global"
          }
        ],
        "time": [
          {
            "value": ""
          }
        ]
      },
      "isValidUserSourceModel": true
    }
  ],
  "pageable": {
    "sort": {
      "sorted": false,
      "unsorted": true,
      "empty": true
    },
    "pageSize": 50,
    "pageNumber": 0,
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "totalPages": 1,
  "totalElements": 2,
  "last": true,
  "number": 0,
  "size": 50,
  "numberOfElements": 2,
  "sort": {
    "sorted": false,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "empty": false
}