Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'PropertyValuePerUserSetAllow' Reference Documentation
Description
The following table displays the documentation for the 'PropertyValuePerUserSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests storage of a property value for a specific VersaCloud user |
Español (moderno) |
Pide almacenamiento de un valor de la propiedad para un usuario específico VersaCloud |
Português (Brasil) |
Solicitações de armazenamento de um valor de propriedade de um usuário específico VersaCloud |
Parameters
The following table describes all of 'PropertyValuePerUserSetAllow''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 |
48-48 |
No |
No |
|
2 |
SolutionName |
English (United States) |
String containing the solution's name to have a new property type added |
8-32 |
Yes |
No |
|
3 |
PropertyCategoryName |
English (United States) |
String containing the name of the property category the new value will be part of |
4-48 |
Yes |
No |
|
4 |
PropertyGroupName |
English (United States) |
String containing the name of the property group the new value will be part of |
4-64 |
Yes |
No |
|
5 |
PropertyName |
English (United States) |
String containing the name of the property the new value will be assigned to |
4-80 |
Yes |
No |
|
6 |
LanguageCode |
English (United States) |
Language the new property value corresponds to |
6-6 |
Yes |
No |
|
7 |
Value |
English (United States) |
New value to be assigned to the property specified by previous arguments |
1-256 |
No |
No |
|
8 |
Since |
English (United States) |
Initial date from which the property will use this value (optional; if empty, current date/time will be used) |
10-24 |
No |
Yes |
|
9 |
Until |
English (United States) |
Final date until which the property will use this value (optional; if empty, '2399-12-31 23:59:59.987' will be used) |
10-24 |
No |
Yes |
|
1 |
Login |
Español (moderno) |
Protocolo de operación obtenido de llamada exitosa a UserLoginAllow |
48-48 |
No |
No |
|
2 |
SolutionName |
Español (moderno) |
Secuencia de caracteres identificando la solución a la cual pertencerá el nuevo valor de propriedad (cualquier token, master o clon, puede ser utilizado) |
8-32 |
Yes |
No |
|
3 |
PropertyCategoryName |
Español (moderno) |
Secuencia de caracteres conteniendo el nombre de la categoría de propriedades de la cual el nuevo valor formará parte |
4-48 |
Yes |
No |
|
4 |
PropertyGroupName |
Español (moderno) |
Secuencia de caracteres conteniendo el nombre del grupo de propriedades de la cual el nuevo valor formará parte |
4-64 |
Yes |
No |
|
5 |
PropertyName |
Español (moderno) |
Secuencia de caracteres conteniendo el nombre de la propriedad a la cual el nuevo valor será atribuido |
4-80 |
Yes |
No |
|
6 |
LanguageCode |
Español (moderno) |
Idioma al cual corresponde el nuevo valor de propriedad |
6-6 |
Yes |
No |
|
7 |
Value |
Español (moderno) |
Nuevo valor a ser asignado a la propriedad especificada por los parámetros anteriores |
1-256 |
No |
No |
|
8 |
Since |
Español (moderno) |
Fecha a partir de la cual la propriedad usará el valor especificado (opcional; si omitida, la fecha/hora actual será utilizada) |
10-24 |
No |
Yes |
|
9 |
Until |
Español (moderno) |
Fecha hasta la cual la propriedad usará el valor especificado (opcional; si omitida, '2399-12-31 23:59:59.987' será utilizada) |
10-24 |
No |
Yes |
|
1 |
Login |
Português (Brasil) |
Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow |
48-48 |
No |
No |
|
2 |
SolutionName |
Português (Brasil) |
Sequencia de caracteres identificando a solução à qual o novo valor de propriedade pertencerá (qualquer token, master ou clone, pode ser usado) |
8-32 |
Yes |
No |
|
3 |
PropertyCategoryName |
Português (Brasil) |
Sequencia de caracteres contendo o nome da categoria de propriedades da qual o novo valor será parte |
4-48 |
Yes |
No |
|
4 |
PropertyGroupName |
Português (Brasil) |
Sequencia de caracteres contendo o nome do grupo de propriedades da qual o novo valor será parte |
4-64 |
Yes |
No |
|
5 |
PropertyName |
Português (Brasil) |
Sequencia de caracteres contendo o nome da propriedade à qual o novo valor será atribuido |
4-80 |
Yes |
No |
|
6 |
LanguageCode |
Português (Brasil) |
Idioma ao qual o novo valor de propriedade corresponde |
6-6 |
Yes |
No |
|
7 |
Value |
Português (Brasil) |
Novo valor a ser atribuido à propriedade especificada pelos parâmetros anteriores |
1-256 |
No |
No |
|
8 |
Since |
Português (Brasil) |
Data a partir da qual a propriedade usará o valor especificado (opcional; se omitida, a data/hora atual será assumida) |
10-24 |
No |
Yes |
|
9 |
Until |
Português (Brasil) |
Data até a qual a propriedade usará o valor especificado (opcional; se omitida, '2399-12-31 23:59:59.987' será assumida) |
10-24 |
No |
Yes |
Return Value
'PropertyValuePerUserSetAllow' 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 'PropertyValuePerUserSetAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Prp0000016 |
English (United States) |
Value provided as property name hasn't been defined inside specified solution |
:@Err#Tim0000009 |
English (United States) |
Time interval specified is not correct |
:@Err#Prp0000016 |
Español (moderno) |
Valor informado como nombre de propriedad no ha sido definido en la solución especificada |
:@Err#Tim0000009 |
Español (moderno) |
El intervalo de tiempo especificado no es correcto |
:@Err#Prp0000016 |
Português (Brasil) |
Valor fornecido como nome de propriedade não foi definido na solução especificada |
:@Err#Tim0000009 |
Português (Brasil) |
O intervalo de tempo especificado não é correto |
US Patent Requested
