dms.AddStoredQuery

This job creates a new stored query. The query must be passed in DMS Query format. The query is converted to the internal format for stored queries. Since the stored query format only allows a subset of DMS Query request possibilities, there are certain limitations. See dms.ConvertQuery.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	Flags must be 0
`Name`	STRING	Yes	Name of the query
`Query`	BASE64	Yes	Request in DMSQuery XML format
`[TreeParent]`	INT	No	ID of the desktop folder where the query is located
`[Scope]`	STRING	No	Scope. Allowed values: 'Public' for public queries, 'Private' for user-specific queries. Default is 'private'.
`[IconID]`	INT	No	ID of an icon that is displayed in the client. Default=0
`[DefAction]`	INT	No	Action to be performed when opening the stored query. `0` = Execute (Default), `1` = Edit, `2` = Count hits

Flags

INT

Yes

Flags must be 0

Name

STRING

Yes

Name of the query

Query

BASE64

Yes

Request in DMSQuery XML format

[TreeParent]

INT

ID of the desktop folder where the query is located

[Scope]

STRING

Scope. Allowed values: 'Public' for public queries, 'Private' for user-specific queries. Default is 'private'.

[IconID]

INT

ID of an icon that is displayed in the client. Default=0

[DefAction]

INT

Action to be performed when opening the stored query.
0 = Execute (Default), 1 = Edit, 2 = Count hits

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`QueryID`	INT	—	ID of the query

QueryID

INT

—

ID of the query

3. Return Value

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