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
Unified localization methods
Use the methods in this section to manage the localization of source maps in the CCMS into multiple target languages.
ULM dependencies
Use the methods in this section to manage the dependencies created during the localization of source maps in the CCMS into multiple target languages.

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
- 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.
  - documents/{docPath}/createManifest - Create a translation manifest
    Use this method to create a translation manifest. This method pertains only to a translation manifest, not to its children language manifests.
  - /manifests/{docpath}/{locale} - Create a language manifest
    This method creates a language manifest in locale for related translation manifest in the docpath.
  - /manifests/{docpath} - Get a manifest
    Use this method to obtain a translation or language manifest.
  - /manifests/{docpath}/header - Modify a translation manifest
    Use this method to permit modification of the title or description of the translation manifest.
  - /manifests/{docpath}/prepareKit - Initiate preparation of localization kit
    Use this method to prepare the localization kit before submitting it to a translation agency.
  - /manifests/{docpath}/references - Modify directives to the translation agency
    Use this method to modify the directives provided to the translation agency vendor for one or more items.
  - /documents/${docPath}/prepareForEditTranslation - Prepare a document in translation for an edition
    Use this method to prepare a document in translation for an edition.
  - /manifests/importKit - Import a localization kit
    Use this method to import a localization kit returned from a translation agency.
  - ULM dependencies
    Use the methods in this section to manage the dependencies created during the localization of source maps in the CCMS into multiple target languages.
    - /documents/${docPath}/manifestsOfMap - Return all manifests of the map
      This method returns all language manifests and translation manifests created from a map.
    - /documents/${docPath}/languageManifests - Get all language manifests of a translation manifest
      Use this method to retrieve all language manifests associated with a translation manifest.
    - /documents/${docPath}/languageManifestsOf - Get the language manifests of a map or topic in translation
      Use this method to retrieve the language manifests of a map or topic that is already in translation.
    - /documents/${docPath}/translationManifest - Get a translation manifest for a language manifest
      Use this method to retrieve a translation manifest that is associated with a language manifest.
    - /documents/${docPath}/translationManifestsOf - Get the translation manifests for a map or topic in translation
      Use this method to retrieve the translation manifests that are associated with a map or topic already in translation.

ULM dependencies

Use the methods in this section to manage the dependencies created during the localization of source maps in the CCMS into multiple target languages.

Generated by IXIA CCMS oXygen Webhelp