module

Module Search

Changed on

Get a list of all modules available to this CMS

get/module

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/module
  • Auth
    none declared

Query parameters

moduleIdinteger

Filter by module ID

namestring

Filter by module name

keywordstring

Filter by module name, ID, or description

sortBy'name' | 'description' | 'regionSpecific' | 'defaultDuration' | 'previewEnabled' | 'assignable' | 'enabled' | 'isError'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

startinteger

The offset to start results from (for pagination)

lengthinteger

The number of records to return (page size)

Response

successful operation

moduleIdinteger

The ID of this Module

namestring

Module Name

authorstring

Module Author

descriptionstring

Description of the Module

iconstring

An icon to use in the toolbar

typestring

The type code for this module

dataTypestring

The data type of the data expected to be returned by this modules data provider

groupstring[]

The group details for this module

dataCacheKeystring

The cache key used when requesting data

fallbackDatainteger

Is fallback data allowed for this module? Only applicable for a Data Widget

regionSpecificinteger

Is specific to a Layout or can be uploaded to the Library?

schemaVersioninteger

The schema version of the module

compatibilityClassstring

The compatibility class of the module

showInstring

A flag indicating whether the module should be excluded from the Layout Editor

assignableinteger

A flag indicating whether the module is assignable to a Layout

hasThumbnailinteger

Does this module have a thumbnail to render?

thumbnailstring

This is the location to a module's thumbnail

renderAsstring

Should be rendered natively by the Player or via the CMS (native|html)

classstring

Class Name including namespace

validatorClassstring[]

Validator class name including namespace

onInitializestring

JavaScript function run when a module is initialised, before data is returned

onParseDatastring

Data Parser run against each data item applicable when a dataType is present

onDataLoadstring

A load function to run when the widget first fetches data

onRenderstring

JavaScript function run when a module is rendered, after data has been returned

onVisiblestring

JavaScript function run when a module becomes visible

sampleDatastring

Optional sample data item, only applicable when a dataType is present

enabledinteger

A flag indicating whether this module is enabled

previewEnabledinteger

A flag indicating whether the Layout designer should render a preview of this module

defaultDurationinteger

The default duration for Widgets of this Module when the user has not set a duration.

requiredElementsstring[]

An array of required elements

isInstalledboolean

$isInstalled Is this module installed?

isErrorboolean

$isError Does this module have any errors?

errorsstring[]

$errors An array of errors this module has.

Changes

  • fe497e811c7fRevision changes
    • info

      added the new optional query request parameter keyword

    • info

      added the new optional query request parameter length

    • info

      added the new optional query request parameter moduleId

    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

    • info

      added the new optional query request parameter start

  • 41c04de98ec5Revision changes
    • info

      added the media type application/json for the response with the status