Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'QueryInfoSetAllow' Reference Documentation
Description
The following table displays the documentation for the 'QueryInfoSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to modify a piece of information about a specific query |
Español (moderno) |
Solicita cambiar un ítem de información sobre una consulta específica |
Português (Brasil) |
Solicita modificar um item de informação sobre uma consulta específica |
Parameters
The following table describes all of 'QueryInfoSetAllow''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) |
Query token of solution the query is part |
128-128 |
No |
No |
|
4 |
Name |
English (United States) |
Name of query to have info set |
3-64 |
No |
No |
|
5 |
infoType |
English (United States) |
Type of query information to be modified |
4-11 |
No |
No |
|
6 |
Value |
English (United States) |
Value to be assigned as query's information |
1-24 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario |
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 consulta de la solución a la cual la consulta pertenece |
128-128 |
No |
No |
|
4 |
Name |
Español (moderno) |
Nombre de la consulta para la cual desea definir información |
3-64 |
No |
No |
|
5 |
infoType |
Español (moderno) |
Tipo de información de la consulta a ser modificada |
4-11 |
No |
No |
|
6 |
Value |
Español (moderno) |
Valor a ser asignado como información de la consulta |
1-24 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário |
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 de consulta da solução à qual a consulta pertence |
128-128 |
No |
No |
|
4 |
Name |
Português (Brasil) |
Nome da consulta para a qual deseja definir informação |
3-64 |
No |
No |
|
5 |
infoType |
Português (Brasil) |
Tipo de informação da consulta a ser modificada |
4-11 |
No |
No |
|
6 |
Value |
Português (Brasil) |
Valor a ser atribuído como informação da consulta |
1-24 |
No |
No |
Return Value
'QueryInfoSetAllow' 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 'QueryInfoSetAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Prm0600065 |
English (United States) |
Parameter #06: boolean value must be either 'True' or 'False' |
:@Err#Prm0600161 |
English (United States) |
Parameter #06: parameter value is not a valid timestamp (yyyy-mm-ddThh:mm:ss.mscZ) |
:@Err#Prm0600285 |
English (United States) |
Parameter #06: value to be used as huge non-signed integer cannot be stored in 64 bits |
:@Err#Qry0000002 |
English (United States) |
There is no query with that name associated to the specified solution |
:@Err#Qry0000004 |
English (United States) |
Query's Since datestamp cannot be defined to a value later than the current Until timestamp |
:@Err#Qry0000005 |
English (United States) |
Query's Until datestamp cannot be defined to a value earlier than the current Since timestamp |
:@Err#Qry0000006 |
English (United States) |
No Query transaction can have a TimeToLive value bigger than 24 hours |
:@Err#Qry0000007 |
English (United States) |
Query's minimum result size cannot be defined to be bigger than the current maximum result size |
:@Err#Qry0000008 |
English (United States) |
Query's maximum result size cannot be defined to be smaller than the current minimum result size |
:@Err#Qry0000024 |
English (United States) |
Only 'Query' type solution tokens can be used to call Query... APIs |
:@Err#Prm0600065 |
Español (moderno) |
Parámetro #06: valor booleano debe ser 'True' o 'False' |
:@Err#Prm0600161 |
Español (moderno) |
Parámetro #06: valor del parámetro no corresponde a un timestamp correcto (yyyy-mm-ddThh:mm:ss.mscZ) |
:@Err#Prm0600285 |
Español (moderno) |
Parámetro #06: valor informado no puede ser almacenado como número positivo de 64 bits |
:@Err#Qry0000002 |
Español (moderno) |
No existe ninguna consulta con ese nombre asociada a la solución especificada |
:@Err#Qry0000004 |
Español (moderno) |
El horario inicial de validez de la consulta no puede ser definido para un momento em el tiempo posterior a la fecha final de validez actual de la consulta |
:@Err#Qry0000005 |
Español (moderno) |
El horario final de validez de la consulta no puede ser definido para un momento em el tiempo anterior a la fecha inicial de validez actual de la consulta |
:@Err#Qry0000006 |
Español (moderno) |
Ninguna transacción de consulta puede tener um TimeToLive superior a 24 horas |
:@Err#Qry0000007 |
Español (moderno) |
El tamaño mínimo del resultado de la consulta no puede ser definido para un valor mayor que el tamaño máximo actual del resultado de la consulta |
:@Err#Qry0000008 |
Español (moderno) |
El tamaño máximo del resultado de la consulta no puede ser definido para un valor menor que el tamaño mínimo actual del resultado de la consulta |
:@Err#Qry0000024 |
Español (moderno) |
Solamente tokens de solución del tipo 'query' pueden ser utilizados en llamadas de APIs de nombre Query... |
:@Err#Prm0600065 |
Português (Brasil) |
Parâmetro #06: valor booleano deve ser 'True' ou 'False' |
:@Err#Prm0600161 |
Português (Brasil) |
Parâmetro #06: valor do parâmetro não corresponde a um timestamp correto (yyyy-mm-ddThh:mm:ss.mscZ) |
:@Err#Prm0600285 |
Português (Brasil) |
Parâmetro #06: valor informado não pode ser armazenado como número positivo de 64 bits |
:@Err#Qry0000002 |
Português (Brasil) |
Não existe nenhuma consulta com esse nome associada à solução especificada |
:@Err#Qry0000004 |
Português (Brasil) |
O horário inicial de validade da consulta não pode ser definido para um momento no tempo posterior à data final de validade atual da consulta |
:@Err#Qry0000005 |
Português (Brasil) |
O horário final de validade da consulta não pode ser definido para um momento no tempo anterior à data inicial de validade atual da consulta |
:@Err#Qry0000006 |
Português (Brasil) |
Nenhuma transação de consulta pode possuir um TimeToLive superior a 24 horas |
:@Err#Qry0000007 |
Português (Brasil) |
O tamanho mínimo do resultado da consulta não pode ser definido para um valor maior que o tamanho máximo atual do resultado da consulta |
:@Err#Qry0000008 |
Português (Brasil) |
O tamanho máximo do resultado da consulta não pode ser definido para um valor menor que o tamanho mínimo atual do resultado da consulta |
:@Err#Qry0000024 |
Português (Brasil) |
Somente tokens de solução de tipo 'query' podem ser usados nas chamadas das APIs Query... |
US Patent Requested
