module

Module Template Search

Get a list of templates available for a particular data type

get/module/templates/{dataType}

Request

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

Path parameters

dataTypestring required

DataType to return templates for

Query parameters

typestring

Type to return templates for

Response

An array of module templates for the provided datatype

templateIdstring

The templateId

typestring

Type of template (static|element|stencil)

dataTypestring

The datatype of this template

titlestring

The title

descriptionstring

Description of the Module Template

iconstring

Icon

thumbnailstring

Thumbnail this is the location to a module template's thumbnail, which should be added to the installation relative to the module class file.

showInstring

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

isVisibleboolean

Is Visible?

isEnabledboolean

Is Enabled?

groupsWithPermissionsstring

A comma separated list of groups/users with permissions to this template

groupsWithPermissionsListstring[]

An array of groups/users with permissions to this template

Changes