Jump to main content

IXIA CCMS REST API Documentation

Important information
Changes between 7.4 and 7.5
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
- Access to session
  Use the methods in this section to provide users access to and exit from the CCMS .
- Configuration information methods
  - /configuration/generalConfig - Get system information
    Returns information about the system, such as version, server, and docbase.
  - /configuration/methods/{objectType} - List roles for creation
    Returns a list of roles that are allowed to create documents.
  - /configuration/templates/{objectType}/list - List template files
    Returns a list of all templates available for an object type.
  - /configuration/webTemplates/{objectType}/list - List template definitions
    Returns a list of template definitions for the given object type.
  - /configuration/imageFormatsConfig - Get image formats
    Returns a list of the image formats (LowRes, HiRes, etc.) configured in the CCMS.
  - /configuration/imageExtensionConfig - Get image extensions
    Returns a list of the image extensions (".png", ".jpg", etc.) configured in the CCMS.
  - /configuration/imageTypes - Get image types
    Returns a list of the image types (Screenshot, Line Art, etc.) configured in the CCMS.
  - /configuration/languages/authoring - Get languages
    Returns a list of all the languages configured for use in the CCMS.
  - /configuration/rolesAndInitialStatus - Get initial status and roles for object type
    Returns a list of roles that are associated to an object type.
  - /configuration/documentStatuses - Get document statuses
    This method retrieves a list of all status types for the requested document types and cycles, so that users can choose a specific bulk status change from those documents in the list that are available for that given action.
  - /configuration/additionalColumnDefinitions - Get additional column definitions
    Gets information for any custom columns in the IXIA CCMS configuration that need to be displayed in a Dynamic Grid.
- Document methods
- DRM methods
- Output generation methods
- Spell checker methods
  Use the methods in this section to manage the Spell Checker feature.
- System administration methods
- Taxonomy methods
- Unified localization methods
  Use the methods in this section to manage the localization of source maps in the CCMS into multiple target languages.

Configuration information methods

Use the methods in this section to retrieve information from the CCMS configuration that is required for other methods.

Generated by IXIA CCMS oXygen Webhelp