Filters APIs

Filter APIs work on a per-user basis, allowing each user to create their own filters.

Get Page Filters

• Description – get all filters in the given page

• Request URL – GET /cablevalidation/report/filters/<page>

• Request Content Type – application/json

• Status Codes200 – OK404 – NOT FOUND

• Response Example 

  ["filter1","filter2"]

Get Filter

• Description – get filter by name on the specified page.

• Request URL – GET /cablevalidation/report/filters/<page>/<filter_name>

• Request Content Type – application/json

• Status Codes200 – OK404 – NOT FOUND500 – INTERNAL SERVER ERROR

• Response Example 

  {
    "filter_name": "filter1",
    "columns": {
      "a_endpoint_cable_pn": {
      "type": "Contains",
      "filter": "22"
      }
    }
  }

Add Filter

• Description – add filter to the given page

• Request URL – POST /cablevalidation/report/filters/<page>

• Request Content Type – application/json

• Status Codes201 – Created400 – BAD REQUEST404 – NOT FOUND

• Request Data Example

  {
    "filter_name":"test2",
    "columns":{
    "a_endpoint_cable_pn":{"type":"Contains","filter":"22"}
    }
  }

• Response - 201: Created

Get Filter

• Description – delete the given filter.

• Request URL – DELET /cablevalidation/report/filters/<page>/<filter_name>

• Request Content Type – application/json

• Status Codes204 – NO CONTENT404 – NOT FOUND

• Response – No Content

Last updated: February 10, 2025