dls.documentRetentionRules

dls.documentRetentionRules(
   uri as String
) as Sequence

Summary

This function returns a sequence of dls:retentionRule element nodes. This allows users to determine why a version of a document is being retained.

Parameters
uri	The URI of the document. The URI must identify a numbered version of a managed document or an error is thrown.

Required Privileges

The dls-user role is required to run this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user

Example

  // Returns all of the retention rules that apply to the 'baz.xml' document.

  const dls = require('/MarkLogic/dls');

  dls.documentRetentionRules('/foo/bar/baz.xml');