AuditHistory
Retrieve complete audit history for a single document or for a single object record.
View Specific Information
Either the DocumentId column or the ObjectName and ObjectRecordId columns must be specified in order to query this view.
The add-in will use the Vault CRM API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the add-in.
- DocumentId supports the '=' operator.
- ObjectName supports the '=' operator.
- ObjectRecordId supports the '=' operator.
- StartDate supports the '=' operator.
- EndDate supports the '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM AuditHistory WHERE DocumentId = '8' SELECT * FROM AuditHistory WHERE ObjectName = 'product__v' AND ObjectRecordId = '00P000000000601' SELECT * FROM AuditHistory WHERE DocumentId = '3258' AND StartDate = '2020-01-01T01:13:36' AND EndDate = '2020-01-06T01:3:32'
Columns
| Name | Type | Description |
| DocumentId | String | Identifier of the document. |
| ObjectName | String | The object Name. |
| ObjectRecordId | String | Identifier of the object record. |
| Id [KEY] | String | Identifier of the audit record. |
| Timestamp | Datetime | The time and date of the preformed action. |
| UserName | String | The name of the user responsible for the preformed action. |
| FullName | String | The full name of the user responsible for the preformed action. |
| Action | String | The name of the action performed on the object record or on the document. |
| Item | String | The type and name of the affected record or the number field value of the affected Document. |
| FieldName | String | The name of the affected field. |
| OldValue | String | The previous field value before the executed action. |
| OnBehalfOf | String | If the action completed by the user represents a different user, this field displays the name of the delegating user. |
| NewValue | String | The actual field value after the executed action. |
| ObjectLabel | String | The label of the affected object. |
| MigrationMode | Bool | Indicates that the object record was created using the X-VaultAPI-MigrationMode header with a specified state__v value. |
| WorkflowName | String | The name of the workflow that preformed the action. |
| TaskName | String | The name of the preformed workflow task. |
| Verdict | String | The verdict of the workflow task action. |
| Reason | String | The reason of the workflow task action verdict. |
| Capacity | String | The approval capacity of the workflow that preformed the action. |
| SignatureMeaning | String | The reason a signature was required for any manifested signature. |
| ViewLicense | String | Returns a value of View-Based User only when the user is assigned that license type. Otherwise, returns an empty string. |
| JobInstanceId | String | The Id of the Job Instance that preformed the action. |
| Version | String | The version of the affected Document. |
| DocumentUrl | String | The URL of the affected Document. |
| EventDescription | String | Description of the action that occurred. |
Pseudo-Columns
Pseudo-column fields are used in the WHERE clause of SELECT statements and offer more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| StartDate | Datetime | Specify a start date to retrieve audit history. This date cannot be more than 30 days ago. If not stated, defaults to the vault's creation date. |
| EndDate | Datetime | Specify an end date to retrieve audit history. This date cannot be more than 30 days ago. If not stated, defaults to today's date. |