Jump to main content

IXIASOFT CCMS 6.1 - REST API Documentation

Important Information
Methods
Data Structures

Home
Methods
Description of all the methods available in the API
System Administration Methods

Methods
Description of all the methods available in the API
- General Considerations
- Login
  Authenticates the user in CCMS.
- Logout
  Closes the session.
- Configuration Information Methods
- Search and Retrieval Methods
- Document Methods
- DRM Methods
- Output Generation Methods
- System Administration Methods
  - List active sessions
    Returns all active sessions in CCMS Web.
  - Refresh Configuration
    Forces CCMS Web to reload its configuration.
  - Add/Update Template Definition
    Adds or modifies a template definition.
  - Delete Template Definition
    Deletes a template definition.
  - Read Users File
    Returns the content of the users.xml configuration file.
  - Save Users File
    Updates the content of the users.xml configuration file.
  - Get Lock Information for Configuration File
    Returns the lock information for a configuration file.
  - Lock Configuration File
    Locks a configuration file.
  - Unlock Configuration File
    Unlocks a configuration file.

System Administration Methods

These methods are used to administer the CCMS.

Note: These methods are only available to users that are part of the System Administrators group.

Generated by IXIASOFT CCMS oXygen Webhelp