Audit histories

Audit history provides detailed information about field-level modifications made to particular object.

List audit histories

get/objects/company-config/audit-history

Returns a collection with a key, ID, and link for each audit history. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "OTA6MjgwOTU4",
      • "id": "103:9",
      • "href": "/objects/company-config/audit-history/OTA6MjgwOTU4"
      },
    • {
      • "key": "OTA6MjgwOTYz",
      • "id": "103:10",
      • "href": "/objects/company-config/audit-history/OTA6MjgwOTYz"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an audit history
get/objects/company-config/audit-history/{key}
Returns detailed information for a specified audit history.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the audit history.


 
 Example:  OTA6MjgwOTU4
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "MzEwMDEwMDEwNjM5NDYtMTAzOjktRElTUExBWUNPTlRBQ1QuTEFTVE5BTUU",
    • "id": "103:9",
    • "changeDetails": {
      • "objectName": "accounts-payable/vendor",
      • "objectId": "a_vendor_id",
      • "fieldName": "contacts.default.firstName",
      • "previousValue": "John",
      • "newValue": "Johnatan"
      },
    • "changeSource": {
      • "completedBy": "Admin",
      • "accessDateTime": "2024-11-01T14:44:11Z",
      • "actionPerformed": "modify",
      • "workflowAction": "4",
      • "clientIPAddress": "10.226.2.89",
      • "source": "userInterface"
      },
    • "notes": "NAME:a_vendor_name | VENDORID:a_vendor_id",
    • "href": "/objects/company-config/audit-history/MzEwMDEwMDEwNjM5NDYtMTAzOjktRElTUExBWUNPTlRBQ1QuTEFTVE5BTUU"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}