Jump to main content

IXIASOFT CCMS 6.3 - REST API Documentation

Important Information
Changes between 6.2 and 6.3
Methods
Data Structures

Home
Methods
Description of all the methods available in the API
Configuration Information Methods

Methods
Description of all the methods available in the API
- Login
  Authenticates the user in CCMS.
- Logout
  Closes the session.
- Configuration Information Methods
  - Get System Information
    Returns information about the system (version, server, docbase, etc.).
  - Get current user profile
    Returns the profile information for the current user.
  - List Roles for Creation
    Returns a list of roles that are allowed to create documents.
  - List Template Files
    Returns a list of all templates available for an object type.
  - List Template Definitions
    Returns a list of template definitions for the given object type.
  - Get External Types
    Provides the information to determine if a reference is external or not.
  - Get Image Formats
    Returns a list of the image formats (LowRes, HiRes, etc.) configured in the CCMS.
  - Get Image Extensions
    Returns a list of the image extensions (".png", ".jpg", etc.) configured in the CCMS.
  - Get Image Types
    Returns a list of the image types (Screenshot, Line Art, etc.) configured in the CCMS.
  - Get Languages
    Returns a list of all the languages configured for use in the CCMS.
  - Get Initial Status and Roles for Object Type
    Returns a list of roles that are associated to an object type.
- Search and Retrieval Methods
- Document Methods
- Approval and Collaborative Review Methods
- DRM Methods
- Output Generation Methods
- System Administration Methods

Configuration Information Methods

These methods are used to retrieve information from the CCMS configuration that is required for other methods.

Generated by IXIASOFT CCMS oXygen Webhelp