You're not viewing the latest version. Click here to go to latest.
logo
DaSCH Service Platform Documentation
OpenApi Documentation
Initializing search
    • Overview
    • DSP-APP
    • DSP-API
    • DSP-TOOLS
    • DSP-INGEST
    • Developers
    • Overview
      • Introduction
        • Introduction
        • Project Administration
        • System Administration
          • Start from scratch
          • Search and browse
          • Search results
          • Work on your data
        • User Profile
        • How to contribute
        • Docs Documentation
        • Release Notes
        • Overview
        • What is DSP?
        • File Formats in DSP-API
        • Standoff/RDF Text Markup
        • An Example Project
        • Introduction
        • The Knora Base Ontology
        • The SALSAH GUI Ontology
          • Introduction
          • Authentication
          • Reading and Searching Resources
          • Reading the User's Permissions on Resources and Values
          • Getting Lists
          • Gravsearch - Virtual Graph Search
          • Creating and Editing Resources
          • Creating and Editing Values
          • Querying, Creating, and Updating Ontologies
            • Overview
            • Standard Standoff Markup
            • Custom Standoff Mapping
            • TEI XML
          • Permalinks
          • IRIs
          • Introduction
          • Overview
          • Users Endpoint
          • Projects Endpoint
          • Groups Endpoint
          • Lists Endpoint
          • Permissions Endpoint
          • Stores Endpoint
          • OpenApi Documentation
          • Version
          • Introduction
          • Health Endpoint
          • Metrics Endpoint
        • Publishing
        • Configuration
        • Updating Repositories when Upgrading DSP-API
            • 0001 Record Architectural Decisions
            • 0002 Change Cache Service Manager from Akka-Actor to ZLayer
            • 0003 Change IIIF Service Manager and Sipi implementation to zlayer
            • 0004 Change Triplestore Service Manager and Fuseki implementation to ZLayer
            • 0005 Change ResponderManager to a simple case class
            • 0006 Gradually Replace Akka-HTTP with ZIO-HTTP
            • 0007 ZIO-fication of Responders
            • 0008 Replace Akka with Pekko
            • Design Overview
            • Futures with Pekko
            • HTTP Module
            • Store Module
            • Triplestore Updates
            • Consistency Checking
            • Authentication
            • RDF Processing API
            • API v2 Design Overview
            • Ontology Schemas
            • Smart IRIs
            • Content Wrappers
            • How to Add an API v2 Route
            • JSON-LD Parsing and Formatting
            • Ontology Management
            • DSP-API and Sipi
            • Gravsearch Design
            • Standoff Markup
            • Archival Resource Key (ARK)
            • SPARQL Query Design
          • Admin API Design
            • Domain Entities and Relations
            • System Instances
            • Class and Property Hierarchies
          • Overview
          • Build and Running
          • Setup Visual Studio Code for development of DSP-API
          • Testing
          • Docker Cheat Sheet
          • Starting the DSP-Stack inside Docker Container
          • Updating Repositories
          • Generating Client Test Data
          • Third-Party Dependencies
        • Overview
        • Setting Up Sipi for DSP-API
        • Interaction between Sipi and DSP-API
        • Lucene Query Parser Syntax
      • Frequently Asked Questions
        • Changelog
      • Overview
      • CLI commands
          • Overview
          • Ontologies
          • Caveats
        • XML data file
        • excel2json
        • excel2xml
      • Incremental xmlupload
      • excel2xml module
      • Running DSP locally
        • Developers documentation
        • Dependencies, packaging & distribution
        • Maintaining the start-stack command
        • User data
        • GitHub actions
        • MkDocs and markdown-link-validator
          • Overview
          • General formatting
          • Python formatting
          • Python docstring formatting
          • Python type checking
          • Python linting
          • Security checks
          • See also
      • Changelog
        • Introduction
        • Ingesting Assets
          • Projects Endpoints
          • Monitoring Endpoints
          • Maintenance Endpoints
          • Authentication
          • Configuration
          • Filesystem Setup
      • Getting Started
        • Introduction
        • RDF
        • Sipi
        • Libraries
      • Contribution

    OpenApi Documentation

    We provide an OpenAPI specification. The latest version is located at api.dasch.swiss/api/docs/docs.yaml. For an interactive documentation of all API endpoints, please visit api.dasch.swiss/api/docs/.

    OAD

    March 19, 2024
    Made with Material for MkDocs