Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDocumentHistoryService

Class for working with Document History

Hierarchy

  • IDocumentHistoryService

Index

Methods

Methods

getDocumentHistory

  • Retrieves all History for a Document

    Parameters

    • documentId: number

      Document Artifact ID of correlating Document History Data

    • Optional refreshCache: boolean

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

    • Optional startIndex: number

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

    • Optional pageSize: number

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

    • Optional rowCondition: string
    • Optional sorts: ISortIdentifier[]

      (optional) Array of sort identifier used for sorting.

    • Optional auditQueryOptions: IAuditQueryOptions

    Returns Promise<IAuditObjectManagerData>

    A promise with a response containing the items and response metadata

getDocumentHistorySlim

  • Retrieves all History for a Document

    Parameters

    • documentId: number

      Document Artifact ID of correlating Document History Data

    • Optional refreshCache: boolean

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

    • Optional startIndex: number

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

    • Optional pageSize: number

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

    • Optional rowCondition: string
    • Optional sorts: ISortIdentifier[]

      (optional) Array of sort identifier used for sorting.

    Returns Promise<IDocumentObjectManagerData>

    A promise with a response containing the items and response metadata