Api Home > Settings > GetSetting

GET api/V3/Settings/GetSetting?settingKey={settingKey}&tenantId={tenantId} Gets the specified setting.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
settingKey

The settings key

string

Required

tenantId

The tenant Id

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

SettingsItem
NameDescriptionTypeAdditional information
Key

string

None.

Value

string

None.

TenantId

integer

None.

Id

integer

None.

ModifiedDate

date

None.

ModifiedBy

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "Key": "sample string 1",
  "Value": "sample string 2",
  "TenantId": 3,
  "Id": 4,
  "ModifiedDate": "2019-12-08T10:33:24.807Z",
  "ModifiedBy": "1c934455-b8b0-4e40-8b06-45bf0ad8d77e"
}

application/xml, text/xml

Sample:
<SettingsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Library.InfoObjects">
  <Id>4</Id>
  <ModifiedBy>1c934455-b8b0-4e40-8b06-45bf0ad8d77e</ModifiedBy>
  <ModifiedDate>2019-12-08T10:33:24.8073411+00:00</ModifiedDate>
  <Key>sample string 1</Key>
  <TenantId>3</TenantId>
  <Value>sample string 2</Value>
</SettingsItem>