Api.queryArchiveContainers

queryArchiveContainers(documentHolderName, scannedByUserId, rangeFrom, rangeUntil, page, pageSize, sortingDirection)

Provides a list of containers 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

  • documentHolderName (object()) – Optional: The name of the document holder of the application. A number of property/value pairs that represents different search filters that are applied against all documents within the archive of the system. All provided properties must match in order to pass the filter. Section Additional Filters provides an overview of all document properties by which a filter can be expressed. Default: {}.

  • rangeFrom (string()) – Optional: The minimum 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 maximum 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.

  • 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 is used. Default: 0.

  • 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.

  • sortingDirection (string()) – Optional: The direction by which the retrieved result is sorted, which is either SortingDirection.Ascending or SortingDirection.Descending. The result is always sorted by the date when the scan was created. See Class SortingDirection.

Returns

For error responses, see Error Responses.

If successful, a list of the containers in the archive.