1. Home
  2. Knowledge Base
  3. FAQs
  4. Consuming the service
  5. What OData functions and query options are supported by Hubway?

What OData functions and query options are supported by Hubway?

Hubway Connect supports the following OData query options and functions:

  • $top – returns the number of available items up to but not greater than the specified value
    https://host/service/Products?$top=5
  • $skip – excludes the first n items of the queried collection from the result, returning items starting at position n+1.
    https://host/service/Products?$skip=5
  • $orderby – specifies the order in which items are returned from the service
    https://host/service/Products?$orderby=ReleaseDate asc, Rating desc
  • $filter – restricts the set of items returned
    https://host/service/Products?$filter=Price lt 10
  • $select – requests that the service return only the properties explicitly requested by the client
    https://host/service/Products?$select=Rating,ReleaseDate
  • $expand – indicates the related entities that will be represented inline
    https://host/service/Orders?$expand=Customer,Items
  • $search – restricts the result to include only those items matching the specified search expression
    https://host/service/Products?$search=bike
  • $count – with a value of true specifies that the total count of items within a collection matching the request be returned along with the result
    https://host/service/Products?$count=true
  • concat – returns a string that appends the second parameter string value to the first
    concat(concat(City,’, ‘), Country) eq ‘Berlin, Germany’
  • contains – returns true if the second string is a substring of the first string (case-sensitive)
    contains(CompanyName,’freds’)
  • endswith – returns true if the first string ends with the second string (case-sensitive)
    endswith(CompanyName,’Futterkiste’)
  • indexof – returns the zero-based character position of the first occurrence of the second string in the first string, or -1 if the first string does not contain the second string (case-sensitive)
    indexof(CompanyName,’lfreds’) eq 1
  • length – returns the number of characters in the string
    length(CompanyName) eq 19
  • startswith – returns true if the first string starts with the second string (case-sensitive)
    startswith(CompanyName,โ€™Alfrโ€™)
  • substring (2 arguments) – returns a substring of the first parameter string value, starting at the Nth character and finishing at the last character (where N is the second parameter integer value)
    substring(CompanyName,1) eq ‘lfreds Futterkiste’
  • substring (3 arguments) – returns a substring of the first parameter string value identified by selecting up to M characters starting at the Nth character (where N is the second parameter integer value and M is the third parameter integer value)
    substring(CompanyName,1,8) eq ‘lfreds F’
  • tolower – returns the input parameter string value with all uppercase characters converted to lowercase
    tolower(CompanyName) eq ‘alfreds futterkiste’
  • toupper – returns the input parameter string value with all lowercase characters converted to uppercase
    toupper(CompanyName) eq ‘ALFREDS FUTTERKISTE’

If the OData function you needed to use is not listed above, reach out to our support team.

Was this article helpful?

Related Articles

Need Support?

Can't find the answer you're looking for?
Contact Support