SugarCRM SupportProduct GuidesSugar DeveloperSugar Developer Guide 10.3IntegrationWeb ServicesREST APIEndpoints/<module>/:record/audit GET
This release is only available for SugarCloud customers.

/<module>/:record/audit GET

Overview

Returns data changes for a specific record.

Request Arguments

Name Type Description Required
record String The record id. True
module String The name of the module. True

Query Parameters

Name Type Description Required
max_num Integer A maximum number of records to return. The default is all records. False
offset Integer The number of records to skip over before records are returned. The default is 0. The parameter will be ignored if the max_num parameter is missing. False

Response Arguments

Name Type Description
next_offset Integer Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records Array An array of results containing matched records.

Response

{
   "next_offset":-1,
   "records":[
      {
         "id":"b569e480-237a-5921-4382-512ff555fee7",
         "parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
         "date_created":"03\/01\/2013 12:26am",
         "created_by":"admin",
         "field_name":"Team ID:",
         "data_type":"team_list",
         "before_value_string":"East",
         "after_value_string":"Will"
      },
      {
         "id":"bc0bee72-8398-a0a6-d731-512ff5bfebc7",
         "parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
         "date_created":"03\/01\/2013 12:26am",
         "created_by":"admin",
         "field_name":"Teams",
         "data_type":"id",
         "before_value_string":"East, Global, West",
         "after_value_string":"Jim, Will"
      }
   ]
}

Change Log

Version Change
v11_11 Added optional max_num and offset parameters to /Audit GET endpoint.
v10 Added /Audit GET endpoint.

Last modified: 2021-01-29 21:26:15