About this resource
Representation of a TextSettingDefinition resource.
Properties
Property | Description | Type |
---|---|---|
allowSystemSetting | Shows it the setting allows a system setting. | boolean |
allowUserSetting | Shows it the setting allows a user setting. | boolean |
categoryId | Gets the category Id for the setting definition. | guid |
createdOn | Gets the creation datetime in UTC time. | datetime |
dataType | Gets the data type of this setting. | string (values: none, boolean, text, numeric, datetime, xml, role, reference, encryptedtext, defschema) |
defaultValue | Gets a default value of the setting. | string |
helpUrl | Gets a help url for the setting definition. | string |
id | Gets the Id of the setting definition. | guid |
labels | Gets the collection of labels for the setting definition. | LabelCollection |
modifiedOn | Gets the last modification datetime in UTC time. | datetime |
name | Gets the name of the setting definition. | string |
regularExpression | Gets the regular expression that the setting value should match. | string |
roleRequiredForChange | Gets the role that needs to be changed. | string |
tag | Gets a tag for this setting containing extra information. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-encryptedtextsettingdefinition' and the value 'Tag' to your request. | string |
userGroupSettingMode | Gets a UserGroupSettingMode for the setting definition. | string (values: none, maximumvalue, minimumvalue, manual, firstvalue) |
Relations
Method | Name | Select-key | Resource type | Description |
---|---|---|---|---|
GET | self | Provides a link to this resource. | ||
GET | modifiedby | select-EncryptedTextSettingDefinition: modifiedby | User | Gets or sets the user that last modified this resource. |
GET | createdby | select-EncryptedTextSettingDefinition: createdby | User | Gets or sets the user that created this resource. |