Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-139

New system query option $search for free-text search within an entity set

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: ABNF, Protocol, URL Conventions
    • Labels:
      None
    • Environment:

      [Proposed]

      Description

      Searching a list of entries by entering a free-text search phrase in a single input field is a very common UI pattern in mobile and browser-based applications.

      Translating this (typically case-insensitive) search phrase into an OData filter string is cumbersome and error-prone.

      A better alternative is providing a specialized query option that takes a search term and allows the server to interpret this search term.

      GET ~/Orders?$search=blue

      could return sales orders that somehow match the phrase "blue", without the client needing to specify where this phrase may occur. It even could appear in related entities, e.g. the description of one of the products ordered.

      This is comparable to Level 0 Conformance in CQL, see ODATA-3.

        Attachments

          Activity

            People

            • Assignee:
              handl Ralf Handl
              Reporter:
              handl Ralf Handl
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: