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