GET api/audit/logs?entityType={entityType}&entityId={entityId}

Retrieve Audit Logs for a specific entity. Processes this audit API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityType

The entity type value supplied with the request.

string

Required

entityId

The unique identifier of the entity resource.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of EntityAuditChangeDataContract
NameDescriptionTypeAdditional information
PartitionKey

The partition key value.

string

None.

RowKey

The row key value.

string

None.

Timestamp

The timestamp, expressed as a date and time.

date

None.

ChangedProperties

The changed properties value.

EntityAuditChangedPropertiesDataContract

None.

TransactionCommittedTime

The transaction committed time, expressed as a date and time.

date

None.

PersonName

The person name value.

string

None.

PersonId

The unique identifier of the related person resource.

integer

None.

ImpersonatedBy

The impersonated by value.

string

None.

DezrezTraceGuid

The dezrez trace guid globally unique identifier.

globally unique identifier

None.

UnitOfWorkSessionReference

The unit of work session reference globally unique identifier.

globally unique identifier

None.

JobHandlerName

The job handler name value.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PartitionKey": "sample string 1",
    "RowKey": "sample string 2",
    "Timestamp": "2026-07-23T08:13:38.2309969+00:00",
    "ChangedProperties": {
      "EntityState": "sample string 1",
      "EntityType": "sample string 2",
      "EntityName": "sample string 3",
      "EntityID": 4,
      "ChangedProperties": [
        {
          "OldValue": "sample string 1",
          "NewValue": "sample string 2",
          "NewSystemName": "sample string 3",
          "OldSystemName": "sample string 4",
          "OldId": 1,
          "NewId": 1,
          "PropertyName": "sample string 5",
          "PropertyType": "sample string 6",
          "AddedKeys": [
            1,
            2
          ],
          "RemovedKeys": [
            1,
            2
          ],
          "InnerType": "sample string 7"
        },
        {
          "OldValue": "sample string 1",
          "NewValue": "sample string 2",
          "NewSystemName": "sample string 3",
          "OldSystemName": "sample string 4",
          "OldId": 1,
          "NewId": 1,
          "PropertyName": "sample string 5",
          "PropertyType": "sample string 6",
          "AddedKeys": [
            1,
            2
          ],
          "RemovedKeys": [
            1,
            2
          ],
          "InnerType": "sample string 7"
        }
      ]
    },
    "TransactionCommittedTime": "2026-07-23T08:13:38.2309969Z",
    "PersonName": "sample string 5",
    "PersonId": 6,
    "ImpersonatedBy": "sample string 7",
    "DezrezTraceGuid": "5a451a4c-a504-4608-8c5e-d36d598cf0a6",
    "UnitOfWorkSessionReference": "6def8449-3e67-435b-88ae-abd11e6ce9cf",
    "JobHandlerName": "sample string 10"
  },
  {
    "PartitionKey": "sample string 1",
    "RowKey": "sample string 2",
    "Timestamp": "2026-07-23T08:13:38.2309969+00:00",
    "ChangedProperties": {
      "EntityState": "sample string 1",
      "EntityType": "sample string 2",
      "EntityName": "sample string 3",
      "EntityID": 4,
      "ChangedProperties": [
        {
          "OldValue": "sample string 1",
          "NewValue": "sample string 2",
          "NewSystemName": "sample string 3",
          "OldSystemName": "sample string 4",
          "OldId": 1,
          "NewId": 1,
          "PropertyName": "sample string 5",
          "PropertyType": "sample string 6",
          "AddedKeys": [
            1,
            2
          ],
          "RemovedKeys": [
            1,
            2
          ],
          "InnerType": "sample string 7"
        },
        {
          "OldValue": "sample string 1",
          "NewValue": "sample string 2",
          "NewSystemName": "sample string 3",
          "OldSystemName": "sample string 4",
          "OldId": 1,
          "NewId": 1,
          "PropertyName": "sample string 5",
          "PropertyType": "sample string 6",
          "AddedKeys": [
            1,
            2
          ],
          "RemovedKeys": [
            1,
            2
          ],
          "InnerType": "sample string 7"
        }
      ]
    },
    "TransactionCommittedTime": "2026-07-23T08:13:38.2309969Z",
    "PersonName": "sample string 5",
    "PersonId": 6,
    "ImpersonatedBy": "sample string 7",
    "DezrezTraceGuid": "5a451a4c-a504-4608-8c5e-d36d598cf0a6",
    "UnitOfWorkSessionReference": "6def8449-3e67-435b-88ae-abd11e6ce9cf",
    "JobHandlerName": "sample string 10"
  }
]