Create Widget

post

https://api.medocity.net/v3/widgets

This endpoint allows platform administrators to create a new widget. The request body should include the necessary widget details as specified in the PostWidgetDto. The endpoint is secured and requires the user to be a platform admin. [scope: Widgets, claim: Create]

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

widgetName

string

required

The name of the widget.

widgetTitle

string

required

The title of the widget as displayed in the site portal.

widgetType

string

enum

required

The type of the widget.

columnSize

number

required

The column size of the widget, specifying its width.

rowSize

number

required

The row size of the widget, specifying its height.

dashboardContainer

string

enum

required

The container type of the widget, such as Dashboard, Health Summary, or Standard.

Allowed:

widgetPath

string

required

The path to the widget resource.

widgetSettings

object

required

Settings specific to the widget.

widgetTags

array of strings

required

A list of tags associated with the widget.

widgetTags*

Response

200

The widget has been successfully created.