Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'QueryInfoGet' Reference Documentation
Description
The following table displays the documentation for the 'QueryInfoGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a piece of information about a specific query |
Español (moderno) |
Obtiene un ítem de información sobre una consulta específica |
Português (Brasil) |
Recupera um item de informação sobre uma consulta específica |
Parameters
The following table describes all of 'QueryInfoGet''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 |
48-48 |
No |
No |
|
2 |
QueryType |
English (United States) |
Query category (e.g. Audit or Enum) |
4-24 |
No |
No |
|
3 |
SolutionToken |
English (United States) |
Query token of solution the query is part |
128-128 |
No |
No |
|
4 |
Name |
English (United States) |
Name of query to get info from |
3-64 |
No |
No |
|
5 |
queryInfo |
English (United States) |
Type of information about the query to be retrieved |
4-11 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario |
48-48 |
No |
No |
|
2 |
QueryType |
Español (moderno) |
Categoría de consulta (p.ex. Auditoría o Enumeración) |
4-24 |
No |
No |
|
3 |
SolutionToken |
Español (moderno) |
Token de consulta de la solución a la cual la consulta pertenece |
128-128 |
No |
No |
|
4 |
Name |
Español (moderno) |
Nombre de la consulta de la cual desea obtener información |
3-64 |
No |
No |
|
5 |
queryInfo |
Español (moderno) |
Tipo de información sobre la consulta a ser obtenida |
4-11 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário |
48-48 |
No |
No |
|
2 |
QueryType |
Português (Brasil) |
Categoria de consulta (p.ex. Auditoria ou Enumeração) |
4-24 |
No |
No |
|
3 |
SolutionToken |
Português (Brasil) |
Token de consulta da solução à qual a consulta pertence |
128-128 |
No |
No |
|
4 |
Name |
Português (Brasil) |
Nome da consulta da qual deseja obter informação |
3-64 |
No |
No |
|
5 |
queryInfo |
Português (Brasil) |
Tipo de informação sobre a consulta a ser obtida |
4-11 |
No |
No |
Return Value
'QueryInfoGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 24 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 'QueryInfoGet' 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#Qry0000023 |
English (United States) |
Requested query information has not been defined yet |
:@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#Qry0000023 |
Español (moderno) |
La información solicitada sobre la consulta todavía no está definida |
:@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#Qry0000023 |
Português (Brasil) |
A informação solicitada a respeito da consulta ainda não foi definida |
:@Err#Qry0000024 |
Português (Brasil) |
Somente tokens de solução de tipo 'query' podem ser usados nas chamadas das APIs Query... |
US Patent Requested
