Filter

Decodes the Filter

Changed on

Decoded filter will always have the same shape of Kavita.Models.DTOs.Filtering.v2.IFilterDto2. The concrete class is driven by EntityType`. Classes: Kavita.Models.DTOs.Filtering.v2.Requests.SeriesFilterV2Dto, Kavita.Models.DTOs.Filtering.v2.Requests.PersonFilterDto, Kavita.Models.DTOs.Filtering.v2.Requests.AnnotationFilterDto, Kavita.Models.DTOs.Filtering.v2.Requests.ReadingListFilterDto

post/api/Filter/decode

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Filter/decode
  • Auth
    API key in header x-api-key

Request body

encodedFilterstring nullable

Response

OK

idinteger
namestring nullable
combination0 | 1

Members:

  • 0 — Or
  • 1 — And
limitTointeger
entityType0 | 1 | 2 | 3

Members:

  • 0 — Series
  • 1 — Reading List (ReadingList)
  • 2 — Person
  • 3 — Annotation

Changes

    • warning

      removed the optional property from the response with the status (media type: text/plain)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: text/json)

    • warning

      removed the optional property from the response with the status (media type: text/plain)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • warning

      added the new 17.00 enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new 17.00 enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new 17.00 enum value to the // response property for the response status (media type: text/json)