Query Options 1 modified by Kola Oyewumi

Kola Oyewumi — Sun, 18 Dec 2016 17:24:08 -0000

Basic Usage

This sample usage shows how to read "Cases" module entity collection data with query predicates. For more request options make changes to the Options parameter.

This implements the get_entry_list SugarCRM REST API method setting the query parameter.

using SugarRestSharp;

string url = "http://191.101.224.189/sugar/service/v4_1/rest.php";
string username = "will";
string password = "will";

var client = new SugarRestClient(url, username, password);

var request = new SugarRestRequest(RequestType.BulkRead);
request.Options.MaxResult = 3;

request.Options.QueryPredicates = new List<QueryPredicate>();
request.Options.QueryPredicates.Add(new QueryPredicate(nameof(Case.Name), QueryOperator.StartsWith, "Warning"));
request.Options.QueryPredicates.Add(new QueryPredicate("name", QueryOperator.Contains, "message"));
request.Options.QueryPredicates.Add(new QueryPredicate(nameof(Case.Status), QueryOperator.Equal, "Assigned"));
DateTime date = DateTime.Parse("07/02/2016");
request.Options.QueryPredicates.Add(new QueryPredicate(nameof(Case.DateEntered), 
                                              QueryOperator.Between, null, date.AddDays(-1), 
                                              DateTime.Now));

SugarRestResponse response = await client.ExecuteAsync<Case>(request);

Response (Data)

List<Case> cases = (List<Case>)response.Data;

Response (JData)

[
  {
    "assigned_user_name": "Sally Bronsen",
    "modified_by_name": "Administrator",
    "created_by_name": "Administrator",
    "id": "35958ef4-d1f3-e486-c952-5777b5585832",
    "name": "Warning message when using the wrong browser",
    "date_entered": "2016-07-02 12:36:44",
    "date_modified": "2016-07-02 12:36:44",
    "modified_user_id": "1",
    "created_by": "1",
    "description": "",
    "deleted": "0",
    "assigned_user_id": "seed_sally_id",
    "case_number": "33",
    "type": "",
    "status": "Assigned",
    "priority": "P1",
    "resolution": "",
    "work_log": "",
    "account_name": "360 Vacations",
    "account_name1": "",
    "account_id": "2b8eae60-d3c6-a655-c395-5777b5e69603"
  },
  {
    "assigned_user_name": "Chris Olliver",
    "modified_by_name": "Administrator",
    "created_by_name": "Administrator",
    "id": "cdd99d3c-24c2-0944-4f56-5777b5c03d8f",
    "name": "Warning message when using the wrong browser",
    "date_entered": "2016-07-02 12:36:44",
    "date_modified": "2016-07-02 12:36:44",
    "modified_user_id": "1",
    "created_by": "1",
    "description": "",
    "deleted": "0",
    "assigned_user_id": "seed_chris_id",
    "case_number": "50",
    "type": "",
    "status": "Assigned",
    "priority": "P3",
    "resolution": "",
    "work_log": "",
    "account_name": "Complete Holding",
    "account_name1": "",
    "account_id": "c4f1333b-d524-6562-ce77-5777b51048f7"
  }
]

Response (JsonRawRequest)

{
  "resource": "",
  "parameters": [
    {
      "name": "method",
      "value": "get_entry_list",
      "type": "GetOrPost"
    },
    {
      "name": "input_type",
      "value": "json",
      "type": "GetOrPost"
    },
    {
      "name": "response_type",
      "value": "json",
      "type": "GetOrPost"
    },
    {
      "name": "rest_data",
      "value": "{\"session\":\"scdu377t3mo17717hbf5o2qr56\",\"module_name\":\"Cases\",\"query\":\" cases.name LIKE 'Warning%' AND cases.name LIKE '%message%' AND cases.status = 'Assigned' AND cases.date_entered BETWEEN '2016-07-01 12:00:00 AM' AND '2016-12-18 8:17:25 AM' \",\"order_by\":\"\",\"offset\":0,\"select_fields\":[],\"link_name_to_fields_array\":\"\",\"max_results\":3,\"deleted\":0,\"favorites\":false}",
      "type": "GetOrPost"
    },
    {
      "name": "Accept",
      "value": "application\/json, application\/xml, text\/json, text\/x-json, text\/javascript, text\/xml",
      "type": "HttpHeader"
    }
  ],
  "method": "POST",
  "uri": "http:\/\/191.101.224.189\/sugar\/service\/v4_1\/rest.php"
}

Response (JsonRawResponse)