Description

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

Language

Documentation

English (United States)

Requests the creation of a new property

Español (moderno)

Solicita la creación de una nueva propiedad

Português (Brasil)

Solicita a criação de uma nova propriedade

Parameters

The following table describes all of 'PropertyAddAllow''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 will belong to (master and clones are accepted)

solutiontoken

128-128

No

No

2

PropertyCategoryName

English (United States)

String containing the property category the new property will be added to

propertycategory

4-48

Yes

No

3

PropertyGroupName

English (United States)

String containing the property group the new property will be added to

propertygroup

4-64

Yes

No

4

PropertyName

English (United States)

String to be used as the name of the new property

string

4-80

Yes

No

5

PropertyType

English (United States)

New property values' type

type

3-24

No

No

1

SolutionToken

Español (moderno)

Token de solución identificando la solución a la cual pertenecerá la nueva propriedad (tokens 'master' e clon son aceptados)

solutiontoken

128-128

No

No

2

PropertyCategoryName

Español (moderno)

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

propertycategory

4-48

Yes

No

3

PropertyGroupName

Español (moderno)

Secuencia de carácteres conteniendo el nombre del grupo de propriedades a la cual pertenecerá la nueva propriedad

propertygroup

4-64

Yes

No

4

PropertyName

Español (moderno)

Secuencia de caracteres a ser utilizada como nombre de la nueva propiedad

string

4-80

Yes

No

5

PropertyType

Español (moderno)

Tipo de los valores de la nueva propiedad

type

3-24

No

No

1

SolutionToken

Português (Brasil)

Token de solução identificando a solução à qual a nova propriedade pertencerá (tokens 'master' e clone são aceitos)

solutiontoken

128-128

No

No

2

PropertyCategoryName

Português (Brasil)

Sequencia de caracteres contendo o nome da categoria de propriedades a qual a nova propriedade pertencerá

propertycategory

4-48

Yes

No

3

PropertyGroupName

Português (Brasil)

Sequencia de caracteres contendo o nome do grupo de propriedades a qual a nova propriedade pertencerá

propertygroup

4-64

Yes

No

4

PropertyName

Português (Brasil)

Sequencia de caracteres a ser usada como nome da nova propriedade

string

4-80

Yes

No

5

PropertyType

Português (Brasil)

Tipo dos valores da nova propriedade

type

3-24

No

No

Return Value

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

Errorcode

Language

Description

:@Err#Prp0000012

English (United States)

Value provided as property category doesn't exist inside specified solution

:@Err#Prp0000014

English (United States)

Value provided as property group doesn't exist inside specified solution

:@Err#Prp0000015

English (United States)

Value provided as new property name is already in use for specified solution

:@Err#Sol0000008

English (United States)

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

:@Err#Prp0000012

Español (moderno)

Valor informado como categoría de propriedades no existe en la solución especificada

:@Err#Prp0000014

Español (moderno)

Valor informado como grupo de propriedades no existe en la solución especificada

:@Err#Prp0000015

Español (moderno)

Valor informado como nuevo nombre de propriedad ya está en uso 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#Prp0000012

Português (Brasil)

Valor fornecido como categoria de propriedades não existe na solução especificada

:@Err#Prp0000014

Português (Brasil)

Valor fornecido como grupo de propriedades não existe na solução especificada

:@Err#Prp0000015

Português (Brasil)

Valor fornecido como novo nome de propriedade já está em uso na solução especificada

:@Err#Sol0000008

Português (Brasil)

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

US Patent Requested