VersaCloud API ′QueryDocumentationSetAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests to define a description for a specific VersaCloud query in a certain human language
Español (moderno)	Solicita la definición de la descripción de una consulta VersaCloud específica en un idioma humano determinado
Português (Brasil)	Solicita a definição da descrição de uma consulta VersaCloud específica num idioma humano determinado

Parameters

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

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 the description being defined corresponds to

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

 

ID: 6 - Name: Description

Language: English (United States)

Description: New value to be used as query's documentation in specified language

Type: string - Min-Max Length: 1-256 - 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 definir

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

 

ID: 5 - Name: LanguageCode

Language: Español (moderno)

Description: Idioma humano al cual corresponde la descripción de la consulta siendo definida

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

 

ID: 6 - Name: Description

Language: Español (moderno)

Description: Nuevo valor a ser utilizado como documentación de la consulta en el idioma especificado

Type: string - Min-Max Length: 1-256 - 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 definir

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

 

ID: 5 - Name: LanguageCode

Language: Português (Brasil)

Description: Idioma humano ao qual corresponde a descrição da consulta sendo definida

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

 

ID: 6 - Name: Description

Language: Português (Brasil)

Description: Novo valor a ser usado como documentação da consulta no idioma especificado

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

---

Return Value

'QueryDocumentationSetAllow' returns a value of type operationhandle (minimum length of returned values is 48 characters characters, while maximum length of returned values is 48 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 'QueryDocumentationSetAllow' 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#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#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...

US Patent Requested