TransferController.GetTransferFileInfo Method |
Gets an object describing the contents of a transfer file.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPostAttribute("FileInfo")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<TransferFileInfoData> GetTransferFileInfo(
[FromBodyAttribute] GetTransferFileInfoOptions options,
Guid? sessionId = null
)<HttpPostAttribute("FileInfo")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(404)>
<ProducesResponseTypeAttribute(440)>
Public Function GetTransferFileInfo (
<FromBodyAttribute> options As GetTransferFileInfoOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of TransferFileInfoData)public:
[HttpPostAttribute(L"FileInfo")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(440)]
ActionResult<TransferFileInfoData^>^ GetTransferFileInfo(
[FromBodyAttribute] GetTransferFileInfoOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("FileInfo")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(404)>]
[<ProducesResponseTypeAttribute(440)>]
member GetTransferFileInfo :
[<FromBodyAttribute>] options : GetTransferFileInfoOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<TransferFileInfoData>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.GetTransferFileInfoOptions
The options class used to determine which transfer file to get and what is sent back. - sessionId (Optional)
- Type: System.Nullable<Guid>
The current session ID.
Return Value
Type:
ActionResult<TransferFileInfoData>The operation completed successfully. The payload contains a
TransferFileInfoData object.
See Also