VersaCloud API ′SolutionUpgradeAllow′ Reference Documentation

Description

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

Language	Documentation
English (United States)	Requests to upgrade all users of a specific solution to another one
Español (moderno)	Solicita que todos los usuarios de una solución específica sean migrados para otra solución
Português (Brasil)	Solicita que todos os usuários de uma solução específica sejam migrados para outra solução

Parameters

The following table describes all of 'SolutionUpgradeAllow''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: SolutionToken

Language: English (United States)

Description: Master token of solution whose users will be migrated

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

 

ID: 3 - Name: UpgradeStart

Language: English (United States)

Description: Solution users' migration start date

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Decayment

Language: English (United States)

Description: Solution's users' migration period (measured in days, maximum allowed 1825 days)

Type: unsigned - Min-Max Length: 1-4 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: TargetSolutionToken

Language: English (United States)

Description: Solution token (master or clone) identifying solution's users will have to migrate to

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

 

ID: 6 - Name: TargetURL

Language: English (United States)

Description: URL of new executable file (for download)

Type: url - Min-Max Length: 12-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, identificando al usuario que recibirá la información

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

 

ID: 2 - Name: SolutionToken

Language: Español (moderno)

Description: Token 'master' de la solución específica cuyos usuarios serán migrados

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

 

ID: 3 - Name: UpgradeStart

Language: Español (moderno)

Description: Fecha de inicio de la migración de los usuarios de la solución

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Decayment

Language: Español (moderno)

Description: Período de migración de los usuarios de la solución (medido en días, máximo permitido 1825 días)

Type: unsigned - Min-Max Length: 1-4 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: TargetSolutionToken

Language: Español (moderno)

Description: Token de la solución (principal o clon) identificando la solución para la cual los usuarios deberán migrar

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

 

ID: 6 - Name: TargetURL

Language: Español (moderno)

Description: URL de nuevo archivo binario (para descarga)

Type: url - Min-Max Length: 12-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, identificando usuário que receberá a informação

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

 

ID: 2 - Name: SolutionToken

Language: Português (Brasil)

Description: Token 'mestre' da solução cujos usuários serão migrados

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

 

ID: 3 - Name: UpgradeStart

Language: Português (Brasil)

Description: Data de início da migração dos usuários da solução

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

 

ID: 4 - Name: Decayment

Language: Português (Brasil)

Description: Período de migração dos usuários da solução (medido em dias, máximo permitido 1825 dias)

Type: unsigned - Min-Max Length: 1-4 - Reentr Key Member: No - Optional: No

 

ID: 5 - Name: TargetSolutionToken

Language: Português (Brasil)

Description: Token da solução (master ou clone) identificando a solução para a qual os usuários deverão migrar

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

 

ID: 6 - Name: TargetURL

Language: Português (Brasil)

Description: URL de novo arquivo executável (para download)

Type: url - Min-Max Length: 12-256 - Reentr Key Member: No - Optional: Yes

---

Return Value

'SolutionUpgradeAllow' 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 'SolutionUpgradeAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode	Language	Description
:@Err#Sol0000006	English (United States)	Solution Token is not valid
:@Err#Sol0000023	English (United States)	Solution upgrade process cannot be defined to start in the past
:@Err#Sol0000029	English (United States)	Solution's upgrade target cannot be the same as current solution neither the VersaCloud platform itself
:@Err#Sol0000006	Español (moderno)	Token de solución no es válido
:@Err#Sol0000023	Español (moderno)	Proceso de migración de la solución no puede ser definido para comenzar en el pasado
:@Err#Sol0000029	Español (moderno)	Destino de la actualización de la solución no puede ser la solución actual ni la propria plataforma VersaCloud
:@Err#Sol0000006	Português (Brasil)	Token de solução não é válido
:@Err#Sol0000023	Português (Brasil)	Processo de migração da solução não pode ser definido para iniciar no passado
:@Err#Sol0000029	Português (Brasil)	Destino da atualização da solução não pode ser a solução atual nem a própria plataforma VersaCloud

US Patent Requested