Interface: IDocumentHistoryService

Class for working with Document History

Methods

getDocumentHistory()

getDocumentHistory(documentId, refreshCache?, startIndex?, pageSize?, rowCondition?, sorts?, auditQueryOptions?): Promise<IAuditObjectManagerData>

Retrieves all History for a Document

Parameters

• documentId: number

Document Artifact ID of correlating Document History Data

• refreshCache?: boolean

(optional) Whether or not to skip the cache and force retrieval from the API (Defaults to false)

• startIndex?: number

(optional) Current index in document history card. This is used for navigating between pages. Set to 1 if not passed in.

• pageSize?: number

(optional) Configured number of itemrs per page. If not passed in, it uses ItemListPageLength from user preferences.

• rowCondition?: string

• sorts?: ISortIdentifier[]

(optional) Array of sort identifier used for sorting.

• auditQueryOptions?: IAuditQueryOptions

Returns

Promise<IAuditObjectManagerData>

A promise with a response containing the items and response metadata

---

getDocumentHistorySlim()

getDocumentHistorySlim(documentId, refreshCache?, startIndex?, pageSize?, rowCondition?, sorts?): Promise<IDocumentObjectManagerData>

Retrieves all History for a Document

Parameters

• documentId: number

Document Artifact ID of correlating Document History Data

• refreshCache?: boolean

(optional) Whether or not to skip the cache and force retrieval from the API (Defaults to false)

• startIndex?: number

(optional) Current index in document history card. This is used for navigating between pages. Set to 1 if not passed in.

• pageSize?: number

(optional) Configured number of itemrs per page. If not passed in, it uses ItemListPageLength from user preferences.

• rowCondition?: string

• sorts?: ISortIdentifier[]

(optional) Array of sort identifier used for sorting.

Returns

Promise<IDocumentObjectManagerData>

A promise with a response containing the items and response metadata