• KB Home |
• Need Help?

Learning Levels

• Digest
• Concept
• Technical

Announcements

The Cascade API is a set of operations availabl to Cascade Server administrators and developers that can be accessed through Publish Triggers and Asset Factory Plugins.

Currently the API supports the following operations:

• Reading assets
• 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 be able to use the API inside of Asset Factory Plugin or Publish Trigger, developers need to include the Cascade API JAR file in their classpath. The API JAR file can be downloaded from the Hannon Hill GitHub account:

• Cascade 6.7.x
• Cascade 6.4.x
• Cascade 6.2.x
• Cascade 6.0.x

The API operations return specific instances of ModelOperationResult object, for example the Copy operation returns CopyOperationResult which contains the identifier of the copied asset so that it is possible to make further operations on the copy itself. Each operation is performed by a User with provided username. Below you can find an example Cascade API operation call:

public String copyPageToFolder(final String pageId, final String destinationFolderId) throws Exception { Identifier sourceIdentifier = new Identifier() { public String getId(){ return pageId;} public EntityType getType(){ return EntityTypes.TYPE_PAGE;} }; Identifier destinationIdentifier = new Identifier() { public String getId(){ return destinationFolderId;} public EntityType getType(){ return EntityTypes.TYPE_FOLDER;} }; Copy copy = new Copy(); copy.setDestinationContainer(destinationIdentifier); copy.setInstantiateWorkflow(false); copy.setToCopy(sourceIdentifier); copy.setUsername("admin"); CopyOperationResult result = (CopyOperationResult) copy.perform(); String copiedPageId = result.getCopiedAssetId(); return copiedPageId; }

Title References

© 2001-2012 Hannon Hill Corporation

Site Index | HH Internet | KB Feedback

Contact Us: Online Form | +1.678.904.6900