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

Query Options 1

Jump to bottom
mattkol edited this page Jan 21, 2017 · 2 revisions

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](Request Options).

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

package com.sugaronrest.tests;

import com.sugaronrest.*;
import com.sugaronrest.modules.*;

import java.util.ArrayList;
import java.util.List;

import static com.sugaronrest.QueryOperator.*;

String url = "http://demo.suiteondemand.com/service/v4_1/rest.php";
String username = "will";
String password = "will";

SugarRestClient client = new SugarRestClient();

SugarRestRequest request = new SugarRestRequest(Cases.class);
request.setUrl(url);
request.setUsername(username);
request.setPassword(password);

request.setRequestType(RequestType.BulkRead);

List<QueryPredicate> queryPredicates = new ArrayList<QueryPredicate>();

queryPredicates.add(new QueryPredicate(NameOf.Cases.Name, Equal, "System not responding"));
queryPredicates.add(new QueryPredicate("status", Equal, "Open_New"));

String fromDate = "2016-06-01 00:00:00";
String toDate = "2017-01-20 00:00:00";

queryPredicates.add(new QueryPredicate(NameOf.Cases.DateEntered, QueryOperator.Between, null, fromDate, toDate));

request.getOptions().setQueryPredicates(queryPredicates);
SugarRestResponse response = client.execute(request);

Response (Data)

List<Cases> readCases = (List<Cases>)response.getData();

Response (getJData())

[
  {
    "internal": "",
    "suggestion_box": "",
    "assigned_user_name": "Chris Olliver",
    "description": "",
    "created_by_name": "Joe Bloggs",
    "type": "",
    "resolution": "",
    "work_log": "",
    "jjwg_maps_address_c": "",
    "account_name": "B.C. Investing International",
    "date_entered": "2017-01-11 16:51:02",
    "case_number": "41",
    "id": "31a8dc57-58d2-5a45-98de-587662633251",
    "state": "Open",
    "account_name1": "",
    "contact_created_by_name": "",
    "jjwg_maps_lat_c": "",
    "jjwg_maps_lng_c": "",
    "modified_user_id": "1",
    "assigned_user_id": "seed_chris_id",
    "priority": "P1",
    "created_by": "1",
    "update_text": "",
    "deleted": "0",
    "account_id": "2d34ffad-c1af-4144-6e22-587662ad2227",
    "date_modified": "2017-01-11 16:51:02",
    "jjwg_maps_geocode_status_c": "",
    "contact_created_by_id": "",
    "name": "System not responding",
    "modified_by_name": "Joe Bloggs",
    "aop_case_updates_threaded": "",
    "case_update_form": "",
    "case_attachments_display": "",
    "status": "Open_New"
  },
  {
    "internal": "",
    "suggestion_box": "",
    "assigned_user_name": "Sally Bronsen",
    "description": "",
    "created_by_name": "Joe Bloggs",
    "type": "",
    "resolution": "",
    "work_log": "",
    "jjwg_maps_address_c": "",
    "account_name": "Super Star Holdings Inc",
    "date_entered": "2017-01-11 16:51:02",
    "case_number": "27",
    "id": "c57390ad-3fbd-66c1-6aed-58766274b295",
    "state": "Open",
    "account_name1": "",
    "contact_created_by_name": "",
    "jjwg_maps_lat_c": "",
    "jjwg_maps_lng_c": "",
    "modified_user_id": "1",
    "assigned_user_id": "seed_sally_id",
    "priority": "P1",
    "created_by": "1",
    "update_text": "",
    "deleted": "0",
    "account_id": "c0469557-e84e-53b9-54e5-587662b63f11",
    "date_modified": "2017-01-11 16:51:02",
    "jjwg_maps_geocode_status_c": "",
    "contact_created_by_id": "",
    "name": "System not responding",
    "modified_by_name": "Joe Bloggs",
    "aop_case_updates_threaded": "",
    "case_update_form": "",
    "case_attachments_display": "",
    "status": "Open_New"
  },
  {
    "internal": "",
    "suggestion_box": "",
    "assigned_user_name": "Sarah Smith",
    "description": "",
    "created_by_name": "Joe Bloggs",
    "type": "",
    "resolution": "",
    "work_log": "",
    "jjwg_maps_address_c": "",
    "account_name": "Arts & Crafts Inc",
    "date_entered": "2017-01-11 16:51:02",
    "case_number": "15",
    "id": "dedf45c8-69f7-dd53-98fd-58766254893f",
    "state": "Open",
    "account_name1": "",
    "contact_created_by_name": "",
    "jjwg_maps_lat_c": "",
    "jjwg_maps_lng_c": "",
    "modified_user_id": "1",
    "assigned_user_id": "seed_sarah_id",
    "priority": "P1",
    "created_by": "1",
    "update_text": "",
    "deleted": "0",
    "account_id": "da4a2a18-7dbd-a217-f7ed-5876622b02f7",
    "date_modified": "2017-01-11 16:51:02",
    "jjwg_maps_geocode_status_c": "",
    "contact_created_by_id": "",
    "name": "System not responding",
    "modified_by_name": "Joe Bloggs",
    "aop_case_updates_threaded": "",
    "case_update_form": "",
    "case_attachments_display": "",
    "status": "Open_New"
  }
]

