DataCubeController.RemoveSchedule Method |
Removes the schedule from the specified 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[HttpDeleteAttribute("Schedule/{id}")]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult RemoveSchedule(
Guid id,
Guid? tenantId = null,
Guid? sessionId = null
)
<HttpDeleteAttribute("Schedule/{id}")>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function RemoveSchedule (
id As Guid,
Optional tenantId As Guid? = Nothing,
Optional sessionId As Guid? = Nothing
) As ActionResult
public:
[HttpDeleteAttribute(L"Schedule/{id}")]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult^ RemoveSchedule(
Guid id,
Nullable<Guid> tenantId = nullptr,
Nullable<Guid> sessionId = nullptr
)
[<HttpDeleteAttribute("Schedule/{id}")>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member RemoveSchedule :
id : Guid *
?tenantId : Nullable<Guid> *
?sessionId : Nullable<Guid>
(* Defaults:
let _tenantId = defaultArg tenantId null
let _sessionId = defaultArg sessionId null
*)
-> ActionResult
Parameters
- id
- Type: System.Guid
The ID of the data cube. - tenantId (Optional)
- Type: System.Nullable<Guid>
The tenant ID, if the schedule is for a tenant. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult
Remarks
If tenantId is provided, the tenant specific schedule will be removed for the data cube, and the
associated tenant job will fall back to the parent job's schedule.
See Also