Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′PropertyGroupAddAllow′ Reference Documentation
Description
The following table displays the documentation for the 'PropertyGroupAddAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests the creation of a new property type |
Español (moderno) |
Pide la creación de un nuevo tipo de propiedad |
Português (Brasil) |
Solicita a criação de um novo tipo de propriedade |
Parameters
The following table describes all of 'PropertyGroupAddAllow''s parameters, in every language available.
ID: 1 - Name: SolutionToken
Language: English (United States)
Description: Token identifying solution the new property group 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 group will be part of
Type: propertycategory - Min-Max Length: 4-48 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: PropertyGroupName
Language: English (United States)
Description: String to be used as the name of the new group of properties
Type: string - Min-Max Length: 4-64 - Reentr Key Member: Yes - Optional: No
ID: 1 - Name: SolutionToken
Language: Español (moderno)
Description: Token de solución identificando la solución a la cual pertenecerá el nuevo grupo de propriedades (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 el nuevo grupo pertenecerá
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 a ser usada como nombre de la nueva categoría de propriedades
Type: string - Min-Max Length: 4-64 - Reentr Key Member: Yes - Optional: No
ID: 1 - Name: SolutionToken
Language: Português (Brasil)
Description: Token de solução identificando a solução à qual o novo grupo de propriedades 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 o novo grupo 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 a ser usada como nome da nova categoria de propriedades
Type: string - Min-Max Length: 4-64 - Reentr Key Member: Yes - Optional: No
---
Return Value
'PropertyGroupAddAllow' 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 'PropertyGroupAddAllow' 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#Prp0000013 |
English (United States) |
Value provided as new property group already exists 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#Prp0000013 |
Español (moderno) |
Valor informado como nuevo grupo de propriedades ya existe 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#Prp0000013 |
Português (Brasil) |
Valor fornecido como novo grupo de propriedades já existe 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