Response (getJsonRawRequest())

{
  "method": "get_entry_list",
  "input_type": "json",
  "response_type": "json",
  "rest_data": {
    "session": "6nndri05d5lhke4mtosd7gimu3",
    "module_name": "Cases",
    "query": " cases.name = 'System not responding' AND cases.status = 'Open_New' AND cases.date_entered BETWEEN '2016-06-01 00:00:00' AND '2017-01-20 00:00:00' ",
    "order_by": "",
    "offset": 0,
    "select_fields": [
      
    ],
    "link_name_to_fields_array": "",
    "max_results": 100,
    "deleted": 0,
    "favorites": false
  }
}

Response (getJsonRawResponse())

{
  "total_count": "3",
  "relationship_list": [
    
  ],
  "entry_list": [
    {
      "name_value_list": {
        "internal": {
          "name": "internal",
          "value": ""
        },
        "suggestion_box": {
          "name": "suggestion_box",
          "value": ""
        },
        "assigned_user_name": {
          "name": "assigned_user_name",
          "value": "Chris Olliver"
        },
        "description": {
          "name": "description",
          "value": ""
        },
        "created_by_name": {
          "name": "created_by_name",
          "value": "Joe Bloggs"
        },
        "type": {
          "name": "type",
          "value": ""
        },
        "resolution": {
          "name": "resolution",
          "value": ""
        },
        "work_log": {
          "name": "work_log",
          "value": ""
        },
        "jjwg_maps_address_c": {
          "name": "jjwg_maps_address_c",
          "value": ""
        },
        "account_name": {
          "name": "account_name",
          "value": "B.C. Investing International"
        },
        "date_entered": {
          "name": "date_entered",
          "value": "2017-01-11 16:51:02"
        },
        "case_number": {
          "name": "case_number",
          "value": "41"
        },
        "id": {
          "name": "id",
          "value": "31a8dc57-58d2-5a45-98de-587662633251"
        },
        "state": {
          "name": "state",
          "value": "Open"
        },
        "account_name1": {
          "name": "account_name1",
          "value": ""
        },
        "contact_created_by_name": {
          "name": "contact_created_by_name",
          "value": ""
        },
        "jjwg_maps_lat_c": {
          "name": "jjwg_maps_lat_c",
          "value": ""
        },
        "jjwg_maps_lng_c": {
          "name": "jjwg_maps_lng_c",
          "value": ""
        },
        "modified_user_id": {
          "name": "modified_user_id",
          "value": "1"
        },
        "assigned_user_id": {
          "name": "assigned_user_id",
          "value": "seed_chris_id"
        },
        "priority": {
          "name": "priority",
          "value": "P1"
        },
        "created_by": {
          "name": "created_by",
          "value": "1"
        },
        "update_text": {
          "name": "update_text",
          "value": ""
        },
        "deleted": {
          "name": "deleted",
          "value": "0"
        },
        "account_id": {
          "name": "account_id",
          "value": "2d34ffad-c1af-4144-6e22-587662ad2227"
        },
        "date_modified": {
          "name": "date_modified",
          "value": "2017-01-11 16:51:02"
        },
        "jjwg_maps_geocode_status_c": {
          "name": "jjwg_maps_geocode_status_c",
          "value": ""
        },
        "contact_created_by_id": {
          "name": "contact_created_by_id",
          "value": ""
        },
        "name": {
          "name": "name",
          "value": "System not responding"
        },
        "modified_by_name": {
          "name": "modified_by_name",
          "value": "Joe Bloggs"
        },
        "aop_case_updates_threaded": {
          "name": "aop_case_updates_threaded",
          "value": ""
        },
        "case_update_form": {
          "name": "case_update_form",
          "value": ""
        },
        "case_attachments_display": {
          "name": "case_attachments_display",
          "value": ""
        },
        "status": {
          "name": "status",
          "value": "Open_New"
        }
      },
      "id": "31a8dc57-58d2-5a45-98de-587662633251",
      "module_name": "Cases"
    },
    {
      "name_value_list": {
        "internal": {
          "name": "internal",
          "value": ""
        },
        "suggestion_box": {
          "name": "suggestion_box",
          "value": ""
        },
        "assigned_user_name": {
          "name": "assigned_user_name",
          "value": "Sally Bronsen"
        },
        "description": {
          "name": "description",
          "value": ""
        },
        "created_by_name": {
          "name": "created_by_name",
          "value": "Joe Bloggs"
        },
        "type": {
          "name": "type",
          "value": ""
        },
        "resolution": {
          "name": "resolution",
          "value": ""
        },
        "work_log": {
          "name": "work_log",
          "value": ""
        },
        "jjwg_maps_address_c": {
          "name": "jjwg_maps_address_c",
          "value": ""
        },
        "account_name": {
          "name": "account_name",
          "value": "Super Star Holdings Inc"
        },
        "date_entered": {
          "name": "date_entered",
          "value": "2017-01-11 16:51:02"
        },
        "case_number": {
          "name": "case_number",
          "value": "27"
        },
        "id": {
          "name": "id",
          "value": "c57390ad-3fbd-66c1-6aed-58766274b295"
        },
        "state": {
          "name": "state",
          "value": "Open"
        },
        "account_name1": {
          "name": "account_name1",
          "value": ""
        },
        "contact_created_by_name": {
          "name": "contact_created_by_name",
          "value": ""
        },
        "jjwg_maps_lat_c": {
          "name": "jjwg_maps_lat_c",
          "value": ""
        },
        "jjwg_maps_lng_c": {
          "name": "jjwg_maps_lng_c",
          "value": ""
        },
        "modified_user_id": {
          "name": "modified_user_id",
          "value": "1"
        },
        "assigned_user_id": {
          "name": "assigned_user_id",
          "value": "seed_sally_id"
        },
        "priority": {
          "name": "priority",
          "value": "P1"
        },
        "created_by": {
          "name": "created_by",
          "value": "1"
        },
        "update_text": {
          "name": "update_text",
          "value": ""
        },
        "deleted": {
          "name": "deleted",
          "value": "0"
        },
        "account_id": {
          "name": "account_id",
          "value": "c0469557-e84e-53b9-54e5-587662b63f11"
        },
        "date_modified": {
          "name": "date_modified",
          "value": "2017-01-11 16:51:02"
        },
        "jjwg_maps_geocode_status_c": {
          "name": "jjwg_maps_geocode_status_c",
          "value": ""
        },
        "contact_created_by_id": {
          "name": "contact_created_by_id",
          "value": ""
        },
        "name": {
          "name": "name",
          "value": "System not responding"
        },
        "modified_by_name": {
          "name": "modified_by_name",
          "value": "Joe Bloggs"
        },
        "aop_case_updates_threaded": {
          "name": "aop_case_updates_threaded",
          "value": ""
        },
        "case_update_form": {
          "name": "case_update_form",
          "value": ""
        },
        "case_attachments_display": {
          "name": "case_attachments_display",
          "value": ""
        },
        "status": {
          "name": "status",
          "value": "Open_New"
        }
      },
      "id": "c57390ad-3fbd-66c1-6aed-58766274b295",
      "module_name": "Cases"
    },
    {
      "name_value_list": {
        "internal": {
          "name": "internal",
          "value": ""
        },
        "suggestion_box": {
          "name": "suggestion_box",
          "value": ""
        },
        "assigned_user_name": {
          "name": "assigned_user_name",
          "value": "Sarah Smith"
        },
        "description": {
          "name": "description",
          "value": ""
        },
        "created_by_name": {
          "name": "created_by_name",
          "value": "Joe Bloggs"
        },
        "type": {
          "name": "type",
          "value": ""
        },
        "resolution": {
          "name": "resolution",
          "value": ""
        },
        "work_log": {
          "name": "work_log",
          "value": ""
        },
        "jjwg_maps_address_c": {
          "name": "jjwg_maps_address_c",
          "value": ""
        },
        "account_name": {
          "name": "account_name",
          "value": "Arts & Crafts Inc"
        },
        "date_entered": {
          "name": "date_entered",
          "value": "2017-01-11 16:51:02"
        },
        "case_number": {
          "name": "case_number",
          "value": "15"
        },
        "id": {
          "name": "id",
          "value": "dedf45c8-69f7-dd53-98fd-58766254893f"
        },
        "state": {
          "name": "state",
          "value": "Open"
        },
        "account_name1": {
          "name": "account_name1",
          "value": ""
        },
        "contact_created_by_name": {
          "name": "contact_created_by_name",
          "value": ""
        },
        "jjwg_maps_lat_c": {
          "name": "jjwg_maps_lat_c",
          "value": ""
        },
        "jjwg_maps_lng_c": {
          "name": "jjwg_maps_lng_c",
          "value": ""
        },
        "modified_user_id": {
          "name": "modified_user_id",
          "value": "1"
        },
        "assigned_user_id": {
          "name": "assigned_user_id",
          "value": "seed_sarah_id"
        },
        "priority": {
          "name": "priority",
          "value": "P1"
        },
        "created_by": {
          "name": "created_by",
          "value": "1"
        },
        "update_text": {
          "name": "update_text",
          "value": ""
        },
        "deleted": {
          "name": "deleted",
          "value": "0"
        },
        "account_id": {
          "name": "account_id",
          "value": "da4a2a18-7dbd-a217-f7ed-5876622b02f7"
        },
        "date_modified": {
          "name": "date_modified",
          "value": "2017-01-11 16:51:02"
        },
        "jjwg_maps_geocode_status_c": {
          "name": "jjwg_maps_geocode_status_c",
          "value": ""
        },
        "contact_created_by_id": {
          "name": "contact_created_by_id",
          "value": ""
        },
        "name": {
          "name": "name",
          "value": "System not responding"
        },
        "modified_by_name": {
          "name": "modified_by_name",
          "value": "Joe Bloggs"
        },
        "aop_case_updates_threaded": {
          "name": "aop_case_updates_threaded",
          "value": ""
        },
        "case_update_form": {
          "name": "case_update_form",
          "value": ""
        },
        "case_attachments_display": {
          "name": "case_attachments_display",
          "value": ""
        },
        "status": {
          "name": "status",
          "value": "Open_New"
        }
      },
      "id": "dedf45c8-69f7-dd53-98fd-58766254893f",
      "module_name": "Cases"
    }
  ],
  "result_count": 3,
  "next_offset": 3
}

SugarOnRest

Clone this wiki locally