Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'QueryAllow' Reference Documentation
Description
The following table displays the documentation for the 'QueryAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Operation handle returned from VersaCloudEnumAllow |
Español (moderno) |
Operación identificador devuelto desde VersaCloudEnumAllow |
Português (Brasil) |
Operação identificador retornado de VersaCloudEnumAllow |
Parameters
The following table describes all of 'QueryAllow''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) to be run |
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 be run |
3-64 |
No |
No |
|
5 |
minCount |
English (United States) |
Minimum number of values to be returned through QueryNext for this transaction |
1-11 |
No |
Yes |
|
6 |
maxCount |
English (United States) |
Maximum number of values to be returned through QueryNext for this transaction |
1-11 |
No |
Yes |
|
7 |
Cost |
English (United States) |
Amount to be charged (if zero or null, will use query's default cost) |
1-11 |
No |
Yes |
|
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) a ser ejecutada |
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 a ser ejecutada |
3-64 |
No |
No |
|
5 |
minCount |
Español (moderno) |
Número mínimo de valores a ser retornado por QueryNext para esta transação |
1-11 |
No |
Yes |
|
6 |
maxCount |
Español (moderno) |
Número máximo de valores a ser retornado por QueryNext para esta transação |
1-11 |
No |
Yes |
|
7 |
Cost |
Español (moderno) |
Valor a ser debitado (si cero o nulo, es utilizado el costo standard de la consulta) |
1-11 |
No |
Yes |
|
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) a ser executada |
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 a ser executada |
3-64 |
No |
No |
|
5 |
minCount |
Português (Brasil) |
Número mínimo de valores a ser devolvido por QueryNext para esta transacción |
1-11 |
No |
Yes |
|
6 |
maxCount |
Português (Brasil) |
Número máximo de valores a ser devolvido por QueryNext para esta transacción |
1-11 |
No |
Yes |
|
7 |
Cost |
Português (Brasil) |
Quantia a ser debitada (se zero ou nula, é usado o custo padrão da consulta) |
1-11 |
No |
Yes |
Return Value
'QueryAllow' 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 'QueryAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Bal0000000 |
English (United States) |
User's current balance is insufficient to run this call |
:@Err#Qry0000002 |
English (United States) |
There is no query with that name associated to the specified solution |
:@Err#Qry0000009 |
English (United States) |
The minimum result size requested cannot be smaller than the query's minimum result size (which can be obtained through QueryInfoGet to request the 'minSetCount' value) |
:@Err#Qry0000010 |
English (United States) |
The maximum result size requested cannot be bigger than the query's maximum result size (which can be obtained through QueryInfoGet to request the 'maxSetCount' value) |
:@Err#Qry0000013 |
English (United States) |
The maximum result size requested cannot be smaller than the minimum result size request |
:@Err#Qry0000024 |
English (United States) |
Only 'Query' type solution tokens can be used to call Query... APIs |
:@Err#Qry0000057 |
English (United States) |
This query cannot be called before its initial valid date/time |
:@Err#Qry0000058 |
English (United States) |
This query cannot be called after its final valid date/time |
:@Err#Bal0000000 |
Español (moderno) |
Saldo actual del usuario no es suficiente para ejecutar esta llamada |
:@Err#Qry0000002 |
Español (moderno) |
No existe ninguna consulta con ese nombre asociada a la solución especificada |
:@Err#Qry0000009 |
Español (moderno) |
El tamaño mínimo de resultado solicitado no puede ser menor que el tamaño mínimo de resultado de la consulta (que puede ser obtenido mediante una llamada a QueryInfoGet para obtener el valor 'minSetCount') |
:@Err#Qry0000010 |
Español (moderno) |
El tamaño máximo de resultado solicitado no puede ser mayor que el tamaño máximo de resultado de la consulta (que puede ser obtenido mediante una llamada a QueryInfoGet para obtener el valor 'maxSetCount') |
:@Err#Qry0000013 |
Español (moderno) |
El tamaño máximo de resultado no puede ser menor que el tamaño mínimo de resultado solicitado |
:@Err#Qry0000024 |
Español (moderno) |
Solamente tokens de solución del tipo 'query' pueden ser utilizados en llamadas de APIs de nombre Query... |
:@Err#Qry0000057 |
Español (moderno) |
Esta consulta no puede ser llamada antes de su data/hora de validez inicial |
:@Err#Qry0000058 |
Español (moderno) |
Esta consulta no puede ser llamada después de su data/hora de validez final |
:@Err#Bal0000000 |
Português (Brasil) |
Saldo atual do usuário é insuficiente para executar esta chamada |
:@Err#Qry0000002 |
Português (Brasil) |
Não existe nenhuma consulta com esse nome associada à solução especificada |
:@Err#Qry0000009 |
Português (Brasil) |
O tamanho mínimo de resultado solicitado não pode ser menor do que o tamanho mínimo de resultado da consulta (que pode ser obtido mediante uma chamada a QueryInfoGet para obter o valor 'minSetCount') |
:@Err#Qry0000010 |
Português (Brasil) |
O tamanho máximo de resultado solicitado não pode ser maior que o tamanho máximo de resultado da consulta (que pode ser obtido mediante uma chamada a QueryInfoGet para obter o valor 'maxSetCount') |
:@Err#Qry0000013 |
Português (Brasil) |
O tamanho máximo de resultado não pode ser menor que o tamanho mínimo solicitado |
:@Err#Qry0000024 |
Português (Brasil) |
Somente tokens de solução de tipo 'query' podem ser usados nas chamadas das APIs Query... |
:@Err#Qry0000057 |
Português (Brasil) |
Esta consulta não pode ser chamada antes de sua data/hora de validade inicial |
:@Err#Qry0000058 |
Português (Brasil) |
Esta consulta não pode ser chamada depois de sua data/hora de validade final |
US Patent Requested
