Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetCaseHistory2

Scroll

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetCaseHistory2

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetCaseHistory2

Returns the history of the case.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetCaseHistory2

Element Name	Element Type	Restrictions	Description
■ parameters
■ CaseNo	xs:int	mandatory	Sets the number of the case 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/GetCaseHistory2Response

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.
□ CaseHistory		nillable	Gets the list of the case history entries.
≡ WSCaseHistoryEntry		list nillable
□ ActionDate	xs:dateTime	nillable	Gets the date and time the history entry was created.
■ EntryType		restriction enum (xs:string) - CaseCreatedCH (1) - DocumentAddedCH (2) - DocumentModifiedCH (3) - DocumentDeletedCH (4) - CaseClosed (5) - CaseHeaderChanged (6) - CaseReopened (7) - CaseExported (8) - CasePrinted (9) - CaseDeleted (10) - CaseRestored (11) - 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 type of the history entry.
■ ItemData	xs:int		Contains context sensitive data about the item that created this history entry.
■ ItemNo	xs:int		Gets the identifier of the item that created the history entry.
■ ParentItemNo	xs:int		Gets the identifier of the items parent where the history entry was created.
□ Text	xs:string	nillable	Gets the text for the history entry.
□ UserName	xs:string	nillable	Gets the user name of the user who caused the history entry.
■ UserNo	xs:int		Gets the Therefore™ user number of the user who caused the history entry.
□ ActionDateISO8601	xs:string	nillable	Gets the date and time the history entry was created (in ISO 8601 format, UTC).
□ AdditionalInfo	xs:string	nillable	Gets additional information depending on the history EntryType.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.