This repository has been archived by the owner on Oct 12, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Request Options
mattkol edited this page Dec 31, 2016
·
2 revisions
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 (or module C# 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 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:
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. |
SugarRestSharp
- Home
- Request
- Request Types
- Request Options
- Response
- Read Module By Id
- Read Module Collection By Page
- Read Module Collection
- Create Module
- Create Module Collection
- Update Module
- Update Module Collection
- Delete Module
- Linked Modules 1
- Linked Modules 2
- Linked Modules 3
- Query Options 1
- Query Options 2
- Query Options 3