https://sourceforge.net/p/sugarrestsharp/wiki/Request%2520Options/Recent changes to Request OptionsenSun, 18 Dec 2016 17:24:10 -0000https://sourceforge.net/p/sugarrestsharp/wiki/Request%2520Options/<div class="markdown_content"><p>SugarRestSharp request - SugarRestRequest Options <a class="" href="https://github.com/mattkol/SugarRestSharp/blob/master/SugarRestSharpSolution/SugarRestSharp/Options.cs" rel="nofollow">class</a> has the following properties:</p> <table> <thead> <tr> <th>Property</th> <th>SugarCRM mapping</th> <th>Comment</th> </tr> </thead> <tbody> <tr> <td>CurrentPage</td> <td>offset</td> <td>The current page number. This is required to be set for PagedRead request. Value starts from 1.</td> </tr> <tr> <td>NumberPerPage</td> <td>max_results</td> <td>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.</td> </tr> <tr> <td>MaxResult</td> <td>max_results</td> <td>The maximum number of entities to be returned per request. This defaults to 100.</td> </tr> <tr> <td>SelectFields</td> <td>select_fields</td> <td></td> </tr> <tr> <td>LinkedModules</td> <td>link_name_to_fields_array</td> <td>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.</td> </tr> <tr> <td>Query</td> <td>query</td> <td>Raw "where" clause query. E.g- "accounts.name = 'Air Safety Inc' "</td> </tr> <tr> <td>QueryPredicates</td> <td>query</td> <td>This is a list of C# query predicate objects. If the "Query" property is set, this value is ignored. See more info below:</td> </tr> </tbody> </table> <p>SugarRestSharp request - SugarRestRequest Options QueryPredicate <a class="" href="https://github.com/mattkol/SugarRestSharp/blob/master/SugarRestSharpSolution/SugarRestSharp/QueryPredicate.cs" rel="nofollow">class</a> has the following properties:</p> <h4 id="querypreducate-class-properties">QueryPreducate Class Properties</h4> <table> <thead> <tr> <th>Property</th> <th>Description</th> <th>Comment</th> </tr> </thead> <tbody> <tr> <td>PropertyName</td> <td>C# module property name or json module property name.</td> <td>E.g nameof(Account.Name) or "name".</td> </tr> <tr> <td>Operator</td> <td>The query operator.</td> <td>This is if of type <a class="" href="https://github.com/mattkol/SugarRestSharp/blob/master/SugarRestSharpSolution/SugarRestSharp/QueryOperator.cs" rel="nofollow">QueryOperator</a>.</td> </tr> <tr> <td>Value</td> <td>The value.</td> <td>This is of object type.</td> </tr> <tr> <td>FromValue</td> <td>The from value.</td> <td>This is of object type. Required for a "between" query operator.</td> </tr> <tr> <td>ToValue</td> <td>The to value.</td> <td>This is of object type. Required for a "between" query operator.</td> </tr> </tbody> </table></div>Kola OyewumiSun, 18 Dec 2016 17:24:10 -0000https://sourceforge.net2c1772b1f37a5d6d5a916e794290356bb66ac5cf