GET v1/systemsettings/{key}

Returns a specific system setting.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
key The key that identifies the system setting string

Required

Body Parameters

None.

Response Information

Resource Description

The requested system setting

SystemSetting
NameDescriptionTypeAdditional information
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.

ReadOnly Whether or not the system setting can be edited
boolean

None.

Type The value type of the setting.
string

None.

Id A unique ID for the object.
integer

Read-only.

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.

Operations Collection of OperationResult

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.