REST API:Retrieve Record Permissions Query Parameter

When retrieving a record or doing a search, it is possible to retrieve the user's record permissions with respect to those records, as well as the data. That capability is useful, for example, when an application needs to determine whether or not to display [Edit] and [Delete] buttons.

To specify the parameter, put retrieveRecordPermissions=true into the query string for the resource. For example:

https://{domain}/networking/rest/record/{objectName}/{record_id}?retrieveRecordPermissions=true
https://{domain}/networking/rest/record/{objectName}/{search_parameters}&retrieveRecordPermissions=true

When specified, and when the field list contains the id field (needed to do an update or delete), the returned data tells which operations the user has permission to do:

<syntaxhighlight lang="xml" enclose="div">

     ...
   <recordPermissions>
       <canUpdate>true</canUpdate>
       <canDelete>false</canDelete>
   </recordPermissions>

</record> </syntaxhighlight>

Learn more:

• Specifying Query Parameters in REST APIs
• Retrieve a Record
• Dynamic Search