dms.ConvertQuery

This job allows conversion between various request formats.

The following formats are supported:

  • DMS — DMSQuery XML format

  • STQ — Format for stored queries

  • ABN — Format for subscriptions

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Flags must be 0

OutputUnicode

INT

Yes

Must be 1

Query

STRING or BASE64

Yes

Request text

InputFormat

STRING

Yes

Input format: DMS, STQ or ABN

OutputFormat

STRING

Yes

Output format: DMS, STQ or ABN

[Name]

STRING

No

Name of the request (only for OutputFormat STQ)

[QueryID]

INT

No

ID of the request (only for OutputFormat STQ)

[IconID]

INT

No

ID of an icon that is displayed in the client. Default 0 (only for OutputFormat STQ)

[DefAction]

INT

No

Action when opening the stored query (only for OutputFormat STQ).
0 = Execute (Default), 1 = Edit, 2 = Count hits

[GarbageMode]

INT

No

1 = Consider objects from the trash can, 0 = do not consider (Default, only for OutputFormat ABN)

2. Output Parameters

Name Type Dependency Description

Query

BASE64

OutputFormat DMS

Request text in DMSQuery XML format (UTF-8 encoded)

sQuery

STRING

OutputFormat STQ / ABN

Request text in target format (ANSI encoded)

3. Return Value

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

Since the request possibilities of the DMSQuery XML format exceed those of the other formats, the following limitations apply for the DMSQuery XML format as input format:

  • Hierarchical structures are not supported (<ParentObjects>, <ChildObjects>, <ExternalObjects> are ignored).

  • Parameter names must have the format $VARnnn$ or $STATnnn$ (nnn = 000–999).

  • Field groups within conditions cannot be used.

  • Only one value can be specified for each condition.

  • Conditions for base parameters and system fields cannot be formulated.

  • Stored queries (STQ) in expert mode cannot be converted.