Jump to main content

IXIASOFT CCMS 6.1 - REST API Documentation

Important Information
Methods
Data Structures

Home
Methods
Description of all the methods available in the API
Search and Retrieval Methods

Methods
Description of all the methods available in the API
- General Considerations
- Login
  Authenticates the user in CCMS.
- Logout
  Closes the session.
- Configuration Information Methods
- Search and Retrieval Methods
  - Get Search Parameters
    Returns all the possible values for the search parameters.
  - Run a Search
    Searches the CCMS and returns the first 50 results.
  - Get Next Search Results
    Returns 50 results from an existing search results. 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.
  - Sort
    Sorts the existing search result and returns the first 50 results.
  - Update search results
    Returns updated information for a selection of documents from a search results. Use this method if you have executed an operation on some documents from the search results and want updated information for those documents.
  - Search for Images
    Searches for images matching the criteria.
  - Retrieve Documents Information
    Retrieves the document information for a list of documents.
- Document Methods
- DRM Methods
- Output Generation Methods
- System Administration Methods

Search and Retrieval Methods

These methods are used to retrieve information about the content in the CCMS, either via search or directly with document identifiers.

Generated by IXIASOFT CCMS oXygen Webhelp