Description

The following table displays the documentation for the 'QueryAddAllow' API in all languages currently available:

Language

Documentation

English (United States)

Requests adding a new or modifying an existing VersaCloud query (parameters are replaced with new definitions)

Español (moderno)

Solicita añadir una nueva o modificar una consulta VersaCloud ya existente (parámetros sob substituidos pelas nuevas definiciones)

Português (Brasil)

Solicita adicionar uma nova ou modificar uma consulta VersaCloud já existente (parâmetros são substituídos pelas novas definições)

Parameters

The following table describes all of 'QueryAddAllow''s parameters, in every language available.

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Login

English (United States)

Operation handle returned from succesful call of UserLoginAllow, identifying user

operationhandle

48-48

No

No

2

QueryType

English (United States)

Query category (e.g. Audit or Enum)

queryType

4-24

No

No

3

SolutionToken

English (United States)

Query token of solution the query is part

solutiontoken

128-128

No

No

4

QueryName

English (United States)

Name of (new or existing) query

string

3-64

No

No

5

Result

English (United States)

Expression defining set of values to be returned one by one through QueryNext calls

string

1-256

No

No

6

Source

English (United States)

Expression defining set of internal tables used by query, called Source

string

1-256

No

No

7

Filter

English (United States)

Expression defining criteria to select query results

string

1-256

No

Yes

8

Grouping

English (United States)

Expression defining grouping of values returned by query

string

1-256

No

Yes

9

Has

English (United States)

Expression defining criteria to select grouped query results

string

1-256

No

Yes

10

Ordering

English (United States)

Expression defining ordering of values returned by query

string

1-256

No

Yes

11

ResultExt

English (United States)

Character string used to extend the Fields parameter, if necessary

string

1-256

No

Yes

12

SourceExt

English (United States)

Character string used to extend the Source parameter, if necessary

string

1-256

No

Yes

13

FilterExt

English (United States)

Character string used to extend the Filter parameter, if necessary

string

1-256

No

Yes

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow

operationhandle

48-48

No

No

2

QueryType

Español (moderno)

Categoría de consulta (p.ex. Auditoría o Enumeración)

queryType

4-24

No

No

3

SolutionToken

Español (moderno)

Token de consulta de la solución a la cual la consulta pertenece

solutiontoken

128-128

No

No

4

QueryName

Español (moderno)

Nombre de la consulta (nueva o existente)

string

3-64

No

No

5

Result

Español (moderno)

Expresión definiendo el conjunto de valores a ser generado uno a uno por llamadas a QueryNext

string

1-256

No

No

6

Source

Español (moderno)

Expresión definiendo el conjunto de tablas internas usadas por la consulta, denominada Source

string

1-256

No

No

7

Filter

Español (moderno)

Expresión definiendo criterios para seleccionar resultados de la consulta

string

1-256

No

Yes

8

Grouping

Español (moderno)

Expresión definiendo el agrupamiento de los resultados de la consulta

string

1-256

No

Yes

9

Has

Español (moderno)

Expresión definiendo criterios para seleccionar resultados agrupados de la consulta

string

1-256

No

Yes

10

Ordering

Español (moderno)

Expresión definiendo el orden de los resultados de la consulta

string

1-256

No

Yes

11

ResultExt

Español (moderno)

Secuencia de caracteres utilizada para extender el parámetro Fields, si necesário

string

1-256

No

Yes

12

SourceExt

Español (moderno)

Secuencia de caracteres utilizada para extender el parámetro Source, si necesário

string

1-256

No

Yes

13

FilterExt

Español (moderno)

Secuencia de caracteres utilizada para extender el parámetro Filter, si necesário

string

1-256

No

Yes

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow

operationhandle

48-48

No

No

2

QueryType

Português (Brasil)

Categoria de consulta (p.ex. Auditoria ou Enumeração)

queryType

4-24

No

No

3

SolutionToken

Português (Brasil)

Token de consulta da solução à qual a consulta pertence

solutiontoken

128-128

No

No

4

QueryName

Português (Brasil)

Nome da consulta (nova ou existente)

string

3-64

No

No

5

Result

Português (Brasil)

Expressão definindo o conjunto de valores a ser retornado um a um por chamadas a QueryNext

string

1-256

No

No

6

Source

Português (Brasil)

Expressão definindo o conjunto de tabelas internas usado pela consulta, denominada Source

string

1-256

No

No

7

Filter

Português (Brasil)

Expressão definindo critérios para selecionar resultados da consulta

string

1-256

No

Yes

8

Grouping

Português (Brasil)

Expressão definindo o agrupamento dos resultados da consulta

string

1-256

No

Yes

9

Has

Português (Brasil)

Expressão definindo critérios para selecionar resultados agrupados da consulta

string

1-256

No

Yes

10

Ordering

Português (Brasil)

Expressão definindo a ordenação dos resultados da consulta

string

1-256

No

Yes

11

ResultExt

Português (Brasil)

Sequencia de caracteres usada para estender o parâmetro Fields, se necessário

string

1-256

No

Yes

12

SourceExt

Português (Brasil)

Sequencia de caracteres usada para estender o parâmetro Source, se necessário

string

1-256

No

Yes

13

FilterExt

Português (Brasil)

Sequencia de caracteres usada para estender o parâmetro Filter, se necessário

string

1-256

No

Yes

Return Value

'QueryAddAllow' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 256 characters characters).

Please note that all APIs returning values of types that allow for localized values (like e.g. boolean or country) always return the standard type values.

Specific Error Codes

If an error happens during the execution of any VersaCloud call, an errorcode is returned instead of the standard return value described above.

The following table lists errorcodes returned specifically by the 'QueryAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode

Language

Description

:@Err#Qry0000024

English (United States)

Only 'Query' type solution tokens can be used to call Query... APIs

:@Err#Qry0000024

Español (moderno)

Solamente tokens de solución del tipo 'query' pueden ser utilizados en llamadas de APIs de nombre Query...

:@Err#Qry0000024

Português (Brasil)

Somente tokens de solução de tipo 'query' podem ser usados nas chamadas das APIs Query...

US Patent Requested