API Docs for:
Show:

OData Module

The OData module is designed to generate OData query strings for specific API endpoints. General usage is as follows.

var qb = new OData.QueryBuilder('/api/users');
qb.addWhereFilter('id1', OData.STRING, 'fName', OData.EQUALS, 'Bartholomew');
var query = qb.generateQueryUrl(); // query would equal "/api/users/?$filter=fName eq 'Bartholomew'"

The OData object provides the following constants for use with QueryBuilder.addWhereFilter().
Filter types:

  • OData.NULL
  • OData.BOOLEAN
  • OData.DECIMAL
  • OData.SINGLE
  • OData.DOUBLE
  • OData.BYTE
  • OData.SBYTE
  • OData.INT16
  • OData.INT32
  • OData.INT64
  • OData.TIME
  • OData.DATE_TIME
  • OData.DATE_TIME_OFFSET
  • OData.GUID
  • OData.STRING

Query Operators:

  • OData.IS_TRUE
  • OData.IS_FALSE
  • OData.ROUND_EQUALS
  • OData.FLOOR_EQUALS
  • OData.CEILING_EQUALS
  • OData.EQUALS
  • OData.NOT_EQUALS
  • OData.GREATER_THAN
  • OData.GREATER_THAN_OR_EQUAL_TO
  • OData.LESS_THAN
  • OData.LESS_THAN_OR_EQUAL_TO
  • OData.BEFORE
  • OData.AFTER
  • OData.YEAR_EQUALS
  • OData.MONTH_NUMBER_EQUALS
  • OData.DAY_NUMBER_EQUALS
  • OData.HOUR_EQUALS
  • OData.MINUTE_EQUALS
  • OData.SECOND_EQUALS
  • OData.IN_SEMICOLON_SEPARATED
  • OData.CASE_INSENSITIVE_EQUALS
  • OData.CASE_INSENSITIVE_NOT_EQUALS
  • OData.STARTS_WITH
  • OData.DOES_NOT_START_WITH
  • OData.ENDS_WITH
  • OData.DOES_NOT_END_WITH
  • OData.CONTAINS
  • OData.HAS_LENGTH

The OData object provides the following constants for use with QueryBuilder.setOrderBy().
OrderBy Orders:

  • OData.NONE
  • OData.ASC
  • OData.DESC