InfiniSuite SDK
  • Introduction
  • SDK & Scripting
    • Building Applications
    • Widgets
    • Classes
      • BaseApp
      • DashboardApp
      • EntityApp
      • FormApp
      • ListApp
      • Menu
      • Report
      • ReportQueryApp
      • Toolbar
      • TransactionApp
    • Libraries
      • ApiLib
      • AppLib
      • CacheLib
      • ChartLib
      • ExportLib
      • ImportLib
      • InfobarLib
      • LogLib
      • MainLib
      • MessageLib
      • RqlLib
      • ScriptLib
      • SpreadsheetLib
      • SystemLib
      • TabLib
      • TransactionGridLib
    • Sample Code
      • Entity App
      • Using Radiobuttons
  • REST API
    • Using the REST API
      • Entity Endpoint Summary
      • Authentication
      • Filters
      • Using RQL to Query Data
    • REST Endpoints
      • Account
      • Address
      • Application
      • Box1099
      • Class
      • CompanySetup
      • Contact
      • Favorite
      • Form1099
      • Item
      • Job
      • List
      • ListItem
      • Log
      • Note
      • Relationship
      • SalesTax
      • SalesTaxGroup
      • SalesTaxGroupItem
      • Task
      • Term
      • Transaction
      • TransactionDetail
      • Unit
  • Data Model & Schema
    • Data Model
    • Business Object Schemas
    • Tables
      • account
      • address
      • class
      • companysetup
      • contact
      • item
      • job
      • lead
      • list
      • listitem
      • relationship
      • task
      • term
      • transaction
      • unit
    • Views
      • accountbalanceview
      • accountbalanceyearmonthview
      • accountviewcompact
      • addressview
      • billview
      • classview
      • contactview
      • customerbalance
      • customerinvoicebodetail
      • customerinvoiceboheader
      • customerinvoicetotal
      • customeropeninvoices
      • customeropeninvoicetotal
      • customerpaymenttotal
      • itemview
      • listitemview
      • modelrelationview
      • openbillview
      • salestaxgroupitemview
      • scriptview
      • taskview
      • transaction_balance_view
      • transactiondetailview
      • transactiondetailviewcompact
      • transactiondetailviewnooffset
      • transactiondetailviewoffset
      • transactionview
      • transactionviewcompact
      • trialbalanceview
      • vendorbalance
  • Reference
    • Account Types
    • Field Types
    • Script Types
    • Tab Types
    • Transaction Types
    • Grid Filters
  • Setup & Configuration
    • Application Manager
    • Schema Manager
    • Script Manager
    • Bundle Manager
    • Text Localization
  • License
    • Open Source Licenses
Powered by GitBook
On this page
  • Fields Filter
  • Order Filter
  • Where Filter
  • Limit Filter

Was this helpful?

  1. REST API
  2. Using the REST API

Filters

Fields Filter

A fields filter specifies properties (fields) to include or exclude from the results.

/api/account/?filter={"fields":{"rowid":true,"accountid":true,"accountname":true}}

Order Filter

/api/account/?filter={"order": "accountid"}

Where Filter

/api/relationship/?filter={"where":{"relationship":"Smith Co"}}

Operator

Description

=

Equivalence.

and

Logical AND operator.

or

Logical OR operator.

gt, gte

Numerical greater than (>); greater than or equal (>=). Valid only for numerical and date values.

lt, lte

Numerical less than (<); less than or equal (<=). Valid only for numerical and date values.

between

True if the value is between the two specified values: greater than or equal to first value and less than or equal to second value.

inq, nin

In / not in an array of values.

near

For geolocations, return the closest points, sorted in order of distance. Use with limit to return the n closest points.

neq

Not equal (!=)

like, nlike

LIKE / NOT LIKE operators for use with regular expressions. The regular expression format depends on the backend data source.

like, nlike, options: i

LIKE / NOT LIKE operators for use with regular expressions with the case insensitive flag. It is supported by the memory and MongoDB connectors. The options property set to ā€˜i’ tells LoopBack that it should do case-insensitive matching on the required property.

Limit Filter

/api/relationship/?filter={"where":{"relationship":"Smith Co"},"limit": 50}
PreviousAuthenticationNextUsing RQL to Query Data

Last updated 5 years ago

Was this helpful?