ActivateCustomModuleExecutable 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.
ActivateCustomModuleExecutable
Sets a custom module executable as active (sv:webApp, sv:restApp, sv:moduleElement).
Applicable to: sv:customModule, sv:marketplaceCustomModule, sv:headlessCustomModule, sv:marketplaceHeadlessCustomModule, sv:widgetCustomModule and sv:marketplaceWidgetCustomModule of the sv:addonRepository.
GET
Returns information about a custom module and its executables (sv:webApp, sv:restApp, sv:moduleElement).
Requires the feature "addons" and that the user is authorized to MANAGE_ADDONS or has DEVELOPER authorization.
Example URL
188.6b9bf2d0177f80c4d6315/ActivateCustomModuleExecutable
Example response
{
"id": "188.6b9bf2d0177f80c4d6315",
"type": "sv:headlessCustomModule",
"name": "Report API",
"customModuleExecutableId": "361.1562676919487b84df61",
"executables": [
{
"id": "361.6f1f0231189da6e86eeb",
"type": "sv:restApp",
"name": "reportRestApp-1.0.6",
"appIdentifier": "reportRestApp",
"appVersion": "1.0.6",
"active": false
},
{
"id": "361.1562676919487b84df61",
"type": "sv:restApp",
"name": "reportRestApp-1.0.7",
"appIdentifier": "reportRestApp",
"appVersion": "1.0.7",
"active": true
}
]
}
PUT
Sets a custom module executable as active (sv:webApp, sv:restApp, sv:moduleElement).
Requires the feature "addons" and that the user is authorized to MANAGE_ADDONS or has DEVELOPER authorization.
| Name | Type | Description |
|---|---|---|
| customModuleExecutableId | string |
The id of the custom module executable to activate |
Example URL
188.6b9bf2d0177f80c4d6315/ActivateCustomModuleExecutable
Example input
{
"customModuleExecutableId":"361.6f1f0231189da6e86eeb"
}