Documentation Knowledgebase

This area helps us show you how to use our features to grow your business.

OpenContent Helper

Review OpenContent Template Usage

Staff with elevated access or module Edit permission use the Template Usage API to choose a scope, review template summaries, usages, inventory, and cleanup candidates, and export reports as CSV. Superusers can review all or a selected website.

Updated

Template Usage is for staff who need to inspect templates across one or more runsonUpendo websites. The API requires either an elevated user or website module Edit permission on the active module.

Choose a scope

Call:

GET /DesktopModules/OpenContentHelper/API/TemplateUsage/GetScopeOptions

Use the returned options to choose the current website. Superusers can also choose all websites or a specific website.

Review reports

  • GET /TemplateUsage/GetSummary shows high-level counts.
  • GET /TemplateUsage/GetTemplates lists templates with paging and filters such as searchValue, source, and status.
  • GET /TemplateUsage/GetUsages shows where a selected template path is used.
  • GET /TemplateUsage/GetInventory returns the inventory for the selected scope.
  • GET /TemplateUsage/GetCleanupCandidates lists missing or unused candidates that deserve review.

The list endpoints accept DataTables-style paging values such as draw, start, length, orderColumn, and orderDir. Keep the default scope=current unless you intentionally need another scope.

Export a report

Call:

GET /DesktopModules/OpenContentHelper/API/TemplateUsage/Export?report=inventory

Use report=candidates to export cleanup candidates. The response downloads a CSV file. You can also pass the same search, source, status, scope, or website filters used by the reports.

Review every cleanup candidate before deleting or replacing a template. A template may be referenced by deployment files, a shared default, or a page that is not obvious from the current screen.

Topics: