AccountController.GetUserData Method |
Gets the user data for the specified account.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpGetAttribute("UserData/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<KeyValuePairData[]> GetUserData(
Guid id,
Guid? tenantId = null,
bool isTenantAgnostic = true,
Guid? sessionId = null
)
<HttpGetAttribute("UserData/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetUserData (
id As Guid,
Optional tenantId As Guid? = Nothing,
Optional isTenantAgnostic As Boolean = true,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of KeyValuePairData())
public:
[HttpGetAttribute(L"UserData/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<array<KeyValuePairData^>^>^ GetUserData(
Guid id,
Nullable<Guid> tenantId = nullptr,
bool isTenantAgnostic = true,
Nullable<Guid> sessionId = nullptr
)
[<HttpGetAttribute("UserData/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetUserData :
id : Guid *
?tenantId : Nullable<Guid> *
?isTenantAgnostic : bool *
?sessionId : Nullable<Guid>
(* Defaults:
let _tenantId = defaultArg tenantId null
let _isTenantAgnostic = defaultArg isTenantAgnostic true
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<KeyValuePairData[]>
Parameters
- id
- Type: System.Guid
The ID of the account to get the user data for. - tenantId (Optional)
- Type: System.Nullable<Guid>
The ID of the tenant. Ignored if isTenantAgnostic is true. - isTenantAgnostic (Optional)
- Type: System.Boolean
Specifies whether the tenant-agnostic user data values should be retrieved. If not specified, defaults to true. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<KeyValuePairData[]>
An array of
KeyValuePairData objects representing the user data.
See Also