This document provides an overview of Cascade Server web services. It discusses what a web service is and examples of how they can be used. It covers the main operations available through the Cascade Server web services API like create, read, edit, delete, copy, and managing access rights. It also explains how to authenticate to the web services and understand the WSDL file. Code examples are provided for common operations in PHP. Limitations of the web services are outlined and upcoming features in Cascade Server 7.2 are previewed.
2. Introduction
What's Ahead:
• What is a web service?
• Real life applications
• Cascade Server Web Services Operations
• Understanding the WSDL file
• Code examples for most commonly used
operations
• What is coming in Cascade Server 7.2?
3. What is a web service?
Web Service is a way to communicate between your
own application and Cascade Server.
Cascade Server uses SOAP for web services which
uses XML format to send and receive information
4. Real life applications
• Importing/exporting content
• Handling form submissions
• Updating access rights on multiple assets for a single
user or group
• Advanced bulk change
• Bulk update content
• Selective publishing of specific assets only
• Data Definition Page to Data Definition Block
conversion
5. Authentication
Each operation needs to be authenticated using a
username and password
The operation is then executed as if that User
performed the operation in the web UI:
• Given User is the author of the operation
• Permissions and abilities are verified
• Audits are created for that User
20. WSDL reading example
Required:
• xml
• parentFolderId or parentFolderPath
• name
Optional:
• expirationFolderId or expirationFolderPath
• metadataSetId or metadataSetPath
• Metadata fields (title, displayName, etc.)
• siteId or siteName
36. PHP code examples
https://github.com/hannonhill/Webservices-PHP-
Sample-Project
Use correct branch
Not always backwards compatible
Follow "Web Services Changelog" for each version
http://www.hannonhill.com/kb/Web-
Services/Web%20Services%20Changelog/index.html
37. Limitations
• Can’t access past versions of assets and drafts
• Can’t render assets
• Can’t use tools
• Can’t change preferences
• Can’t change configuration files
• Can’t view or interact with publish queue
• Certain operations can be limited
38. What is coming in Cascade 7.2
• ListAllSites
• ReadWorkflowSettings
• EditWorkflowSettings
• ListSubscribers
• Providing Destinations when publishing
• “Maintain absolute links” for Pages
