ApplicationConfigurationController.SetConfigValue Method |
Set an application setting value.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPutAttribute]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<string?> SetConfigValue(
[FromBodyAttribute] ConfigValueOptions options,
Guid? sessionId = null
)
<HttpPutAttribute>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function SetConfigValue (
<FromBodyAttribute> options As ConfigValueOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of String)
public:
[HttpPutAttribute]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<String^>^ SetConfigValue(
[FromBodyAttribute] ConfigValueOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPutAttribute>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member SetConfigValue :
[<FromBodyAttribute>] options : ConfigValueOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<string>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.ConfigValueOptions
An object that carries all needed information about the setting values that needs to be set. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<String>
The operation completed successfully. The payload contains a
String object.
If the value was successfully set, but testing it yielded a warning, the warning will be returned in the payload.
See Also