Difference between revisions of "History Object"

From EPrints Documentation
Jump to: navigation, search
m
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
 
<table border="1" cellspacing="0" cellpadding="2">
 
<table border="1" cellspacing="0" cellpadding="2">
 
<tr><th>Field Name</th><th>Type</th><th>Description</th></tr>
 
<tr><th>Field Name</th><th>Type</th><th>Description</th></tr>
<tr><td>historyid</td><td>[[int field]]</td><td></td></tr>
+
<tr><td>historyid</td><td>[[int field]]</td><td>The unique numerical ID of this history event.</td></tr>
<tr><td>userid</td><td>[[itemref field]] user</td><td></td></tr>
+
<tr><td>userid</td><td>[[itemref field]] user</td><td>The ID of the user who caused this event. A value of zero or undefined indicates that there was no user responsible (i.e. a script did it).</td></tr>
<tr><td>actor</td><td>[[text field]]</td><td></td></tr>
+
<tr><td>actor</td><td>[[text field]]</td><td>A text representation of the actor responsible for the action for this history event.</td></tr>
<tr><td>datasetid</td><td>[[text field]]</td><td></td></tr>
+
<tr><td>datasetid</td><td>[[text field]]</td><td>The name of the dataset to which the modified item belongs.</td></tr>
<tr><td>objectid</td><td>[[int field]]</td><td></td></tr>
+
<tr><td>objectid</td><td>[[int field]]</td><td>The numerical ID of the object in the dataset.</td></tr>
<tr><td>revision</td><td>[[int field]]</td><td></td></tr>
+
<tr><td>revision</td><td>[[int field]]</td><td>The revision of the object. This is the revision number after theaction occured.</td></tr>
<tr><td>timestamp</td><td>[[time field]]</td><td></td></tr>
+
<tr><td>timestamp</td><td>[[time field]]</td><td>The moment at which this event happened.</td></tr>
<tr><td>action</td><td>[[set field]]</td><td></td></tr>
+
<tr><td>action</td><td>[[set field]]</td><td>The type of event.</td></tr>
<tr><td>details</td><td>[[longtext field]]</td><td></td></tr>
+
<tr><td>details</td><td>[[longtext field]]</td><td>If this is a rejection, then the details contain the message sent to the user.</td></tr>
 
</table>
 
</table>
 +
 +
== See Also ==
 +
* [[API:EPrints/DataObj/History|EPrints::DataObj::History]] - API page

Latest revision as of 16:14, 18 February 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Data Objects: Access - Document - EPrint - Event Queue - File - History - Import - Login Ticket - Request - Saved Search - Subject - User


Built in Fields

Field NameTypeDescription
historyidint fieldThe unique numerical ID of this history event.
useriditemref field userThe ID of the user who caused this event. A value of zero or undefined indicates that there was no user responsible (i.e. a script did it).
actortext fieldA text representation of the actor responsible for the action for this history event.
datasetidtext fieldThe name of the dataset to which the modified item belongs.
objectidint fieldThe numerical ID of the object in the dataset.
revisionint fieldThe revision of the object. This is the revision number after theaction occured.
timestamptime fieldThe moment at which this event happened.
actionset fieldThe type of event.
detailslongtext fieldIf this is a rejection, then the details contain the message sent to the user.

See Also