Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′PropertyAddAllow′ Reference Documentation
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: 1 - Name: SolutionToken
Language: English (United States)
Description: Token identifying solution the new property will belong to (master and clones are accepted)
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: PropertyCategoryName
Language: English (United States)
Description: String containing the property category the new property will be added to
Type: propertycategory - Min-Max Length: 4-48 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: PropertyGroupName
Language: English (United States)
Description: String containing the property group the new property will be added to
Type: propertygroup - Min-Max Length: 4-64 - Reentr Key Member: Yes - Optional: No
ID: 4 - Name: PropertyName
Language: English (United States)
Description: String to be used as the name of the new property
Type: string - Min-Max Length: 4-80 - Reentr Key Member: Yes - Optional: No
ID: 5 - Name: PropertyType
Language: English (United States)
Description: New property values' type
Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No
ID: 1 - Name: SolutionToken
Language: Español (moderno)
Description: Token de solución identificando la solución a la cual pertenecerá la nueva propriedad (tokens 'master' e clon son aceptados)
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: PropertyCategoryName
Language: Español (moderno)
Description: Secuencia de carácteres conteniendo el nombre de la categoría de propriedades a la cual pertenecerá la nueva propriedad
Type: propertycategory - Min-Max Length: 4-48 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: PropertyGroupName
Language: Español (moderno)
Description: Secuencia de carácteres conteniendo el nombre del grupo de propriedades a la cual pertenecerá la nueva propriedad
Type: propertygroup - Min-Max Length: 4-64 - Reentr Key Member: Yes - Optional: No
ID: 4 - Name: PropertyName
Language: Español (moderno)
Description: Secuencia de caracteres a ser utilizada como nombre de la nueva propiedad
Type: string - Min-Max Length: 4-80 - Reentr Key Member: Yes - Optional: No
ID: 5 - Name: PropertyType
Language: Español (moderno)
Description: Tipo de los valores de la nueva propiedad
Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: No
ID: 1 - Name: SolutionToken
Language: Português (Brasil)
Description: Token de solução identificando a solução à qual a nova propriedade pertencerá (tokens 'master' e clone são aceitos)
Type: solutiontoken - Min-Max Length: 128-128 - Reentr Key Member: No - Optional: No
ID: 2 - Name: PropertyCategoryName
Language: Português (Brasil)
Description: Sequencia de caracteres contendo o nome da categoria de propriedades a qual a nova propriedade pertencerá
Type: propertycategory - Min-Max Length: 4-48 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: PropertyGroupName
Language: Português (Brasil)
Description: Sequencia de caracteres contendo o nome do grupo de propriedades a qual a nova propriedade pertencerá
Type: propertygroup - Min-Max Length: 4-64 - Reentr Key Member: Yes - Optional: No
ID: 4 - Name: PropertyName
Language: Português (Brasil)
Description: Sequencia de caracteres a ser usada como nome da nova propriedade
Type: string - Min-Max Length: 4-80 - Reentr Key Member: Yes - Optional: No
ID: 5 - Name: PropertyType
Language: Português (Brasil)
Description: Tipo dos valores da nova propriedade
Type: type - Min-Max Length: 3-24 - Reentr Key Member: No - Optional: 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
