Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'SolutionUpgradeURLGet' Reference Documentation
Description
The following table displays the documentation for the 'SolutionUpgradeURLGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves the URL defining the new version of a specific solution |
Español (moderno) |
Recupera la URL que define la nueva versión de una solución específica |
Português (Brasil) |
Recupera a URL que define a nova versão de uma solução específica |
Parameters
The following table describes all of 'SolutionUpgradeURLGet''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 |
SolutionToken |
English (United States) |
Valid solution token identifying the solution to be queried regarding the URL where users will get new solution's executable code |
128-128 |
No |
No |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que recibirá la información |
48-48 |
No |
No |
|
2 |
SolutionToken |
Español (moderno) |
Token de Solución válido identificando la solución para la cual desea obtener el URL para descargar el código de la nueva versión de la solución |
128-128 |
No |
No |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando usuário que receberá a informação |
48-48 |
No |
No |
|
2 |
SolutionToken |
Português (Brasil) |
Token de Solução válido identificando a solução da qual deseja obter a URL para download do código da nova versão da solução |
128-128 |
No |
No |
Return Value
'SolutionUpgradeURLGet' returns a value of type URL (minimum length of returned values is 15 characters 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 'SolutionUpgradeURLGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Sol0000005 |
English (United States) |
Token type must be either M (for 'master'), C (for 'clone'),Q (for 'query') |
:@Err#Sol0000021 |
English (United States) |
This solution's upgrade process, including a decayment period, a target solution and an optional URL, has not yet been defined (use SolutionUpgradeAllow/Commit to define it) |
:@Err#Sol0000005 |
Español (moderno) |
Tipo de token es obligatoriamente M (para 'máster'), C (para 'clon'), Q (para 'query') o B ('back-end') |
:@Err#Sol0000021 |
Español (moderno) |
El proceso de actualización de esta solución, incluyendo el período de decaimiento, una solución destino y un URL opcional, aún no ha sido definido (use SolutionUpgradeAllow/Commit para definirlo) |
:@Err#Sol0000005 |
Português (Brasil) |
Tipo de token obrigatoriamente é M (para 'master'), C (para 'clone'), Q (para 'query') ou B ('back-end') |
:@Err#Sol0000021 |
Português (Brasil) |
O processo de atualização desta solução, incluindo um período de decaimento, uma solução alvo e uma URL opcional, ainda não foi definido (use SolutionUpgradeAllow/Commit para defini-lo) |
US Patent Requested
