About this resource
Representation of a paged collection of SettingCategory items.
Properties
| Property | Description | Type |
|---|---|---|
| items | One page of this paged collection, which is a subcollection of the complete collection. | Collection of SettingCategory items |
| page | The current page of this paged collection. | int32 |
| pageSize | The current page size of this paged collection. | int32 |
| skip | The current skip size of this paged collection. | int32 |
| take | The current take size of this paged collection. | int32 |
| totalCount | The total count of items in this paged collection, not just on the current page. | int64 |
Relations
Actions
| Method | Action | Description | Response codes | ||||||
|---|---|---|---|---|---|---|---|---|---|
| POST /settingcategories | create | Creates a new setting category. |
|
Examples
Searching for setting categories
The parameters are specified as http headers.
GET /settingcategories HTTP/1.1 Accept: application/hal+json Filter: ModifiedOn in today Sort: createdon Page: 1 PageSize: 20
The parameters are specified as query string parameters.
GET /settingcategories?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=20 HTTP/1.1
The parameters are specified as a combination of query string parameters and http headers.
GET /settingcategories?filter=ModifiedOn+in+today&sort=createdon HTTP/1.1 Page: 1 PageSize: 20
Creating a new setting category
POST /settingcategories HTTP/1.1
{
"name":"Just for DEMO",
"labels":{
"addOrUpdate":[
{
"languageId":"c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc",
"value":"Just for DEMO"
}
]
},
"tag":"<a>test tag</a>"
}
For a more detailed example of values that can be provided when creating setting categories,
see: Editing a setting category