Description

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

Language

Documentation

English (United States)

Verifies if a property has been defined for a specific solution on VersaCloud

Español (moderno)

Verifica si una propiedad ha sido definido para una solución específica en VersaCloud

Português (Brasil)

Verifica se a propriedade tiver sido definida para uma solução específica em VersaCloud

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

SolutionName

English (United States)

String containing the name of the solution the property belongs to

solution

8-32

No

No

2

PropertyCategoryName

English (United States)

String containing the property category the property to be checked belongs to

propertycategory

4-48

No

No

3

PropertyGroupName

English (United States)

String containing the property group the property to be checked belongs to

propertygroup

4-64

No

No

4

PropertyName

English (United States)

String to be verified if valid as the name of a property

string

4-80

No

No

1

SolutionName

Español (moderno)

Secuencia de carácteres conteniendo el nombre de la solución a la que pertenece la propriedad

solution

8-32

No

No

2

PropertyCategoryName

Español (moderno)

Secuencia de carácteres conteniendo el nombre de la categoría de propriedades a la cual la propriedad siendo validada debería pertenecer

propertycategory

4-48

No

No

3

PropertyGroupName

Español (moderno)

Secuencia de carácteres conteniendo el nombre del grupo de propriedades a la cual la propriedad siendo validada debería pertenecer

propertygroup

4-64

No

No

4

PropertyName

Español (moderno)

Secuencia de caracteres a ser verificada como siendo el nombre válido de una propriedad

string

4-80

No

No

1

SolutionName

Português (Brasil)

Sequencia de caracteres contendo o nome da solução à qual a propriedade pertence

solution

8-32

No

No

2

PropertyCategoryName

Português (Brasil)

Sequencia de caracteres contendo o nome da categoria de propriedades a qual a propriedade a ser verificada deveria pertencer

propertycategory

4-48

No

No

3

PropertyGroupName

Português (Brasil)

Sequencia de caracteres contendo o nome do grupo de propriedades a qual a propriedade a ser verificada deveria pertencer

propertygroup

4-64

No

No

4

PropertyName

Português (Brasil)

Sequencia de caracteres a ser verificada como sendo o nome válido de uma propriedade

string

4-80

No

No

Return Value

'PropertyValid' returns a value of type boolean (minimum length of returned values is 4 characters characters, while maximum length of returned values is 5 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 'PropertyValid' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode

Language

Description

US Patent Requested