Internal Cascade API

The internal Cascade API exposes a set of operations to developers for code run within Cascade CMS in Formats, Publish Triggers, Asset Factory Plugins, and other types of plugins.

Overview

The internal Cascade API exposes a set of operations to developers for code run within Cascade CMS in formats, Publish Triggers, Asset Factory Plugins, and other types of plugins. Currently the API supports the following operations:

  • Reading assets and asset data.
  • Creating new assets.
  • Making edits to existing assets.
  • Making copies of existing assets.
  • Adding assets to the publish queue.
  • Deleting assets.

The Cascade API is a library written in Java

To use the API inside of formats, use the Locator Tool or Query API to retrieve API objects.

To use the API inside of an Asset Factory Plugin or Publish Trigger, developers need to include the Cascade API JAR file in their classpath. The API JAR is bundled with the Asset Factory Plugin SDK and the Publish Trigger SDK.