Operation to retrieve audittrails for a specific collection from one or more contributors
Audit trails are the log of what have transpired on a contributor on a per file basis. An audit trail describes who did what and at what time. For specific fields and their use see the protocol message format specification.
One or all files
Audit trails can be requested either for a single file or for all files in a collection.
Requesting Audit trails for all files in a collection may yeild a large set of results. Due to this the protocol supports a method of limiting which audit trails are listed, which can be used for implementing a paging mechanism.
Requested audit trails support (paging)
The requested audit trails can be filtered by timestamps and/or sequence numbers. Sequence numbers are unique within a pillar and incremental.
Limitations on delivered audit trails can be of:
- Minimum timestamp and/or sequence number
- Maximum timestamp and/or sequence number
- Maximum number of results
Contributors responding on a GetAuditTrails request should adhere to the following:
- The returned audit trails should be ordered oldest first.
- No more than the maximum number of results specified in the request should be delivered.
- If the contributor itself only allows for transmitting fewer results than specified in the request the component should keep to its own maximum.
- If the contributor has more audit trails than could be sent in the response, then the response should be marked as a PartialResult.
- If limitations by minimum or maximum timestamp or sequence number is present, the results should be inclusive.
- If a minimum limitation is in place, then first result should match the minimum limitation.
- If a maximum limitation is in place, then the last result should not be after the limitation. If the number of results is larger than the allowed maximum, the response should be marked as a PartialResult.