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
Document methods
Favorite methods
Use the methods in this section to create and manage topics a user flagged as favorites.

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
  - /documents/{docPath}/newVersionWithTrackerLink - Add tracker link when document checked in
    Checks in the working copy of the document and unlocks it. It also takes an additional piece of info (trackerId) in the request body, which is saved in the customProperties of the document. This is similar to how check in comments are saved.
  - /documents/{docPath}/cloneDocument - Clone document
    Create a clone of a document.
  - /files - Retrieve document content
    Returns the content of the a document.
  - /documents/{docPath}/prepareForEdit - (DRM only) Edit document
    Prepares the document for editing in the selected branches,
  - /documents/{docPath}/lockState - (Standard only) Edit document
    Locks the document for the current user and prepares it for editing.
  - /files - Save document content
    Updates the working copy of the document.
  - /documents/{docPath}/newVersion - Check in document
    Checks in the working copy of the document and unlocks it.
  - /documents/{docPath}/lockState - Unlock document and revert edits
    Unlocks the document for the current user. All changes made to the content are lost.
  - /documents/{docPath}/revisionHistory - Get revision history
    Returns the revision history of the current document.
  - /documents/{docPath}/revertTo - Revert to a previous revision
    Revert the document content to the content of a previous revision.
  - /documents/{docPath}/nextStatuses - Get roles and status information
    Returns all the possible roles and statuses for the document.
  - /documents/{docPath}/addAssignments - Add assignments to a document
    Creates or adds assignments for a document.
  - /documents/{docPath}/moveAssignments - Change assignments
    Changes the assignments for a document.
  - /documents/{docPath}/moveStatus - Change status
    Changes the status of the document.
  - /documents/{docPath}/userProperties - Read user properties
    Returns all user properties for the document.
  - /documents/{docPath}/userProperties - Write user properties
  - /documents/{docPath}/deleteDocument - Delete a document
    This method deletes a document with no dependencies.
  - Approval and Collaborative Review methods
  - Document creation
  - Document dependencies
  - Favorite methods
    Use the methods in this section to create and manage topics a user flagged as favorites.
    - /sessions/currentUser/favourites/{id}/rename - Rename a folder in a user's favorites
      Renames a folder in the current user's favorites.
    - /sessions/currentUser/favourites/{id} - Remove an object from favorites
      Removes a document (an "object" in IXIA CCMS Web) or folder from a user's list of favorites.
    - /sessions/currentUser/favourites/{id}/move - Move an item in favorites
      Moves a document or folder in a user's favorites to a new location.
    - /sessions/currentUser/favourites - Get favorites for a user
      Returns the list of favorites for the current user.
    - /sessions/currentUser/favourites/{targetId}/addEntry - Add an object to favorites
      Adds a document, identified as an "object" in IXIA CCMS Web, to a user's list of favorites.
    - /sessions/currentUser/favourites/{targetId}/addFolder - Add a folder to a user's favorites
      Adds a folder to a user's list of favorites. Folders organize the documents in a user's favorites.
  - Resource methods
  - Search and replace methods
    Use the methods in this section to directly retrieve information about the CCMS content with document identifiers, and then replace a specific string within that content.
  - Search and retrieval methods
  - Snapshot methods
    Use the methods in this section to create and manage snapshots.
  - Structure view for Map Editor
  - Worklist methods
    Use the methods in this section to create and manage worklists.
- 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.

Favorite methods

Use the methods in this section to create and manage topics a user flagged as favorites.

Generated by IXIA CCMS oXygen Webhelp