TenantController.QueryTenantInfos Method |
Gets information about multiple tenants.
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("QueryInfos")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(409)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<TenantInfoData[]> QueryTenantInfos(
[FromBodyAttribute] GetTenantsOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("QueryInfos")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(409)>
<ProducesResponseTypeAttribute(440)>
Public Function QueryTenantInfos (
<FromBodyAttribute> options As GetTenantsOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of TenantInfoData())
public:
[HttpPostAttribute(L"QueryInfos")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(409)]
[ProducesResponseTypeAttribute(440)]
ActionResult<array<TenantInfoData^>^>^ QueryTenantInfos(
[FromBodyAttribute] GetTenantsOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("QueryInfos")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(409)>]
[<ProducesResponseTypeAttribute(440)>]
member QueryTenantInfos :
[<FromBodyAttribute>] options : GetTenantsOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<TenantInfoData[]>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.GetTenantsOptions
An object that carries all needed information about the tenants that need to be retrieved. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<TenantInfoData[]>The operation completed successfully. The payload contains an array of
TenantInfoData objects.
See Also