Menu

Request Options

Kola Oyewumi

SugarRestSharp request - SugarRestRequest Options class has the following properties:

Property 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 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 C# 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

Property Description Comment
PropertyName C# module property name or json module property name. E.g nameof(Account.Name) or "name".
Operator The query operator. This is if of type QueryOperator.
Value 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.

Related

Wiki: Create Module Collection
Wiki: Create Module
Wiki: Delete Module
Wiki: Home
Wiki: Linked Modules 1
Wiki: Linked Modules 2
Wiki: Linked Modules 3
Wiki: Query Options 1
Wiki: Query Options 2
Wiki: Query Options 3
Wiki: Read Module By Id
Wiki: Read Module Collection By Page
Wiki: Read Module Collection
Wiki: Request Types
Wiki: Request
Wiki: Response
Wiki: Update Module Collection
Wiki: Update Module
Wiki: _Sidebar

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.