Description

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

Language

Documentation

English (United States)

Retrieves the description for a specific VersaCloud query

Español (moderno)

Recupera la descripción de una consulta VersaCloud específica

Português (Brasil)

Recupera a descrição de uma consulta VersaCloud específica

Parameters

The following table describes all of 'QueryDocumentationGet''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

operationhandle

48-48

No

No

2

QueryType

English (United States)

Query category (e.g. Audit or Enum)

queryType

4-24

No

No

3

SolutionToken

English (United States)

Token of solution the query is part

solutiontoken

128-128

No

No

4

Name

English (United States)

Name of query whose description is to be obtained

string

3-64

No

No

5

LanguageCode

English (United States)

Specific human language to be used to retrieve the query's description

language

6-6

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow

operationhandle

48-48

No

No

2

QueryType

Español (moderno)

Categoría de consulta (p.ex. Auditoría o Enumeración)

queryType

4-24

No

No

3

SolutionToken

Español (moderno)

Token de la solución a la cual la consulta pertenece

solutiontoken

128-128

No

No

4

Name

Español (moderno)

Nombre de la consulta cuya descripción desea obtener

string

3-64

No

No

5

LanguageCode

Español (moderno)

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

language

6-6

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow

operationhandle

48-48

No

No

2

QueryType

Português (Brasil)

Categoria de consulta (p.ex. Auditoria ou Enumeração)

queryType

4-24

No

No

3

SolutionToken

Português (Brasil)

Token da solução à qual a consulta pertence

solutiontoken

128-128

No

No

4

Name

Português (Brasil)

Nome da consulta cuja descrição deseja obter

string

3-64

No

No

5

LanguageCode

Português (Brasil)

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

language

6-6

No

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):

Errorcode

Language

Description

:@Err#Qry0000002

English (United States)

There is no query with that name associated to the specified solution

:@Err#Qry0000024

English (United States)

Only 'Query' type solution tokens can be used to call Query... APIs

:@Err#Qry0000243

English (United States)

Requested query documentation is not available in specified language

:@Err#Qry0000002

Español (moderno)

No existe ninguna consulta con ese nombre asociada a la solución especificada

:@Err#Qry0000024

Español (moderno)

Solamente tokens de solución del tipo 'query' pueden ser utilizados en llamadas de APIs de nombre Query...

:@Err#Qry0000243

Español (moderno)

Documentación requerida para la consulta no está disponible en el idioma solicitado

:@Err#Qry0000002

Português (Brasil)

Não existe nenhuma consulta com esse nome associada à solução especificada

:@Err#Qry0000024

Português (Brasil)

Somente tokens de solução de tipo 'query' podem ser usados nas chamadas das APIs Query...

:@Err#Qry0000243

Português (Brasil)

Documentação solicitada para a consulta não está disponível no idioma especificado

US Patent Requested