FileController.SetDescription Method |
Updates a file's description.
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("Description/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult SetDescription(
Guid id,
[FromBodyAttribute] string description,
Guid? sessionId = null
)
<HttpPutAttribute("Description/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function SetDescription (
id As Guid,
<FromBodyAttribute> description As String,
Optional sessionId As Guid? = Nothing
) As ActionResult
public:
[HttpPutAttribute(L"Description/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult^ SetDescription(
Guid id,
[FromBodyAttribute] String^ description,
Nullable<Guid> sessionId = nullptr
)
[<HttpPutAttribute("Description/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member SetDescription :
id : Guid *
[<FromBodyAttribute>] description : string *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult
Parameters
- id
- Type: System.Guid
The ID of the entry to set the description on. - description
- Type: System.String
The new description. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult
See Also