Description

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

Language

Documentation

English (United States)

Verifies if a specific VersaCloud query can be called by users with a certain right (doesn't apply to anonymous queries)

Español (moderno)

Verifica si una consulta VersaCloud específica puede ser llamada por usuarios con un determinado derecho (no se aplica a consultas anónimas)

Português (Brasil)

Verifica se uma consulta VersaCloud específica pode ser chamada por usuários com um determinado direito (não se aplica a consultas anônimas)

Parameters

The following table describes all of 'QueryRightValid''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 query to be verified for a certain right

string

3-256

No

No

5

Right

English (United States)

Right to be verified

right

2-2

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario

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 a ser verificada por un cierto derecho

string

3-256

No

No

5

Right

Español (moderno)

Derecho a ser verificado

right

2-2

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário

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 a ser verificada por um certo direito

string

3-256

No

No

5

Right

Português (Brasil)

Direito a ser verificado

right

2-2

No

No

Return Value

'QueryRightValid' 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 'QueryRightValid' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode

Language

Description

:@Err#Qry0000002

English (United States)

There is no query with that name associated to the specified solution

:@Err#Qry0000024

English (United States)

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

:@Err#Qry0000002

Español (moderno)

No existe ninguna consulta con ese nombre asociada a la solución especificada

:@Err#Qry0000024

Español (moderno)

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

:@Err#Qry0000002

Português (Brasil)

Não existe nenhuma consulta com esse nome associada à solução especificada

:@Err#Qry0000024

Português (Brasil)

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

US Patent Requested