DataRetrievalController.GetBatchData Method |
Gets the data for the specified objects with the specified settings. Used mainly for scorecards/reports.
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("GetBatchData")]
[ProducesResponseTypeAttribute(440)]
[ProducesResponseTypeAttribute(500)]
public Task<ActionResult<IList<BatchedResultData>>> GetBatchData(
[FromBodyAttribute] BatchedDataRequestData[] options,
Guid? sessionId = null
)
<HttpPostAttribute("GetBatchData")>
<ProducesResponseTypeAttribute(440)>
<ProducesResponseTypeAttribute(500)>
Public Function GetBatchData (
<FromBodyAttribute> options As BatchedDataRequestData(),
Optional sessionId As Guid? = Nothing
) As Task(Of ActionResult(Of IList(Of BatchedResultData)))
public:
[HttpPostAttribute(L"GetBatchData")]
[ProducesResponseTypeAttribute(440)]
[ProducesResponseTypeAttribute(500)]
Task<ActionResult<IList<BatchedResultData^>^>^>^ GetBatchData(
[FromBodyAttribute] array<BatchedDataRequestData^>^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("GetBatchData")>]
[<ProducesResponseTypeAttribute(440)>]
[<ProducesResponseTypeAttribute(500)>]
member GetBatchData :
[<FromBodyAttribute>] options : BatchedDataRequestData[] *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> Task<ActionResult<IList<BatchedResultData>>>
Parameters
- options
- Type:Dundas.BI.WebApi.Models.BatchedDataRequestData[]
The options for how to retrieve the data. - sessionId (Optional)
- Type: System.Nullable<Guid>
ID of the session.
Return Value
Type:
Task<ActionResult<IList<BatchedResultData>>>The operation completed successfully. The payload contains an array of
BatchedResultData objects.
See Also