Resource: SettingDefinitionPagedCollection

About this resource

Representation of a paged collection of SettingDefinition items.

Properties

Property	Description	Type
items	One page of this paged collection, which is a subcollection of the complete collection.	Collection of SettingDefinition 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

Method	Name	Description
GET	self	Provides a link to this resource.
GET	first	A link to the first page of this paged collection.
GET	prev	A link to the previous page of this paged collection.
GET	next	A link to the next page of this paged collection.
GET	last	A link to the last page of this paged collection.

Actions

Method

Action

Description

Response codes

POST /settingdefinitions

create

Creates a new settingdefinition.

201	Request completed successfully. The header parameter 'Location' contains the location of the new settingdefinition resource. The response body is a JSON object which contains the property "id" that corresponds to the newly created resource.
400	Bad request (in general)
403	Insufficient permissions

Examples

Searching for setting definitions

The parameters are specified as http headers.

GET /settingdefinitions 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 /settingdefinitions?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 /settingdefinitions?filter=ModifiedOn+in+today&sort=createdon HTTP/1.1
Page: 1
PageSize: 20

Creating a new setting definition (common attributes) When creating a setting definition, the following attributes are common to all setting definition types:

POST /settingdefinitions HTTP/1.1
{
"dataType" : "text",
"name": "NewSettingdefinition",
"categoryId": "categoryId",
"allowAnonymousAccess": false,
"allowSystemSetting": true,
"allowSiteSetting": false,
"allowUserSetting": false,
"roleRequiredForChange": ".RoleChangeSystemSettings",
"labels": [
{
"languageId": "54DFBAA2-98A3-4480-A9B2-2AD582304E0B",
"value": "New settingdefinition"
}
],
"tag": null,
"webEditor": null,
"helpUrl": null,
"userGroupSettingMode": "None"
}

Specifying the data type of the setting definition is mandatory. The following data types are supported:

boolean
datetime
encryptedtext
numeric
reference
role
text
xml

Creating a boolean setting definition

POST /settingdefinitions
{
"dataType" : "boolean",
"name" : "BooleanSettingName",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"defaultValue" : true
}

Creating a datetime setting definition

POST /settingdefinitions
{
"dataType" : "datetime",
"name" : "DateTimeSettingName",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"defaultValue" : "2017-10-30T12:36:25.397+02:00"
}

Creating an encrypted text setting definition

POST /settingdefinitions
{
"dataType" : "encryptedtext",
"name" : "TextSettingName",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"defaultValue" : "Default Value",
"regularExpression" : ".*"
}

Creating a numeric setting definition

POST /settingdefinitions
{
"dataType" : "numeric",
"name" : "NumericSettingName",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"defaultValue" : 1,
"range" : "1-255"
}

Creating a reference setting definition

POST /settingdefinitions
{
"dataType" : "reference",
"name" : "ReferenceSettingName",
"allowSystemSetting" : true,
"defaultValue" : "reference",
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38"
}

Creating a role setting definition

POST /settingdefinitions
{
"dataType" : "role",
"name" : "RoleSettingName",
"allowUserSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38"
}

Creating a text setting definition

POST /settingdefinitions
{
"dataType" : "text",
"name" : "TextSettingName",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"defaultValue" : "Default Value",
"regularExpression" : ".*"
}

Creating an xml setting definition

POST /settingdefinitions
{
"dataType" : "xml",
"name" : "XmlSettingName",
"allowSystemSetting" : true,
"categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38",
"defaultValue" : "<doc><text/></doc>",
"schema" : null
}