list (Java class ItemListFile)

Retrieves a list of files from IDM given an xquery. Use this file type if several documents that have the same attributes must be emailed or printed.

Restrictions: An xquery can result in millions of documents returned. Document Output only includes documents to a total size of 10 MB.

Attribute name Value Type Description
type "xquery" string The file object type.
xquery Example: "/MDS_File[@MDS_name=\"FileName\"]" string The xquery.
merge  true/false Default value is false. boolean If set to true, all the files are assembled into one PDF. If set to true, you must also set the filename property.
filename Example: "MyAssembledFile.pdf"  string The name of the assembled output file. Ignored if merge=false

This is an example of this input type in JSon:

{
    "type": "list", 
    "xquery": "/MDS_GenericDocument["MyAttribute=\"someValue\"]", 
    "merge":true, 
    "filename": "MyAssambledFile.pdf"
}