DataCubeController.PreviewTransform Method |
Gets preview data for the specified transform from a data cube.
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("PreviewTransform/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
[ProducesResponseTypeAttribute(500)]
[ProducesResponseTypeAttribute(503)]
public ActionResult<DataCellSetData> PreviewTransform(
Guid id,
[FromBodyAttribute] PreviewTransformOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("PreviewTransform/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
<ProducesResponseTypeAttribute(500)>
<ProducesResponseTypeAttribute(503)>
Public Function PreviewTransform (
id As Guid,
<FromBodyAttribute> options As PreviewTransformOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of DataCellSetData)
public:
[HttpPostAttribute(L"PreviewTransform/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
[ProducesResponseTypeAttribute(500)]
[ProducesResponseTypeAttribute(503)]
ActionResult<DataCellSetData^>^ PreviewTransform(
Guid id,
[FromBodyAttribute] PreviewTransformOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("PreviewTransform/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
[<ProducesResponseTypeAttribute(500)>]
[<ProducesResponseTypeAttribute(503)>]
member PreviewTransform :
id : Guid *
[<FromBodyAttribute>] options : PreviewTransformOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<DataCellSetData>
Parameters
- id
- Type: System.Guid
The ID of the data cube to preview the transform from. - options
- Type: Dundas.BI.WebApi.Models.PreviewTransformOptions
The options for the preview. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<DataCellSetData>The operation completed successfully. The payload contains a
DataCellSetData object containing the data for the preview.
See Also