WidgetCustomModule REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
WidgetCustomModule
Management of sv:widgetCustomModule instances of the site.
Applicable to: sv:addonRepository.
POST
Create a new widget custom module from configuration. Widget custom modules are available when working with dashboards.
Requires the feature "addons" and that the user is authorized to MANAGE_ADDONS or has DEVELOPER authorization.
| Name | Type | Values | Description | Since |
|---|---|---|---|---|
| name | string |
The new name for the widget custom module | ||
| category | string |
StatisticsAndAnalysis, ContentManagement, SystemStatus, IntegratedTools, SupportAndHelp, UserManagement, CalendarAndEvents, Other | A category for the new widget custom module. Has to be one of Sitevision's categories | |
| executablesLimit | integer |
2-5 | Specifies the maximum number of versions allowed for a widget custom module. If unspecified, the default limit is 3. When this limit is exceeded, the oldest non-active version is automatically removed when a new version is uploaded. | 2025.03.1 |
Example URL
190.1526119418572a8e7b4240/widgetcustommodule
Example input
{
"name": "My widget",
"category": "StatisticsAndAnalysis"
}
Example response
{
"id": "770.1526119418572a8e7b4581",
"type": "sv:widgetCustomModule",
"name": "My widget",
"path": "/Testsite/Addon Repository/My widget"
}
DELETE
Delete a widget custom module.
Requires the feature "addons" and that the user is authorized to MANAGE_ADDONS or has DEVELOPER authorization.
Example URL
190.1526119418572a8e7b4240/widgetcustommodule/770.1526119418572a8e7b4581
Example response
{
"id": "770.1526119418572a8e7b4581",
"type": "sv:widgetCustomModule",
"name": "My widget",
"path": "/Testsite/Addon Repository/My widget"
}
Did you find the content on this page useful?