Description

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

Language

Documentation

English (United States)

Verifies if a specifed name corresponds to an available VersaCloud query

Español (moderno)

Verifica si un nombre specifed corresponde a uma consulta VersaCloud disponible

Português (Brasil)

Verifica se um nome specifed corresponde a uma consulta VersaCloud disponível

Parameters

The following table describes all of 'QueryValid''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)

Token of solution the query should be part

solutiontoken

128-128

No

No

4

Name

English (United States)

Name to be verified as a valid query name

string

3-64

No

No

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 la solución a la cual la consulta debería pertenecer

solutiontoken

128-128

No

No

4

Name

Español (moderno)

Nombre a ser verificado como válido para una consulta

string

3-64

No

No

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 da solução à qual a consulta deveria pertencer

solutiontoken

128-128

No

No

4

Name

Português (Brasil)

Nome a ser verificado como válido para uma consulta

string

3-64

No

No

Return Value

'QueryValid' returns a value of type boolean (minimum length of returned values is 4 characters characters, while maximum length of returned values is 5 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 'QueryValid' 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