Module Search By ID
Get the Module object specified by the provided moduleId
Path parameters
ID of the Module to get
Response
successful operation
The ID of this Module
Module Name
Module Author
Description of the Module
An icon to use in the toolbar
The type code for this module
The data type of the data expected to be returned by this modules data provider
The group details for this module
The cache key used when requesting data
Is fallback data allowed for this module? Only applicable for a Data Widget
Is specific to a Layout or can be uploaded to the Library?
The schema version of the module
The compatibility class of the module
A flag indicating whether the module should be excluded from the Layout Editor
A flag indicating whether the module is assignable to a Layout
Does this module have a thumbnail to render?
This is the location to a module's thumbnail
Should be rendered natively by the Player or via the CMS (native|html)
Class Name including namespace
Validator class name including namespace
JavaScript function run when a module is initialised, before data is returned
Data Parser run against each data item applicable when a dataType is present
A load function to run when the widget first fetches data
JavaScript function run when a module is rendered, after data has been returned
JavaScript function run when a module becomes visible
Optional sample data item, only applicable when a dataType is present
A flag indicating whether this module is enabled
A flag indicating whether the Layout designer should render a preview of this module
The default duration for Widgets of this Module when the user has not set a duration.
An array of required elements
$isInstalled Is this module installed?
$isError Does this module have any errors?
$errors An array of errors this module has.