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
Search and retrieval 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
- 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
    - /documents/search - Get search parameters
      Returns all the possible values for the search parameters.
    - /documents/search - Run a search
      Searches the CCMS and returns the first 50 results.
    - /documents/searchEx - Run an Advanced Search
      Searches the CCMS and returns the first 50 results.
    - /documents/search/next - Get next search results
      Returns 50 results from an existing CCMS search result. It can be any sequence of 50 documents from the search results, starting at the position specified. It will be less than 50 if results_count - start_position < 50.
    - /documents/search/sort - Sort search results
      Sorts an existing search result and returns the first 50 results.
    - /documents/search/subList - Update search results
      Returns updated information for a selection of documents from an existing CCMS search result. Use this method if you have executed an operation on some documents from the search result and want updated information for those documents.
    - /documents/images/searchResult - Search for images
      Searches for images matching the criteria.
    - /documents/general/subList - Get document information
      Retrieves the document information for a list of documents.
  - 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.

Search and retrieval methods

Use the methods in this section to retrieve information about the content in the CCMS, either via search or directly with document identifiers.

Generated by IXIA CCMS oXygen Webhelp