VersaCloud API ′QueryAddAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests adding a new or modifying an existing VersaCloud query (parameters are replaced with new definitions)
Español (moderno)	Solicita añadir una nueva o modificar una consulta VersaCloud ya existente (parámetros sob substituidos pelas nuevas definiciones)
Português (Brasil)	Solicita adicionar uma nova ou modificar uma consulta VersaCloud já existente (parâmetros são substituídos pelas novas definições)

Parameters

The following table describes all of 'QueryAddAllow''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: Query token of solution the query is part

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: QueryName

Language: English (United States)

Description: Name of (new or existing) query

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

 

ID: 5 - Name: Result

Language: English (United States)

Description: Expression defining set of values to be returned one by one through QueryNext calls

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

 

ID: 6 - Name: Source

Language: English (United States)

Description: Expression defining set of internal tables used by query, called Source

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

 

ID: 7 - Name: Filter

Language: English (United States)

Description: Expression defining criteria to select query results

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

 

ID: 8 - Name: Grouping

Language: English (United States)

Description: Expression defining grouping of values returned by query

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

 

ID: 9 - Name: Has

Language: English (United States)

Description: Expression defining criteria to select grouped query results

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

 

ID: 10 - Name: Ordering

Language: English (United States)

Description: Expression defining ordering of values returned by query

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

 

ID: 11 - Name: ResultExt

Language: English (United States)

Description: Character string used to extend the Fields parameter, if necessary

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

 

ID: 12 - Name: SourceExt

Language: English (United States)

Description: Character string used to extend the Source parameter, if necessary

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

 

ID: 13 - Name: FilterExt

Language: English (United States)

Description: Character string used to extend the Filter parameter, if necessary

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

 

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 consulta 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: QueryName

Language: Español (moderno)

Description: Nombre de la consulta (nueva o existente)

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

 

ID: 5 - Name: Result

Language: Español (moderno)

Description: Expresión definiendo el conjunto de valores a ser generado uno a uno por llamadas a QueryNext

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

 

ID: 6 - Name: Source

Language: Español (moderno)

Description: Expresión definiendo el conjunto de tablas internas usadas por la consulta, denominada Source

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

 

ID: 7 - Name: Filter

Language: Español (moderno)

Description: Expresión definiendo criterios para seleccionar resultados de la consulta

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

 

ID: 8 - Name: Grouping

Language: Español (moderno)

Description: Expresión definiendo el agrupamiento de los resultados de la consulta

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

 

ID: 9 - Name: Has

Language: Español (moderno)

Description: Expresión definiendo criterios para seleccionar resultados agrupados de la consulta

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

 

ID: 10 - Name: Ordering

Language: Español (moderno)

Description: Expresión definiendo el orden de los resultados de la consulta

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

 

ID: 11 - Name: ResultExt

Language: Español (moderno)

Description: Secuencia de caracteres utilizada para extender el parámetro Fields, si necesário

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

 

ID: 12 - Name: SourceExt

Language: Español (moderno)

Description: Secuencia de caracteres utilizada para extender el parámetro Source, si necesário

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

 

ID: 13 - Name: FilterExt

Language: Español (moderno)

Description: Secuencia de caracteres utilizada para extender el parámetro Filter, si necesário

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

 

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 de consulta da solução à qual a consulta pertence

Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: QueryName

Language: Português (Brasil)

Description: Nome da consulta (nova ou existente)

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

 

ID: 5 - Name: Result

Language: Português (Brasil)

Description: Expressão definindo o conjunto de valores a ser retornado um a um por chamadas a QueryNext

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

 

ID: 6 - Name: Source

Language: Português (Brasil)

Description: Expressão definindo o conjunto de tabelas internas usado pela consulta, denominada Source

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

 

ID: 7 - Name: Filter

Language: Português (Brasil)

Description: Expressão definindo critérios para selecionar resultados da consulta

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

 

ID: 8 - Name: Grouping

Language: Português (Brasil)

Description: Expressão definindo o agrupamento dos resultados da consulta

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

 

ID: 9 - Name: Has

Language: Português (Brasil)

Description: Expressão definindo critérios para selecionar resultados agrupados da consulta

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

 

ID: 10 - Name: Ordering

Language: Português (Brasil)

Description: Expressão definindo a ordenação dos resultados da consulta

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

 

ID: 11 - Name: ResultExt

Language: Português (Brasil)

Description: Sequencia de caracteres usada para estender o parâmetro Fields, se necessário

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

 

ID: 12 - Name: SourceExt

Language: Português (Brasil)

Description: Sequencia de caracteres usada para estender o parâmetro Source, se necessário

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

 

ID: 13 - Name: FilterExt

Language: Português (Brasil)

Description: Sequencia de caracteres usada para estender o parâmetro Filter, se necessário

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

---

Return Value

'QueryAddAllow' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 256 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 'QueryAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode	Language	Description
:@Err#Qry0000024	English (United States)	Only 'Query' type solution tokens can be used to call Query... APIs
:@Err#Qry0000024	Español (moderno)	Solamente tokens de solución del tipo 'query' pueden ser utilizados en llamadas de APIs de nombre Query...
:@Err#Qry0000024	Português (Brasil)	Somente tokens de solução de tipo 'query' podem ser usados nas chamadas das APIs Query...

US Patent Requested