How to get deleted Contacts via REST Api

I'm a third party developer (and a SugarCrm noob) writing an integration limited to the "stock" REST API (so, I can't add endpoints).

My application needs perform an some ongoing sync of Contacts to drive a directory, which is accomplished by querying for changed contacts every half hour by calling /rest/v10/Contacts?filter=

with a filter like:

[

   {
      "date_modified" : {
         "$gt" : "2016-08-18T13:37:02"
      }
   }
]

The problem I'm having is that I don't get deleted records, and therefore don't know to disable them on my directory.

I understand from the documentation that, when a user deletes a Contact, SugarCRM should be soft deleting records, but they are still not being returned to my application.

I also read that I might need to specify that deleted records should be returned (and that this parameter returns ONLY deleted records, but I'm happy to make two calls instead of one):

[

   {
      "date_modified": {
         "$gt": "2016-08-18T13:37:02"
      },
      "deleted": true
   }

]

But that still returns no records.

The client has the purgeRecords scheduled job turned off and, regardless, I still don't get the record back when attempting to query it within five minutes of the client deleting it.

Explicitly querying for the record with /Contacts/[ContactId] return a 404 (as expected):

{"error":"not_found","error_message":"Could not find record: [ContactId] in module: Contacts"}

Given that the client has the purging of records turned off, am I missing a system setting that is indicating that Contacts should be hard-deleted? If it matters, they are deleting Contacts in the record view.

Thank you in advance and any help would be greatly appreciated,

Marco

0 Alan Apter over 7 years ago
There's currently no API endpoint for soft-deleted records because as far as Sugar's concerned they're gone, but it'd be simple enough to create one. Here's the documentation for creating an endpoint:
http://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_7.7/Integration/Web_Services/v10/Extendi…
In the API function, you'd want to put in something like this:
public function MyGetMethod($api, $args){ $results = array(); $date_modified = $args['date_modified']; $sql = "SELECT id FROM contacts WHERE deleted = 1 and date_modified > '". $date_modified ."'"; $result = $GLOBALS['db']->query($sql); while($row = $GLOBALS['db']->fetchByAssoc($result)){ $results[] = $row['id']; } return $results; }
I've used the DBManager to get the data out, the documentation is here: http://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_7.7/Data_Framework/Database/DBManagerFac…
You'll have to be sure of security when you do this. I've got sql injection in this example - e.g. if somebody was an authenticated user, they could use the endpoint to put some sql injection in the date_modified parameter and (for example) elevate their own privileges. So either sanitise the input yourself (or use PDO and prepared statements). If all your users are trusted (e.g. they're all admins anyway or they wouldn't mess with the system), then you might not need this level of security.
Cancel
Vote Up +1 Vote Down

Sign in to reply

Verify Answer

Cancel