Table of Contents

Class WidgetDefinitionsController

Namespace
KadicErp.WebApi.Controllers.Dashboard
Assembly
KadicErp.WebApi.dll
[ApiController]
[Authorize]
[Route("api/v1/dashboard/widget-definitions")]
public sealed class WidgetDefinitionsController : ControllerBase
Inheritance
object
ControllerBase
WidgetDefinitionsController

Constructors

WidgetDefinitionsController(IMediator, ITenantIdContext, ICurrentUser)

public WidgetDefinitionsController(IMediator mediator, ITenantIdContext tenantContext, ICurrentUser currentUser)

Parameters

mediator IMediator
tenantContext ITenantIdContext
currentUser ICurrentUser

Methods

Create(CreateWidgetDefinitionCommand)

[HttpPost]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_CREATE")]
public Task<IActionResult> Create(CreateWidgetDefinitionCommand command)

Parameters

command CreateWidgetDefinitionCommand

Returns

Task<IActionResult>

Delete(Guid)

[HttpDelete("{id:guid}")]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_DELETE")]
public Task<IActionResult> Delete(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

GetAll(GetWidgetDefinitionsQuery)

[HttpGet]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_VIEW")]
public Task<IActionResult> GetAll(GetWidgetDefinitionsQuery query)

Parameters

query GetWidgetDefinitionsQuery

Returns

Task<IActionResult>

GetById(Guid)

[HttpGet("{id:guid}")]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_VIEW")]
public Task<IActionResult> GetById(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

GetUsages(Guid)

[HttpGet("{id:guid}/usages")]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_VIEW")]
public Task<IActionResult> GetUsages(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

ToggleActive(Guid)

[HttpPatch("{id:guid}/toggle-active")]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_UPDATE")]
public Task<IActionResult> ToggleActive(Guid id)

Parameters

id Guid

Returns

Task<IActionResult>

Update(Guid, UpdateWidgetDefinitionCommand)

[HttpPut("{id:guid}")]
[Authorize(Policy = "ADMIN_REPORTING_WIDGET_DEFINITIONS_UPDATE")]
public Task<IActionResult> Update(Guid id, UpdateWidgetDefinitionCommand command)

Parameters

id Guid
command UpdateWidgetDefinitionCommand

Returns

Task<IActionResult>