QMENTA Client API Documentation

Note

This is the QMENTA Client API library that allows interaction with the QMENTA Platform. This API implementation does not intend to fully support all of the QMENTA Platform functionalities, and is provided only as a solution to automate tasks. Please remember that this documentation is a work in progress. API design will change and it is not stable by any meaning.

You can install the library using PyPI, see Installation.

Suggestions and requests are welcomed at dev@qmenta.com.

Contents:

• Installation
• Tutorial: QMENTA Client API
  • Logging In and Activating a QMENTA Project
    • Log in
    • Activate a Project
    • Next Steps
  • Data Handling
    • Bulk Upload of Data by Subject
    • Upload Data by Session
    • Delete a Session
    • Delete a Subject
    • Download Files from a Session
    • Next Steps
  • Data Searches
    • Search for a Specific Subject
    • Advanced Search
    • Search of Input Containers
    • Next Steps
  • Metadata Handling
    • Project-level Metadata
    • Project-level Metadata Modification
    • File-level Metadata
    • File-level Metadata Modification
    • Quality Check (QC) Status
    • Protocol Adherence Automation Analysis
      • Protocol Adherence Rules
    • Next Steps
  • Analyses Execution
    • Start an Analysis
    • Delete an Analysis
    • Restart an Analysis
    • Quality Check (QC) Status
    • Get Analysis Logs
    • Next Steps
  • Results Handling
    • List all Analyses
    • Search Analyses
    • Download Results
• Glossary
• API Reference
  • Account Class
  • Project Class

Indices and tables

• Index

• Search Page