Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'QueryParameterDocumentationGet' Reference Documentation
Description
The following table displays the documentation for the 'QueryParameterDocumentationGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves a specific query parameter's description |
Español (moderno) |
Recupera la descripción de un parámetro específico de una consulta |
Português (Brasil) |
Recupera a descrição de um parâmetro específico de uma consulta |
Parameters
The following table describes all of 'QueryParameterDocumentationGet''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 |
QueryName |
English (United States) |
Name of query to get parameter documentation from |
3-256 |
No |
No |
|
5 |
ID |
English (United States) |
Parameter's ID |
1-2 |
No |
No |
|
6 |
LanguageCode |
English (United States) |
String containing the language code to use to retrieve the parameter's description |
6-6 |
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 |
QueryName |
Español (moderno) |
Nombre de la consulta de la cual desea obtener información de un parámetro |
3-256 |
No |
No |
|
5 |
ID |
Español (moderno) |
ID del parámetro |
1-2 |
No |
No |
|
6 |
LanguageCode |
Español (moderno) |
Secuencia de caracteres conteniendo el código de idioma a ser usado para obtener la descripción del parámetro |
6-6 |
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 |
QueryName |
Português (Brasil) |
Nome da consulta da qual deseja obter informação de um parâmetro |
3-256 |
No |
No |
|
5 |
ID |
Português (Brasil) |
ID do parâmetro |
1-2 |
No |
No |
|
6 |
LanguageCode |
Português (Brasil) |
Sequencia de caracteres contendo o código de idioma a ser usado para obter a descrição do parâmetro |
6-6 |
No |
No |
Return Value
'QueryParameterDocumentationGet' returns a value of type string (minimum length of returned values is 4 characters characters, while maximum length of returned values is 128 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 'QueryParameterDocumentationGet' 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#Qry0000018 |
English (United States) |
Specified name has not been defined as the name of a parameter for this query |
:@Err#Qry0000243 |
English (United States) |
Requested query documentation is not available in specified language |
:@Err#Sol0000006 |
English (United States) |
Solution Token is not valid |
:@Err#Qry0000002 |
Español (moderno) |
No existe ninguna consulta con ese nombre asociada a la solución especificada |
:@Err#Qry0000018 |
Español (moderno) |
El nombre indicado no ha sido definido como nombre del parámetro para esta consulta |
:@Err#Qry0000243 |
Español (moderno) |
Documentación requerida para la consulta no está disponible en el idioma solicitado |
:@Err#Sol0000006 |
Español (moderno) |
Token de solución no es válido |
:@Err#Qry0000002 |
Português (Brasil) |
Não existe nenhuma consulta com esse nome associada à solução especificada |
:@Err#Qry0000018 |
Português (Brasil) |
O nome indicado não foi definido como nome de parâmetro para esta consulta |
:@Err#Qry0000243 |
Português (Brasil) |
Documentação solicitada para a consulta não está disponível no idioma especificado |
:@Err#Sol0000006 |
Português (Brasil) |
Token de solução não é válido |
US Patent Requested
