Skip to content

MDMS API Support (REST/Swagger)

The core functionalities of the MARS Data Mining Studio (MDMS) are programmatically accessible through a RESTful Application Programming Interface (API). This API adherence to the REST architectural style allows for interoperability with various programming languages and platforms. It is typically documented using the Swagger framework (OpenAPI Specification), which provides an interactive way to understand and test the available API endpoints.

Key Benefits and Use Cases of the MDMS API:

  • Automation: Enables the automation of complex data extraction and transformation tasks. External scripts, applications, or orchestration tools (like MARS Watcher) can trigger MDMS processes without manual intervention through the MDMS user interface.
  • Integration: Facilitates the seamless integration of MDMS's powerful data processing capabilities into larger enterprise workflows or custom applications. For instance, a document ingestion workflow could automatically call the MDMS API to extract key metadata from newly arrived documents.
  • Scalability: Allows organizations to build scalable solutions where data processing load can be distributed or managed programmatically based on demand.
  • Custom Reporting: Enables the programmatic triggering of custom report generation based on data extracted and structured by MDMS from various sources.
  • Flexibility: Provides developers with the flexibility to leverage MDMS features within their preferred development environment and tooling.

Standard API interactions likely include endpoints for submitting processing jobs (specifying input data sources and the relevant MDMS template/config file), monitoring job status, and retrieving the structured output results. Authorization typically employs standard secure methods like OAuth 2.0 Bearer Tokens. The Swagger documentation provides detailed specifications for endpoints, request/response formats, and authentication requirements.