When doing a API audit query request, the detail of the change can be found in different properties and in different format.
These format are not explain and seem to be missing in the documentation. We would like to developp custom audit report and would like to be able to display the change.
For exemple, when doing a PeoplePermissions on EntityType Role the details of the change seems to be in the property entity -> name with the format <-Agent ID->--<-RoleID->--<-Division ID->.
We would like to make sure that we understand correctly the format of the change (for each type of audit) and that it is not going to change overtime.
The serviceName, entityType, and action fields are defined in action catalog. These properties explain the action performed on an entity type in a service.
The 'entity' field points to the particular entity for which the audit was recorded. The service that submits the audit has control over it as the entity name is a free-form text.
The 'property changes' field captures the changes made to the attributes of an entity. It is a list that contains the change information. Again these values depend on the service that submits the audit. You can find the schema here GET /api/v2/audits/query/{transactionId}/results
I already had all the information you shared, I was looking for more documentation on how the value of the "entity" and "property change" fields are organized and can be interpreted. free-form text is not helping.
I understand that these values depend on the service requested in the audit query but the lack of documentatioon mean that for each service, we will have to do some reverse ingeneering to understand how to interpret these values.
Values going into those fields are arbitrary for many services. They may not follow a specific pattern and vary from service to service. We'll see to it and find a better way to document them.