VersaCloud API ′QueryDocumentationGet′ Reference Documentation

Description

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

Parameters

The following table describes all of 'QueryDocumentationGet''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: 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 whose description is to be obtained

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

ID: 5 - Name: LanguageCode

Language: English (United States)

Description: Specific human language to be used to retrieve the query'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

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 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 cuya descripción desea obtener

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

ID: 5 - Name: LanguageCode

Language: Español (moderno)

Description: Idioma humano a ser utilizado para obtener la descripción de la consulta

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

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 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 cuja descrição deseja obter

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

ID: 5 - Name: LanguageCode

Language: Português (Brasil)

Description: Idioma humano a ser usado para recuperar a descrição da consulta

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

---

Return Value

'QueryDocumentationGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 256 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 'QueryDocumentationGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested