Advanced audit histories

Advanced audit history provides detailed information about access to personal data stored in contact, customer, and vendor objects for compliance with data protection laws, such as HIPAA.

List advanced audit histories

get/objects/company-config/advanced-audit-history

Returns a collection with a key, ID, and link for each advanced 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:305:DISPLAYCONTACT.INITIAL:JohnDoe",
      • "href": "/objects/company-config/advanced-audit-history/OTA6MjgwOTU4"
      },
    • {
      • "key": "OTA6MjgwOTYz",
      • "id": "101:306::",
      • "href": "/objects/company-config/advanced-audit-history/OTA6MjgwOTYz"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an advanced audit history

get/objects/company-config/advanced-audit-history/{key}

Returns a collection with a key, ID, and link for each advanced audit history.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the advanced audit history.

Example: OTA6MjgwOTU4
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "MzEwMDEwMDEwNjM5NDYtMTAzOjk",
    • "id": "103:305:DISPLAYCONTACT.INITIAL:JohnDoe",
    • "accessDetails": {
      • "objectName": "accounts-receivable/customer",
      • "objectId": "CUST001"
      },
    • "accessSource": {
      • "completedBy": "Admin",
      • "accessDateTime": "2024-06-12T11:28:45Z",
      • "actionPerformed": "personalData",
      • "workflowAction": "2",
      • "clientIPAddress": "10.226.2.142",
      • "source": "userInterface"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}