Skip to content
This repository has been archived by the owner on Oct 12, 2021. It is now read-only.

Request Options

mattkol edited this page Jan 22, 2017 · 6 revisions

SugarOnRest request - SugarRestRequest Options class has the following properties:

Field SugarCRM mapping Comment
currentPage offset The current page number. This is required to be set for PagedRead request. Value starts from 1.
numberPerPage max_results The number of entities to be returned per request. This is required to be set for PagedRead request. This also limits the maximum entity collection to be returned.
maxResult max_results The maximum number of entities to be returned per request. This defaults to 100.
selectFields select_fields
linkedModules link_name_to_fields_array This sets the link to other modules info. The property also sets optional select fields. The dictionary key is the module name (or module Java class type) while the value is the optional select fields. Value can be null.
query query Raw "where" clause query. E.g- "accounts.name = 'Air Safety Inc' "
queryPredicates query This is a list of Java query predicate objects. If the "Query" property is set, this value is ignored. See more info below:

SugarRestSharp request - SugarRestRequest Options QueryPredicate class has the following properties:

QueryPreducate Class Properties

Field Description Comment
propertyName Java Pojo module property name or json module property name. E.g NameOf.Accounts.Name or "name".
operator The query operator. This is if of type QueryOperator.
objValue The value. This is of object type.
fromValue The from value. This is of object type. Required for a "between" query operator.
toValue The to value. This is of object type. Required for a "between" query operator.