Get all reports

Gets all reports for firewall tree name for a specific date. If date is not specified, all the reports for the firewall are retrieved.

Resource Name:

/api/v1/report/findAllReports

Controller: Report External Controller

Request Method: GET

Request URL Parameters:

Element

Type

Description
deviceName Mandatory

Integer

The tree name of the device. Use the device-setup-controller API GET /devices method to return the tree name

fromDate

optional

String

The date from which to show reports.

format yyyy-mm-dd.

Response parameters

Element

Type

Description
report_id String ID number of the report.
status String

  • COMPLETED

  • FAILED

  • UNCHANGED
completed_on String The date when the report was completed. Only when status is completed.

message

Returned only if the request fails.

String

An error message.

Response:

Status codes:

Code

Description
200

Operation completed successfully

400

Input validation failure
403 Authentication failure.
ActiveChange APIs have the same user-permissions as the UI. If a user without permissions (like requestor) is trying to call one of these APIs, he will get code 403: status is failure, the messages field contains NO_PERMISSIONS code with relevant message.

Request Curl example 

curl -X GET "https://10.20.15.182/afa/api/v1/report/findAllReports?deviceName=AlgosecDevice" -H "accept: */*"

Response example for 200 

[
  {
    "report_id": "afa-402",
    "status": "COMPLETED",
    "completed_on": "Mar-17-2020 17:53"
  },
  {
    "report_id": "afa-514",
    "status": "COMPLETED",
    "completed_on": "Sep-08-2020 12:16"
  },
  {
    "report_id": "afa-648",
    "status": "COMPLETED",
    "completed_on": "Sep-12-2020 21:45"
  },
  {
    "report_id": "afa-654",
    "status": "FAILED"
  },
  {
    "report_id": "afa-655",
    "status": "FAILED"
  },
  {
    "report_id": "afa-665",
    "status": "COMPLETED",
    "completed_on": "Sep-23-2020 13:01"
  },
  {
    "report_id": "afa-666",
    "status": "COMPLETED",
    "completed_on": "Sep-23-2020 13:38"
  },
  {
    "report_id": "afa-668",
    "status": "COMPLETED",
    "completed_on": "Sep-23-2020 14:21"
  },
  {
    "report_id": "afa-684",
    "status": "COMPLETED",
    "completed_on": "Sep-29-2020 18:21"
  },
  {
    "report_id": "afa-782",
    "status": "FAILED"
  },
  {
    "report_id": "afa-821",
    "status": "FAILED"
  },
  {
    "report_id": "afa-934",
    "status": "FAILED"
  },
  {
    "report_id": "afa-1147",
    "status": "FAILED"
  },
  {
    "report_id": "afa-1208",
    "status": "FAILED"
  }
]

Response example for 400 

{
            "status": "Failure",
           "messages": [{
            
"code": "INVALID_REQUEST_TYPE",
"message": "Change request 638 does not match request type Traffic Change"
}],
"data": null

            
}