VersaCloud API ′QueryInfoGet′ Reference Documentation

Description

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

Parameters

The following table describes all of 'QueryInfoGet''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: Name

Language: English (United States)

Description: Name of query to get info from

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

ID: 5 - Name: queryInfo

Language: English (United States)

Description: Type of information about the query to be retrieved

Type: queryInfo - Min-Max Length: 4-11 - 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: Name

Language: Español (moderno)

Description: Nombre de la consulta de la cual desea obtener información

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

ID: 5 - Name: queryInfo

Language: Español (moderno)

Description: Tipo de información sobre la consulta a ser obtenida

Type: queryInfo - Min-Max Length: 4-11 - 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: Name

Language: Português (Brasil)

Description: Nome da consulta da qual deseja obter informação

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

ID: 5 - Name: queryInfo

Language: Português (Brasil)

Description: Tipo de informação sobre a consulta a ser obtida

Type: queryInfo - Min-Max Length: 4-11 - Reentr Key Member: No - Optional: 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):

US Patent Requested