TransferControllerGetTransferFileInfo Method |
POST /Transfer/FileInfo/
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 (10.0.0.1002)
Syntax[HttpPostAttribute]
[ActionNameAttribute("FileInfo")]
public IActionResult GetTransferFileInfo(
[FromBodyAttribute] GetTransferFileInfoOptions options,
Guid? sessionId = null
)<HttpPostAttribute>
<ActionNameAttribute("FileInfo")>
Public Function GetTransferFileInfo (
<FromBodyAttribute> options As GetTransferFileInfoOptions,
Optional sessionId As Guid? = Nothing
) As IActionResultpublic:
[HttpPostAttribute]
[ActionNameAttribute(L"FileInfo")]
IActionResult^ GetTransferFileInfo(
[FromBodyAttribute] GetTransferFileInfoOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute>]
[<ActionNameAttribute("FileInfo")>]
member GetTransferFileInfo :
[<FromBodyAttribute>] options : GetTransferFileInfoOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> IActionResult
Parameters
- options
- Type: Dundas.BI.WebApi.ModelsGetTransferFileInfoOptions
The options class used to determine which transfer file to get and what is sent back. - sessionId (Optional)
- Type: SystemNullableGuid
The current session ID.
Return Value
Type:
IActionResultHTTP Status code with a
TransferFileInfoData object or an error message.
See Also