Perl

SugarCRM Filtering Records

See more SugarCRM Examples

Export records and filter. Perl

use chilkat();

$success = 0;

$rest = chilkat::CkRest->new();

$success = $rest->Connect("your.site.domain",443,1,1);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$rest->AddHeader("Cache-Control","no-cache");
$rest->AddHeader("OAuth-Token","<access_token>");

# The following code creates the JSON request body.
# The JSON created by this code is shown below.
$jsonReq = chilkat::CkJsonObject->new();
$jsonReq->UpdateString("filter[0].$or[0].name.$starts","A");
$jsonReq->UpdateString("filter[0].$or[1].name.$starts","b");
$jsonReq->UpdateNumber("max_num","2");
$jsonReq->UpdateNumber("offset","0");
$jsonReq->UpdateString("fields","id");
$jsonReq->UpdateString("order_by","date_entered");
$jsonReq->UpdateBool("favorites",0);
$jsonReq->UpdateBool("my_items",0);

# The JSON request body created by the above code:

# {
#   "filter": [
#     {
#       "$or": [
#         {
#           "name": {
#             "$starts": "A"
#           }
#         },
#         {
#           "name": {
#             "$starts": "b"
#           }
#         }
#       ]
#     }
#   ],
#   "max_num": 2,
#   "offset": 0,
#   "fields": "id",
#   "order_by": "date_entered",
#   "favorites": false,
#   "my_items": false
# }

$sbReq = chilkat::CkStringBuilder->new();
$jsonReq->EmitSb($sbReq);

$rest->AddHeader("Content-Type","application/json");

$sbJson = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestSb("POST","/rest/v10/Accounts/filter",$sbReq,$sbJson);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

if ($rest->get_ResponseStatusCode() != 200) {
    print "Received error response code: " . $rest->get_ResponseStatusCode() . "\r\n";
    print "Response body:" . "\r\n";
    print $sbJson->getAsString() . "\r\n";
    exit;
}

$json = chilkat::CkJsonObject->new();
$json->LoadSb($sbJson);

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

$next_offset = $json->IntOf("next_offset");
$i = 0;
$count_i = $json->SizeOfArray("records");
while ($i < $count_i) {
    $json->put_I($i);
    $id = $json->stringOf("records[i].id");
    $date_modified = $json->stringOf("records[i].date_modified");
    $v_module = $json->stringOf("records[i]._module");
    $i = $i + 1;
}

# A sample JSON response body that is parsed by the above code:

# {
#   "next_offset": 2,
#   "records": [
#     {
#       "id": "f16760a4-3a52-f77d-1522-5703ca28925f",
#       "date_modified": "2016-04-05T10:23:28-04:00",
#       "_acl": {
#         "fields": {}
#       },
#       "_module": "Accounts"
#     },
#     {
#       "id": "ec409fbb-2b22-4f32-7fa1-5703caf78dc3",
#       "date_modified": "2016-04-05T10:23:28-04:00",
#       "_acl": {
#         "fields": {}
#       },
#       "_module": "Accounts"
#     }
#   ]
# }

print "Example Completed." . "\r\n";