dms.GetStoredQuery

This job returns stored queries in DMS query format. All object fields are included in the list of requested fields. The same output options apply as for dms.GetResultList.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Flags must be 0

QueryID

INT

Yes

ID of the query

[QueryMode]

INT

No

Sets the desired query behavior. Possible values are: Auto (-1) = Automatically use what is set in the query. Folder (0) = Folders are queried. Cabinet (1) = Cabinets are queried. Document (2) = Documents are queried. Unfiltered (-2) = Folders+Cabinets+Documents are returned. Default is "Unfiltered (-2)".

2. Output Parameters

Name Type Dependency Description

[Query]

BASE64

Optional

Query in DMSQuery XML format (UTF-8 encoded)

[ExpertMode]

INT

Optional

1, if the stored query is an expert query.

3. Return Value

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

Stored query:
[196608@0]
#OSACT#=1
#OSPOS001#=$STAT1$
[SYSTEM]
NAME=Stat1
IDENT=73706
VARREQUEST=1
DEFACTION=0

Converted query:

<DMSQuery requesttype="LOL" outputformat="LOL">
  <Params>
    <Param name="$STAT1$"/>
  </Params>
  <Archive internal_name="press_archive">
    <ObjectType internal_name="color_images" alias="Stat1">
      <Fields>
        <Field internal_name="date" system="0"/>
        <Field internal_name="author" system="0"/>
        <Field internal_name="source" system="0"/>
        <Field internal_name="content" system="0"/>
        <Field internal_name="viewable" system="0"/>
      </Fields>
      <Conditions>
        <ConditionObject internal_name="color_images">
          <FieldCondition internal_name="author" operator="="
            <ParamValue ref="$STAT1$"/>
          </FieldCondition>
        </ConditionObject>
      </Conditions>
    </ObjectType>
  </Archive>
</DMSQuery>