Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'QueryParameterRemoveAllow' Reference Documentation
Description
The following table displays the documentation for the 'QueryParameterRemoveAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests for removal of an existing query parameter |
Español (moderno) |
Solicita la eliminación de un parámetro ya existente de una consulta |
Português (Brasil) |
Solicita a exclusão de um parâmetro já existente de uma consulta |
Parameters
The following table describes all of 'QueryParameterRemoveAllow''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 responsible 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 |
QueryName |
English (United States) |
Name of (new or existing) query |
3-64 |
No |
No |
|
5 |
ParameterName |
English (United States) |
Name of Parameter to be removed |
1-16 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario responsable por la eliminación |
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 |
QueryName |
Español (moderno) |
Nombre de la consulta (nueva o existente) |
3-64 |
No |
No |
|
5 |
ParameterName |
Español (moderno) |
Nombre del parámetro a ser eliminado |
1-16 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuários responsável pela remoção |
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 |
QueryName |
Português (Brasil) |
Nome da consulta (nova ou existente) |
3-64 |
No |
No |
|
5 |
ParameterName |
Português (Brasil) |
Nome do parâmetro a ser removido |
1-16 |
No |
No |
Return Value
'QueryParameterRemoveAllow' 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 'QueryParameterRemoveAllow' 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#Qry0000018 |
English (United States) |
Specified name has not been defined as the name of a parameter for this query |
:@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#Qry0000018 |
Español (moderno) |
El nombre indicado no ha sido definido como nombre del parámetro para esta 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#Qry0000002 |
Português (Brasil) |
Não existe nenhuma consulta com esse nome associada à solução especificada |
:@Err#Qry0000018 |
Português (Brasil) |
O nome indicado não foi definido como nome de parâmetro para esta 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
