Skip to main content

HistoryTransactional Changes

Schedule​

Tentatively scheduled for June 2026.

Overview​

To reduce data storage requirements and improve efficiency, we will be removing certain values from the HistoryTransactional records in our database. The values in these fields are currently not essential or are redundant, and their removal will help streamline our data while still retaining the necessary information for tracking changes.

The following fields will have their values removed and will be set to null in all HistoryTransactional records:

  • HistoryKey
  • ListingKey
  • MemberFullName
  • OriginatingSystemHistoryKey
  • OriginatingSystemId
  • OriginatingSystemName
  • ResourceOrdinal
  • SourceSystemHistoryKey
  • SourceSystemId
  • SourceSystemName

Migration​

To migrate your system to accommodate these changes, you should update any code that relies on the removed fields to use alternative fields or methods for retrieving the necessary information. Below are some recommendations for how to handle each of the removed fields:

HistoryKey​

This is an internal field that has no meaning outside of Amplify's internal systems. Use HistoryTransactionalKey instead, which is a unique identifier for each change record.

ListingKey​

For the Property resource, this field is redundant with ResourceRecordKey, which already contains the listing key.

For other resources (e.g. Media), use the resource's ResourceName and ResourceRecordKey to identify and retrieve the associated history records.

MemberFullName​

This field is redundant with ChangedByMemberKey, which can be used to look up the member's full name if needed. Removing MemberFullName will help reduce data storage while still allowing us to identify who made the change.

OriginatingSystemHistoryKey, OriginatingSystemId, OriginatingSystemName​

Amplify is not an aggregator and does not receive history records from other systems, so these fields are not applicable. All history records in our system originate from our own source, so we can safely remove these fields.

ResourceOrdinal​

This field is not currently used for any functionality in our system and does not provide meaningful information. Removing it will help simplify our data model.

SourceSystemHistoryKey, SourceSystemId, SourceSystemName​

Since all history records in our system originate from our own source, these fields are redundant and do not provide additional value. We can safely remove them to streamline our data.

Example​

Currently a typical HistoryTransactional record from Amplify's Web API looks like this:

{
  "ChangeType": "PriceChange",
  "ChangedByMemberKey": "1234567",
  "ClassName": "ResidentialCondo",
  "FieldKey": "MlsStatus",
  "FieldName": "MLS Status",
  "HistoryKey": "3769f401-b23c-4ccf-931f-a457780d3ac7",
  "HistoryStatus": "Public",
  "HistoryTransactionalKey": "51ab8559-30b0-4e3e-a525-f7145a56835a",
  "ListingKey": "A12345678",
  "MemberFullName": "JOHN SMITH (Salesperson)",
  "ModificationTimestamp": "2026-05-15T16:03:14Z",
  "NewLabel": "Price Change",
  "NewValue": "PriceChange",
  "OriginatingSystemHistoryKey": "51ab8559-30b0-4e3e-a525-f7145a56835a",
  "OriginatingSystemId": "rreb",
  "OriginatingSystemName": "Regional Real Estate Board",
  "PreviousLabel": "New",
  "PreviousValue": "New",
  "ResourceName": "Property",
  "ResourceOrdinal": null,
  "ResourceRecordKey": "A12345678",
  "SourceSystemHistoryKey": "51ab8559-30b0-4e3e-a525-f7145a56835a",
  "SourceSystemId": "rreb",
  "SourceSystemName": "rreb",
  "StratusWho": null,
  "SystemModificationTimestamp": "2026-05-15T16:03:14Z"
}

After the changes, the same HistoryTransactional record will look like this:

{
  "ChangeType": "PriceChange",
  "ChangedByMemberKey": "1234567",
  "ClassName": "ResidentialCondo",
  "FieldKey": "MlsStatus",
  "FieldName": "MLS Status",
  "HistoryKey": null,
  "HistoryStatus": "Public",
  "HistoryTransactionalKey": "51ab8559-30b0-4e3e-a525-f7145a56835a",
  "ListingKey": null,
  "MemberFullName": null,
  "ModificationTimestamp": "2026-05-15T16:03:14Z",
  "NewLabel": "Price Change",
  "NewValue": "PriceChange",
  "OriginatingSystemHistoryKey": null,
  "OriginatingSystemId": null,
  "OriginatingSystemName": null,
  "PreviousLabel": "New",
  "PreviousValue": "New",
  "ResourceName": "Property",
  "ResourceOrdinal": null,
  "ResourceRecordKey": "A12345678",
  "SourceSystemHistoryKey": null,
  "SourceSystemId": null,
  "SourceSystemName": null,
  "StratusWho": null,
  "SystemModificationTimestamp": "2026-05-15T16:03:14Z"
}