GET v1/systemsettings/{key}
Returns a specific system setting.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
key |
The key that identifies the system setting | string |
Required |
Body Parameters
None.
Response Information
Resource Description
The requested system setting
SystemSettingName | Description | Type | Additional information |
---|---|---|---|
Id |
A unique ID for the object. |
integer |
Read-only. |
Name |
Name of the setting |
string |
Read-only. |
Key |
A unique key of the setting |
string |
Read-only. |
Value |
Value of the setting |
string |
None. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
ReadOnly |
Whether or not the system setting can be edited |
boolean |
None. |
Type |
The value type of the setting. |
string |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<SystemSetting xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>1</Id> <CreatedDate>2024-10-29T17:33:38.6627009+01:00</CreatedDate> <ArchivedDate>2024-10-29T17:33:38.6627009+01:00</ArchivedDate> <Name>sample string 2</Name> <Key>sample string 3</Key> <Value>sample string 4</Value> <ReadOnly>true</ReadOnly> <Type>sample string 7</Type> </SystemSetting>