Api.queryArchive¶

queryArchive(queryArgs, rangeFrom, rangeUntil, page, pageSize, sortingColumn, sortingDirection)¶

Provides a list of documents within the archive.

This method executes asynchronously and returns a promise.

Note

Access to the archive is restricted and administrator or archive privileges are required in order to access archived content.

Arguments

queryArgs (object()) – Optional: A number of property/value pairs that represent different search filters that are applied to all documents within the archive. To pass the filter, all provided properties must match. Additional Filters lists the document properties which can be used as a filter. Default: {}.
rangeFrom (string()) – Optional: The earliest date when a document must have been scanned or created in order to pass the filter. The date is provided as a date string which can be constructed via ModelBase.encodeDate(). Default: null.
rangeUntil (string()) – Optional: The latest date at which a document must have been scanned or created in order to pass the filter. The date is provided as a date string which can be constructed via ModelBase.encodeDate(). Default: null.
page (int()) – Optional: Results from searching the archive may be paginated, in which case this argument specifies the page that is received (starting from 0). If the page number is out of range, the default page number of 0 is used.
pagesize (int()) – Optional: Results from searching the archive may be paginated, in which case this argument specifies the number of records that are retrieved per page. Default: 25.
sortingColumn (string()) – Optional: The name of the column by which the retrieved result is sorted. See Result Sorting for a list of possible columns. Default: DocumentSortingColumn.ScanDate.
sortingDirection (string()) – Optional: The direction by which the retrieved result is sorted, either SortingDirection.Ascending or SortingDirection.Descending.

Returns

For error responses, see Error Responses.

If successful, a list of documents within the archive.