Releases · rdytech/react-filterbar

Saved Search API

GET

Change the format for loading filters for Saved Search API. 2.0.0. implements new format for saving using POST request. GET is changed to support the new format of saved search. It is also backward compatible with the format in 1.. for loading saved search.

The new format for loading filter configurations for Saved Search API is:

[
  {
    name: NAME,
    configuration: [
      {
        uid: "dt.filterName",
        type: "select",
        field: "dt.field",
        value: "User selected value",
      },
      ...,
    ],
    url: "/saved_searches/my_id",
  },
  ...,
]

and the old format of version (1..) that is still supported by backward compatibility is:

[
  {
    name: NAME,
    configuration: {
                     "dt.filterName":"value",
                     ...
                   },
    url: '/saved_searches/my_id'
  }, ...
]

POST

Change the format for saving filters for Saved Search API. The new format for saved search is:

  {
    "saved_search": {
      "search_title": "user entered value",
      "filters": '[{"uid":"dt.filterName","type":"select","field":"dt.field","value":"User selected value"},{"uid":"dt.filterName","type":"text","field":"dt.field","value":"User entered value"}]',
    }
  }

"filters" key now stores Stringified JSON value. The JSON format of parsed "filters" is:

[
  {
    uid: "dt.filterName",
    type: "select",
    field: "dt.field",
    value: "User selected value",
  },
  {
    uid: "dt.filterName",
    type: "text",
    field: "dt.field",
    value: "User entered value",
  },
];