Api Home > Settings > SetSetting

POST api/V3/Settings/SetSetting Updates or adds a setting.

Request Information

URI Parameters

None.

Body Parameters

The SetingsItem object

SettingsItem
NameDescriptionTypeAdditional information
Key

string

None.

Value

string

None.

TenantId

integer

None.

Id

integer

None.

ModifiedDate

date

None.

ModifiedBy

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "Key": "sample string 1",
  "Value": "sample string 2",
  "TenantId": 3,
  "Id": 4,
  "ModifiedDate": "2024-04-19T12:08:01.260Z",
  "ModifiedBy": "717edf26-9c18-4efd-bee3-606438f1c323"
}

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>717edf26-9c18-4efd-bee3-606438f1c323</ModifiedBy>
  <ModifiedDate>2024-04-19T12:08:01.2609072+00:00</ModifiedDate>
  <Key>sample string 1</Key>
  <TenantId>3</TenantId>
  <Value>sample string 2</Value>
</SettingsItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

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": "2024-04-19T12:08:01.260Z",
  "ModifiedBy": "9d66cdc6-7dea-42b1-b2a5-7aa86c956210"
}

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>9d66cdc6-7dea-42b1-b2a5-7aa86c956210</ModifiedBy>
  <ModifiedDate>2024-04-19T12:08:01.2609072+00:00</ModifiedDate>
  <Key>sample string 1</Key>
  <TenantId>3</TenantId>
  <Value>sample string 2</Value>
</SettingsItem>