https://sourceforge.net/p/sugaronrest/wiki/Read%2520Module%2520Collection/Recent changes to Read Module CollectionenSat, 04 Mar 2017 12:37:19 -0000https://sourceforge.net/p/sugaronrest/wiki/Read%2520Module%2520Collection/<div class="markdown_content"><pre>--- v1 +++ v2 @@ -1 +1,234 @@ -Read Module Collection +## Basic Usage +This sample usage shows how to read "Cases" module entity collection data. It highlights usage of fields selection option. For more request options make changes to the [Options parameter](Request Options). + +This implements the **_get_entry_list_** SugarCRM REST API method. + + :::java + package com.sugaronrest.tests; + + import com.sugaronrest.*; + import com.sugaronrest.modules.Cases; + + import java.util.List; + import java.util.Map; + + + String url = "http://demo.suiteondemand.com/service/v4_1/rest.php"; + String username = "will"; + String password = "will"; + + String moduleName = "Cases"; + + SugarRestClient client = new SugarRestClient(url, username, password); + SugarRestRequest request = new SugarRestRequest(moduleName, RequestType.BulkRead); + + // Parameter can be set to null or leave unset. + request.setParameter(null); + + // Select fields. + List&lt;String&gt; selectFields = new ArrayList&lt;String&gt;(); + selectFields.add(NameOf.Cases.Id); + selectFields.add(NameOf.Cases.Name); + + // You can mix Java type and json type. + selectFields.add("status"); + selectFields.add("created_by"); + + request.getOptions().setSelectFields(selectFields); + + // Select only 5 entities. + // 5 is maximum, if all cases less than 5, less than 5 will be returned. + request.getOptions().setMaxResult(5); + SugarRestResponse response = client.execute(request); + +### Response (getData()) + + :::java + List&lt;Cases&gt; cases = (List&lt;Cases&gt;) response.getData(); + +### Response (getJData()) + + :::json + [ + { + "name": "System not responding", + "id": "13e711c5-dc7e-28fa-71ec-5876629cd674", + "created_by": "1", + "status": "Closed_Rejected" + }, + { + "name": "Need assistance with large customization", + "id": "15a99525-8583-293c-b9cd-5876620c91e5", + "created_by": "1", + "status": "Open_New" + }, + { + "name": "Need assistance with large customization", + "id": "19a63b88-952c-82c8-ec2b-58766272ae3a", + "created_by": "1", + "status": "Open_Assigned" + }, + { + "name": "Need assistance with large customization", + "id": "2bf4871f-1880-d78d-1b3b-5876622c97e5", + "created_by": "1", + "status": "Open_New" + }, + { + "name": "System not responding", + "id": "2d409f53-53a3-3cd0-4e0f-587662e358bf", + "created_by": "1", + "status": "Closed_Rejected" + } + ] + +### Response (getJsonRawRequest()) + + :::json + { + "method": "get_entry_list", + "input_type": "json", + "response_type": "json", + "rest_data": { + "session": "cirkqrjapmi9qh3dss0ihml4t6", + "module_name": "Cases", + "query": "", + "order_by": "", + "offset": 0, + "select_fields": [ + "id", + "name", + "status", + "created_by" + ], + "link_name_to_fields_array": "", + "max_results": 5, + "deleted": 0, + "favorites": false + } + } + } + +### Response (JsonRawResponse) + + :::json + { + "total_count": "50", + "relationship_list": [ + + ], + "entry_list": [ + { + "name_value_list": { + "name": { + "name": "name", + "value": "System not responding" + }, + "id": { + "name": "id", + "value": "13e711c5-dc7e-28fa-71ec-5876629cd674" + }, + "created_by": { + "name": "created_by", + "value": "1" + }, + "status": { + "name": "status", + "value": "Closed_Rejected" + } + }, + "id": "13e711c5-dc7e-28fa-71ec-5876629cd674", + "module_name": "Cases" + }, + { + "name_value_list": { + "name": { + "name": "name", + "value": "Need assistance with large customization" + }, + "id": { + "name": "id", + "value": "15a99525-8583-293c-b9cd-5876620c91e5" + }, + "created_by": { + "name": "created_by", + "value": "1" + }, + "status": { + "name": "status", + "value": "Open_New" + } + }, + "id": "15a99525-8583-293c-b9cd-5876620c91e5", + "module_name": "Cases" + }, + { + "name_value_list": { + "name": { + "name": "name", + "value": "Need assistance with large customization" + }, + "id": { + "name": "id", + "value": "19a63b88-952c-82c8-ec2b-58766272ae3a" + }, + "created_by": { + "name": "created_by", + "value": "1" + }, + "status": { + "name": "status", + "value": "Open_Assigned" + } + }, + "id": "19a63b88-952c-82c8-ec2b-58766272ae3a", + "module_name": "Cases" + }, + { + "name_value_list": { + "name": { + "name": "name", + "value": "Need assistance with large customization" + }, + "id": { + "name": "id", + "value": "2bf4871f-1880-d78d-1b3b-5876622c97e5" + }, + "created_by": { + "name": "created_by", + "value": "1" + }, + "status": { + "name": "status", + "value": "Open_New" + } + }, + "id": "2bf4871f-1880-d78d-1b3b-5876622c97e5", + "module_name": "Cases" + }, + { + "name_value_list": { + "name": { + "name": "name", + "value": "System not responding" + }, + "id": { + "name": "id", + "value": "2d409f53-53a3-3cd0-4e0f-587662e358bf" + }, + "created_by": { + "name": "created_by", + "value": "1" + }, + "status": { + "name": "status", + "value": "Closed_Rejected" + } + }, + "id": "2d409f53-53a3-3cd0-4e0f-587662e358bf", + "module_name": "Cases" + } + ], + "result_count": 5, + "next_offset": 5 + } </pre> </div>Kola OyewumiSat, 04 Mar 2017 12:37:19 -0000https://sourceforge.net3e86414d4a0a7975d972660e9f51011af65f75d4https://sourceforge.net/p/sugaronrest/wiki/Read%2520Module%2520Collection/<div class="markdown_content"><p>Read Module Collection</p></div>Kola OyewumiSat, 04 Mar 2017 12:37:15 -0000https://sourceforge.net1332a32334ec3a64eefa11415f8a23ef013d0b71