dms.ExecuteStoredQuery

This job executes stored queries. The result is returned in the DMS Content format.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Flags to control the output format
0x00000010 (16) = XML result is returned as a file, otherwise as a buffer
0x00001000 (4096) = XML result is encoded in UTF-8, otherwise UTF-16

QueryID

INT

Yes

ID of the query

[CheckParams]

INT

No

0 = If no value is defined for a request parameter, conditions that reference this parameter are ignored (Default).
1 = An error message is generated if a referenced parameter is not defined.
If it is a parametrized query, the query parameters must be passed as job parameters. The $ characters that surround the parameters in the query must be omitted (e.g. VAR1 or STAT3). The parameter QueryCatalogueLocale can be used to control in which language multilingual catalogs are passed as query parameters. Additionally, the following parameters can be set to format the returned XML document: RequestType, OutputFormat, BaseParams, Offset, Pagesize, MaxHits, Rights, DateFormat, Variants, FileInfo, Baseparams. The description of these parameters can be found in the description of the job dms.GetResultList.

2. Output Parameters

Name Type Dependency Description

Count

INT

—

Number of records returned

TotalHits

INT

—

Number of available hits

[XML]

BASE64

Optional

Hit list in DMSContent XML format (when Flags is not 0x00000010 (16))

3. Output Files

Name Description

[FileCount]

Only one file is always returned

[File list]

Name and path of the DMSContent XML file containing the hit list

4. Return Value

(INT): 0 = Job successful, otherwise error code
Complete error list