About this resource
Representation of a settingdefinition 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) |
| 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 |
| 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-settingdefinition' 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-SettingDefinition: modifiedby | User | Gets or sets the user that last modified this resource. |
| GET | createdby | select-SettingDefinition: createdby | User | Gets or sets the user that created this resource. |
Actions
| Method | Action | Description | Response codes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PUT /settingdefinition/{settingdefinitionId} | edit | Edits an existing settingdefinition. |
|
||||||||
| DELETE /settingdefinition/{settingdefinitionId} | delete | Deletes an existing settingdefinition. |
|
Examples
Editing a setting definition
PUT /settingdefinition/495bb521-1061-40e6-8f74-45a31d3497f9
{
"dataType" : "text",
"name" : "Name might be changed",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"regularExpression" : "[0-9]*"
}
Deleting a setting definition
DELETE /settingdefinition/495bb521-1061-40e6-8f74-45a31d3497f9