|
GetDocumentHistory2 |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetDocumentHistory2
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetDocumentHistory2
Returns the history of the specified Thereforeâ„¢ document.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetDocumentHistory2
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– DocNo |
xs:int |
mandatory |
Sets the number of the document to get history for. |
â–¡ LoadOlderThanUTCISO8601 |
xs:string |
nillable |
Load history entries that are older than the specified timestamp. The timestamp is in UTC. Only ISO 8601 format is accepted. |
â–¡ MaxEntries |
xs:int |
nillable |
Maximum entries to load for the history. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetDocumentHistory2Response
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– AllRowsLoaded |
xs:boolean |
|
Are all history entries loaded? If not, set LoadOlderThanUTC to the value of the last history entry and call again. |
â–¡ DocumentHistory |
|
nillable |
Gets the list of the document history entries. |
≡ WSDocumentHistoryEntry2 |
|
list nillable |
|
â–¡ AdditionalInfo |
xs:string |
nillable |
Gets additional information depending on the history entry type. |
â–¡ CreatedOnISO8601 |
xs:string |
nillable |
Gets the date and time the history entry was created in UTC (in ISO 8601 format, UTC). |
â– EntryType |
|
restriction enum (xs:string) - DocumentCreated (2) - DocumentEdited (3) - DocumentDeleted (4) - DocumentAddedToCase (100) - DocumentIndexDataChanged (101) - DocumentRemovedFromCase (102) - DocumentRestored (103) - DocumentPrinted (104) - DocumentExported (105) - DocumentCollaborationStarted (106) - DocumentCollaborationCompleted (107) - DocumentCollaborationAborted (108) - DocumentCollaborationLinkUsed (109) - DocumentShared (110) - DocumentSharedLinkRevoked (111) - DocumentSharedLinkEdited (112) - DocumentSharedLinkResolved (113) - DocumentRetrieved (114) - DocumentRetrievedViaPortal (115) |
Gets the history entry type. |
â–¡ UserName |
xs:string |
nillable |
Gets the user name of the user who caused the history entry. |
â– VersionNo |
xs:int |
|
Gets the document version number of the history entry. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |