Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′QueryRightValid′ Reference Documentation
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: 1 - Name: Login
Language: English (United States)
Description: Operation handle returned from succesful call of UserLoginAllow, identifying user
Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No
ID: 2 - Name: QueryType
Language: English (United States)
Description: Query category (e.g. Audit or Enum)
Type: queryType - Min-Max Length: 4-24 - Reentr Key Member: No - Optional: No
ID: 3 - Name: SolutionToken
Language: English (United States)
Description: Query token of solution the query is part
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 4 - Name: QueryName
Language: English (United States)
Description: Name of query to be verified for a certain right
Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Right
Language: English (United States)
Description: Right to be verified
Type: right - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Login
Language: Español (moderno)
Description: Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario
Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No
ID: 2 - Name: QueryType
Language: Español (moderno)
Description: Categoría de consulta (p.ex. Auditoría o Enumeración)
Type: queryType - Min-Max Length: 4-24 - Reentr Key Member: No - Optional: No
ID: 3 - Name: SolutionToken
Language: Español (moderno)
Description: Token de consulta de la solución a la cual la consulta pertenece
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 4 - Name: QueryName
Language: Español (moderno)
Description: Nombre de la consulta a ser verificada por un cierto derecho
Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Right
Language: Español (moderno)
Description: Derecho a ser verificado
Type: right - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Login
Language: Português (Brasil)
Description: Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário
Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No
ID: 2 - Name: QueryType
Language: Português (Brasil)
Description: Categoria de consulta (p.ex. Auditoria ou Enumeração)
Type: queryType - Min-Max Length: 4-24 - Reentr Key Member: No - Optional: No
ID: 3 - Name: SolutionToken
Language: Português (Brasil)
Description: Token de consulta da solução à qual a consulta pertence
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 4 - Name: QueryName
Language: Português (Brasil)
Description: Nome da consulta a ser verificada por um certo direito
Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No
ID: 5 - Name: Right
Language: Português (Brasil)
Description: Direito a ser verificado
Type: right - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: 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
