LoggingController.GenerateDownloadFile Method

Generates the download file for the logs.

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)

Syntax

C++

Copy

[HttpPostAttribute("Download")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<Guid> GenerateDownloadFile(
	[FromBodyAttribute] GetLogEntriesOptions options,
	Guid? sessionId = null
)

<HttpPostAttribute("Download")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(440)>
Public Function GenerateDownloadFile ( 
	<FromBodyAttribute> options As GetLogEntriesOptions,
	Optional sessionId As Guid? = Nothing
) As ActionResult(Of Guid)

public:
[HttpPostAttribute(L"Download")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(440)]
ActionResult<Guid>^ GenerateDownloadFile(
	[FromBodyAttribute] GetLogEntriesOptions^ options, 
	Nullable<Guid> sessionId = nullptr
)

[<HttpPostAttribute("Download")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(440)>]
member GenerateDownloadFile : 
        [<FromBodyAttribute>] options : GetLogEntriesOptions * 
        ?sessionId : Nullable<Guid> 
(* Defaults:
        let _sessionId = defaultArg sessionId null
*)
-> ActionResult<Guid>

Parameters

options: Type: Dundas.BI.WebApi.Models.GetLogEntriesOptions
An object that carries all need information about the log entries that are going to be downloaded.
sessionId (Optional): Type: System.Nullable<Guid>
Current session ID.

Return Value

Type: ActionResult<Guid>
The operation completed successfully. The payload contains a Guid corresponding to the file name.

Reference

LoggingController Class

Dundas.BI.WebApi.Controllers Namespace

LoggingController.AddLanguageSpecificTextSet("LST904CB70B_0?cpp=::|nu=.");GenerateDownloadFile Method

Parameters

Return Value

Reference

LoggingController.GenerateDownloadFile Method