PUT api/PluginSettings/{pluginSettingId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pluginSettingId

integer

Required

Body Parameters

PluginSetting
NameDescriptionTypeAdditional information
PluginSettingId

integer

None.

PluginId

integer

Required

SettingId

integer

Required

IsRequired

boolean

None.

Setting

Setting

None.

Request Formats

application/json, text/json

Sample:
{
  "PluginSettingId": 1,
  "PluginId": 2,
  "SettingId": 3,
  "IsRequired": true,
  "Setting": {
    "SettingId": 1,
    "Name": "sample string 2",
    "Key": "sample string 3",
    "Default": "sample string 4",
    "IsAdvanced": true
  }
}

application/xml, text/xml

Sample:
<PluginSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <IsRequired>true</IsRequired>
  <PluginId>2</PluginId>
  <PluginSettingId>1</PluginSettingId>
  <Setting>
    <Default>sample string 4</Default>
    <IsAdvanced>true</IsAdvanced>
    <Key>sample string 3</Key>
    <Name>sample string 2</Name>
    <SettingId>1</SettingId>
  </Setting>
  <SettingId>3</SettingId>
</PluginSetting>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.