About this resource
Representation of a setting category resource.
Properties
| Property | Description | Type |
|---|---|---|
| createdOn | Gets the creation datetime in UTC time. | datetime |
| id | Gets the Id of this setting category. | guid |
| labels | Gets the labels of this setting category. | LabelCollection |
| modifiedOn | Gets the last modification datetime in UTC time. | datetime |
| name | Gets the name of the setting category. | string |
| tag | Gets or sets the value for the Tag of this object. The value of this property has to be valid Xml. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-settingcategory' and the value 'Tag' to your request. | string |
Relations
| Method | Name | Select-key | Resource type | Description |
|---|---|---|---|---|
| GET | self | Provides a link to this resource. | ||
| GET | modifiedby | select-SettingCategory: modifiedby | User | Gets or sets the user that last modified this resource. |
| GET | createdby | select-SettingCategory: createdby | User | Gets or sets the user that created this resource. |
Actions
| Method | Action | Description | Response codes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PUT /settingcategory/{settingcategoryId} | edit | Edits an existing setting category. |
|
||||||||
| DELETE /settingcategory/{settingcategoryId} | delete | Deletes an existing setting category. |
|
Examples
Editing a setting category
PUT /settingcategory/e44ce6ba-f0a9-4a60-888a-e4bdd4b24bf0
{
"name":"Just for DEMO 2",
"labels": [
{
"languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC",
"value": "My setting category Name In English"
},
{
"languageId": "5d557ae8-fd16-4dbb-a9d9-a80400dfa639",
"value": "My setting category Name In German"
}
],
"tag":"<a>test tag</a>"
}
Deleting a setting category
DELETE /settingcategory/e44ce6ba-f0a9-4a60-888a-e4bdd4b24bf0