ColdFusion API (Direct iCM Requests)

The Java (CSObjects) API does not provide any functionality for actions which are carried out by an iCM user. This will immediately become apparent to the developer who wants to use the worker to create content (typically articles and media items) in iCM. Elements of the ColdFusion API are provided to fill this gap.

iCM requests using the ColdFusion API begin iCM_ and are followed by the name of the ColdFusion API module. Parameters to be passed to the ColdFusion API module are included in the attributes sub-key of the parameters map. When making this type of request, an authorisation header must also be supplied that identifies an iCM user with sufficient privileges to perform the requested operation.

When using the worker via an end point, the user details should be provided using an API Key which supplies default credentials of a user with sufficient privileges to create iCM content. See API Server Security for more information about creating keys.

Direct iCM requests via the ColdFusion API should be used sparingly as they are not as efficient as using the Java (CSObjects) API. Further working examples can also be found in Getting Started Using the iCM API Worker.

API