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: 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 get parameter documentation from

Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: ID

Language: English (United States)

Description: Parameter's ID

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: LanguageCode

Language: English (United States)

Description: String containing the language code to use to retrieve the parameter's description

Type: language - Min-Max Length: 6-6 - 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 de la cual desea obtener información de un parámetro

Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: ID

Language: Español (moderno)

Description: ID del parámetro

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: LanguageCode

Language: Español (moderno)

Description: Secuencia de caracteres conteniendo el código de idioma a ser usado para obtener la descripción del parámetro

Type: language - Min-Max Length: 6-6 - 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 da qual deseja obter informação de um parâmetro

Type: string - Min-Max Length: 3-256 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: ID

Language: Português (Brasil)

Description: ID do parâmetro

Type: unsigned - Min-Max Length: 1-2 - Reentr Key Member: No - Optional: No

 

ID: 6 - Name: LanguageCode

Language: Português (Brasil)

Description: Sequencia de caracteres contendo o código de idioma a ser usado para obter a descrição do parâmetro

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: 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