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
Structure view for Map Editor

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.
  - 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
    - /documents/mapSession - Open map session
      Use the methods in this section to create a map session where a user can edit a map.
    - /documents/mapSession - Get map session for document path
      Gets the map session ID for a document path.
    - /documents/mapSession/{sessionId} - Get map session
      Returns the current state of the map session for a user editing a map.
    - /documents/mapSession/{sessionId}/updateTitle - Update the title of a map
      Changes the map title in Structure view when a map session is open.
    - /documents/mapSession/{sessionId}/expand - Expand the map
      When a map loads in CCMS Web, submaps do not load until they are expanded. This method expands a submap.
    - /documents/mapSession/{sessionId}/generateStub - Generate stub element in map
      If a map already has topic stubs, this creates a new topic to replace a topic stub.
    - /documents/mapSession/{sessionId}/insertFirstChild - Insert element as first child
      Inserts the element in a map as first child of parent element.
    - /documents/mapSession/{sessionId}/insertAtSameLevel - Insert element at same level to map
      Inserts a new element at the same level as a sibling element in a map.
    - /documents/mapSession/{sessionId}/moveAsFirstChild - Move map element as first child
      Moves an element within a map to be the first child of another element.
    - /documents/mapSession/{sessionId}/moveAtSameLevel - Move map element to same level
      Moves an element within a map to be the sibling of another element.
    - /documents/mapSession/{sessionId}/deleteElement - Delete an element from a map
      Deletes an element from a map.
    - /documents/mapSession/{sessionId} - Close a map
      Close a map and ends the session for the map.
    - /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.
  - 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.

Structure view for Map Editor

Use the methods in this section to manage maps while in Map Editor's Structure view.

Generated by IXIA CCMS oXygen Webhelp