Description

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

Language

Documentation

English (United States)

Requests definition of a new property value to VersaCloud properties

Español (moderno)

Pide la definición de un nuevo valor de la propiedad a las propiedades VersaCloud

Português (Brasil)

Solicitações definição de um novo valor da propriedade para propriedades VersaCloud

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

SolutionToken

English (United States)

Token identifying solution the new property value will belong to (any token, whether master or clone, accepted)

solutiontoken

128-128

No

No

2

PropertyCategoryName

English (United States)

String containing the name of the property category the new value will be part of

propertycategory

4-48

Yes

No

3

PropertyGroupName

English (United States)

String containing the name of the property group the new value will be part of

propertygroup

4-64

Yes

No

4

PropertyName

English (United States)

String containing the name of the property the new value will be assigned to

property

4-80

Yes

No

5

LanguageCode

English (United States)

Language the new property value corresponds to

language

6-6

Yes

No

6

Value

English (United States)

New value to be assigned to the property specified by previous arguments

string

1-256

No

No

7

Since

English (United States)

Initial date from which the property will use this value (optional; if empty, current date/time will be used)

timestamp

10-24

No

Yes

8

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)

timestamp

10-24

No

Yes

1

SolutionToken

Español (moderno)

Token identificando la solución a la cual pertencerá el nuevo valor de propriedad (cualquier token, master o clon, puede ser utilizado)

solutiontoken

128-128

No

No

2

PropertyCategoryName

Español (moderno)

Secuencia de caracteres conteniendo el nombre de la categoría de propriedades de la cual el nuevo valor formará parte

propertycategory

4-48

Yes

No

3

PropertyGroupName

Español (moderno)

Secuencia de caracteres conteniendo el nombre del grupo de propriedades de la cual el nuevo valor formará parte

propertygroup

4-64

Yes

No

4

PropertyName

Español (moderno)

Secuencia de caracteres conteniendo el nombre de la propriedad a la cual el nuevo valor será atribuido

property

4-80

Yes

No

5

LanguageCode

Español (moderno)

Idioma al cual corresponde el nuevo valor de propriedad

language

6-6

Yes

No

6

Value

Español (moderno)

Nuevo valor a ser asignado a la propriedad especificada por los parámetros anteriores

string

1-256

No

No

7

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)

timestamp

10-24

No

Yes

8

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)

timestamp

10-24

No

Yes

1

SolutionToken

Português (Brasil)

Token identificando a solução à qual o novo valor de propriedade pertencerá (qualquer token, master ou clone, pode ser usado)

solutiontoken

128-128

No

No

2

PropertyCategoryName

Português (Brasil)

Sequencia de caracteres contendo o nome da categoria de propriedades da qual o novo valor será parte

propertycategory

4-48

Yes

No

3

PropertyGroupName

Português (Brasil)

Sequencia de caracteres contendo o nome do grupo de propriedades da qual o novo valor será parte

propertygroup

4-64

Yes

No

4

PropertyName

Português (Brasil)

Sequencia de caracteres contendo o nome da propriedade à qual o novo valor será atribuido

property

4-80

Yes

No

5

LanguageCode

Português (Brasil)

Idioma ao qual o novo valor de propriedade corresponde

language

6-6

Yes

No

6

Value

Português (Brasil)

Novo valor a ser atribuido à propriedade especificada pelos parâmetros anteriores

string

1-256

No

No

7

Since

Português (Brasil)

Data a partir da qual a propriedade usará o valor especificado (opcional; se omitida, a data/hora atual será assumida)

timestamp

10-24

No

Yes

8

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)

timestamp

10-24

No

Yes

Return Value

'PropertyValueSetAllow' 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 'PropertyValueSetAllow' 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#Sol0000008

English (United States)

Solution Token type must be either M ('master') or Q ('query')

:@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#Sol0000008

Español (moderno)

Tipo de token de solución tiene que ser M ('master') o Q ('query')

:@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#Sol0000008

Português (Brasil)

Tipo de token de solução tem que ser M ('master') ou Q ('query')

:@Err#Tim0000009

Português (Brasil)

O intervalo de tempo especificado não é correto

US Patent Requested