TokenController.GetParameterTokens Method |
Note: This API is now obsolete.
OBSOLETE - Use POST /Token/GetParameterTokens/ instead.
Retrieves the parameter tokens.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[ObsoleteAttribute("Deprecated. Use GetParameterTokensWithOptions instead.")]
[HttpGetAttribute("ParameterTokens")]
public ActionResult<IList<ParameterTokenData>> GetParameterTokens(
CompatibleDataTypes parameterDataType,
TokenDisplayTypes displayTypes,
Guid? projectId = null,
bool? includeAttributeTokens = null,
Guid? hierarchyParentId = null,
string hierarchyUniqueName = "",
Guid? sessionId = null
)
<ObsoleteAttribute("Deprecated. Use GetParameterTokensWithOptions instead.")>
<HttpGetAttribute("ParameterTokens")>
Public Function GetParameterTokens (
parameterDataType As CompatibleDataTypes,
displayTypes As TokenDisplayTypes,
Optional projectId As Guid? = Nothing,
Optional includeAttributeTokens As Boolean? = Nothing,
Optional hierarchyParentId As Guid? = Nothing,
Optional hierarchyUniqueName As String = "",
Optional sessionId As Guid? = Nothing
) As ActionResult(Of IList(Of ParameterTokenData))
public:
[ObsoleteAttribute(L"Deprecated. Use GetParameterTokensWithOptions instead.")]
[HttpGetAttribute(L"ParameterTokens")]
ActionResult<IList<ParameterTokenData^>^>^ GetParameterTokens(
CompatibleDataTypes parameterDataType,
TokenDisplayTypes displayTypes,
Nullable<Guid> projectId = nullptr,
Nullable<bool> includeAttributeTokens = nullptr,
Nullable<Guid> hierarchyParentId = nullptr,
String^ hierarchyUniqueName = L"",
Nullable<Guid> sessionId = nullptr
)
[<ObsoleteAttribute("Deprecated. Use GetParameterTokensWithOptions instead.")>]
[<HttpGetAttribute("ParameterTokens")>]
member GetParameterTokens :
parameterDataType : CompatibleDataTypes *
displayTypes : TokenDisplayTypes *
?projectId : Nullable<Guid> *
?includeAttributeTokens : Nullable<bool> *
?hierarchyParentId : Nullable<Guid> *
?hierarchyUniqueName : string *
?sessionId : Nullable<Guid>
(* Defaults:
let _projectId = defaultArg projectId null
let _includeAttributeTokens = defaultArg includeAttributeTokens null
let _hierarchyParentId = defaultArg hierarchyParentId null
let _hierarchyUniqueName = defaultArg hierarchyUniqueName ""
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<IList<ParameterTokenData>>
Parameters
- parameterDataType
- Type: Dundas.BI.Data.Parameters.CompatibleDataTypes
Type of the parameter data. - displayTypes
- Type: Dundas.BI.Data.Parameters.Tokens.TokenDisplayTypes
The display types. - projectId (Optional)
- Type: System.Nullable<Guid>
ID of the project. - includeAttributeTokens (Optional)
- Type: System.Nullable<Boolean>
If the attribute tokens should be included. - hierarchyParentId (Optional)
- Type: System.Nullable<Guid>
ID of the hierarchy parent. - hierarchyUniqueName (Optional)
- Type: System.String
Name of the hierarchy unique. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<IList<ParameterTokenData>>
An array of
ParameterTokenData objects containing the parameter token data, or a status code indicating the problem.
See Also