Home Page
English (1.167)
VersaCloud (1.163)
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 |
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 |
48-48 |
No |
No |
|
2 |
QueryType |
English (United States) |
Query category (e.g. Audit or Enum) |
4-24 |
No |
No |
|
3 |
SolutionToken |
English (United States) |
Token of solution the query is part |
128-128 |
No |
No |
|
4 |
Name |
English (United States) |
Name of query whose description is to be defined |
3-64 |
No |
No |
|
5 |
LanguageCode |
English (United States) |
Specific human language the description being defined corresponds to |
6-6 |
No |
No |
|
6 |
Description |
English (United States) |
New value to be used as query's documentation in specified language |
1-256 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow |
48-48 |
No |
No |
|
2 |
QueryType |
Español (moderno) |
Categoría de consulta (p.ex. Auditoría o Enumeración) |
4-24 |
No |
No |
|
3 |
SolutionToken |
Español (moderno) |
Token de la solución a la cual la consulta pertenece |
128-128 |
No |
No |
|
4 |
Name |
Español (moderno) |
Nombre de la consulta cuya descripción desea definir |
3-64 |
No |
No |
|
5 |
LanguageCode |
Español (moderno) |
Idioma humano al cual corresponde la descripción de la consulta siendo definida |
6-6 |
No |
No |
|
6 |
Description |
Español (moderno) |
Nuevo valor a ser utilizado como documentación de la consulta en el idioma especificado |
1-256 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow |
48-48 |
No |
No |
|
2 |
QueryType |
Português (Brasil) |
Categoria de consulta (p.ex. Auditoria ou Enumeração) |
4-24 |
No |
No |
|
3 |
SolutionToken |
Português (Brasil) |
Token da solução à qual a consulta pertence |
128-128 |
No |
No |
|
4 |
Name |
Português (Brasil) |
Nome da consulta cuja descrição deseja definir |
3-64 |
No |
No |
|
5 |
LanguageCode |
Português (Brasil) |
Idioma humano ao qual corresponde a descrição da consulta sendo definida |
6-6 |
No |
No |
|
6 |
Description |
Português (Brasil) |
Novo valor a ser usado como documentação da consulta no idioma especificado |
1-256 |
No |
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
