Thread Details
  • State Not Answered
  • Replies 4 replies
  • Subscribers 367 subscribers
  • Views 1323 views
  • Users 0 members are here
Forum Actions

What is the use of erased_fields=true in REST API ?

Gurpreet Singh

 Hi, 

We are using rest api to get the records from any module , We see there is parameter used in that ?erased_fields=true , What does that mean ? 

For ex : we are using the api : /rest/v11_20/M03_Work_Product?erased_fields=true&view=list&order_by=date_modified:desc

So what does earased_fields= true mean in that api ? Please explain if anyone have any idea on this .

Parents
  • 0

    When you delete a record Sugar does not remove the records from the DB immediately, rather it marks them with a field: deleted = 1

    Those records are then truly purged when the scheduler to remove them runs, I believe that out of the box it's set to run once a month.

    The "erased_fields = true" includes those records with deleted = 1 in the result set.

    FrancescaS

  • 0 in reply to Francesca Shiekh

    Hi  & ,

    I believe erased_fields has do with PII in the Data Privacy features of Sugar, not with returning soft deleted records. What the actual flag in the API query achieves is something I am not clear on, but that is the only feature I know of that uses terminology similar to this. My best guess is that, when enabled, it would return an indicator whether a particular field's contents were erased as part of a data privacy action.

    Chris

    Co-Founder | SugarCRM's 2024 Global Outfitters Partner of the Year

Reply Children