VersaCloud API ′QueryParameterRemoveAllow′ Reference Documentation

Description

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

Parameters

The following table describes all of 'QueryParameterRemoveAllow''s parameters, in every language available.

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying responsible 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: ParameterName

Language: English (United States)

Description: Name of Parameter to be removed

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

ID: 1 - Name: Login

Language: Español (moderno)

Description: Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario responsable por la eliminación

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: ParameterName

Language: Español (moderno)

Description: Nombre del parámetro a ser eliminado

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

ID: 1 - Name: Login

Language: Português (Brasil)

Description: Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuários responsável pela remoção

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: ParameterName

Language: Português (Brasil)

Description: Nome do parâmetro a ser removido

Type: string - Min-Max Length: 1-16 - Reentr Key Member: No - Optional: 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):

US Patent Requested