FileController.GetRecycleBinFolder Method

Gets the recycle bin folder.

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

[HttpGetAttribute("RecycleBin")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<FileData?> GetRecycleBinFolder(
	Guid? sessionId = null,
	Guid? accountId = null,
	Guid? tenantId = null,
	bool createIfNotExists = true
)

<HttpGetAttribute("RecycleBin")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetRecycleBinFolder ( 
	Optional sessionId As Guid? = Nothing,
	Optional accountId As Guid? = Nothing,
	Optional tenantId As Guid? = Nothing,
	Optional createIfNotExists As Boolean = true
) As ActionResult(Of FileData)

public:
[HttpGetAttribute(L"RecycleBin")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<FileData^>^ GetRecycleBinFolder(
	Nullable<Guid> sessionId = nullptr, 
	Nullable<Guid> accountId = nullptr, 
	Nullable<Guid> tenantId = nullptr, 
	bool createIfNotExists = true
)

[<HttpGetAttribute("RecycleBin")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetRecycleBinFolder : 
        ?sessionId : Nullable<Guid> * 
        ?accountId : Nullable<Guid> * 
        ?tenantId : Nullable<Guid> * 
        ?createIfNotExists : bool 
(* Defaults:
        let _sessionId = defaultArg sessionId null
        let _accountId = defaultArg accountId null
        let _tenantId = defaultArg tenantId null
        let _createIfNotExists = defaultArg createIfNotExists true
*)
-> ActionResult<FileData>

Parameters

sessionId (Optional): Type: System.Nullable<Guid>
Current session ID.
accountId (Optional): Type: System.Nullable<Guid>
The optional account ID to get the recycle bin folder for a specific account.
tenantId (Optional): Type: System.Nullable<Guid>
The tenant ID associated with the account's recycle bin.
createIfNotExists (Optional): Type: System.Boolean
Pass true to create the recycle bin folder, if its does not exist, false otherwise.

Return Value

Type: ActionResult<FileData>
The operation completed successfully. The payload contains a FileData object if the recycle bin folder exists or if createIfNotExists is set to true, null if the recycle bin folder does not exist and createIfNotExists is set to false.

Reference

FileController Class

Dundas.BI.WebApi.Controllers Namespace

FileController.AddLanguageSpecificTextSet("LSTFA0D09EC_0?cpp=::|nu=.");GetRecycleBinFolder Method

Parameters

Return Value

Reference

FileController.GetRecycleBinFolder Method