ContentDirector features supported by the API

About API classes

The API includes classes that define the ContentDirector objects used by the API. These classes are limited to those pertaining to the assignment and those used to define the job. The methods for the job set and return job parameters. The methods for the destination group, destination, and policy objects return the parameters only.

Connection interfaces

The API can perform the following tasks in conjunction with the ContentDirector database:

Establish a secure connection to the ContentDirector server and return a handle used to authenticate subsequent transactions
Retrieve objects from the database
Transfer local objects to the database
Close the connection to the server

The user name and password must be be associated with an account that has system administrator privileges. However, for security reasons, the default system administrator user/password of super/super cannot be used to access the API.

Job component interfaces

These interfaces retrieve lists of component objects with associated IDs. The IDs can then be used in subsequent calls to include the component in a job or to retrieve the parameters of the component. For example, after retrieving a policy ID, you can find out the commit quorum set in that policy.

The job component interfaces can retrieve the following components:

Destination groups
Destinations
Policies
Default policy
List of all policies associated with the user

Job interfaces

The job interfaces are used to retrieve job IDs. The job IDs are used in content distribution calls, in job modification and deletion calls, and to retrieve job components and assignments.

The job interfaces can perform the following tasks:

Create jobs
Run jobs
Modify jobs
Delete jobs
Retrieve all job IDs associated with the user
Retrieve all job IDs of a particular status
Retrieve the history of a job
Retrieve the ID of the last assignment that ran for a specific job

Content distribution interface

The content distribution interface initiates the content distribution event. This call returns a job Assignment ID that can be used to retrieve the status of the assignment.

Assignment interfaces

The assignment interfaces enable you to retrieve the status code and assignment type of a job assignment. See CdAssignment > getAssignmentTypeId() in the Javadoc for a list of assignment types.

Features not supported by the API

The ContentDirector API does not access the following features of ContentDirector:

User rights scheme--the API user must be a ContentDirector system administrator
Content sources
Preferences
Contacts

The API has one additional limitation: It supports only compiled Java code. Scripts and command line input are not supported.