ConnectCloud Developers

The module configuration (tenant:dms:read)

GET /api/dms/v1/config

Module: DMS · operationId: getConfig · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

A tenant without configuration gets {"active": false, "wormCompliance": false}.

Responses

  • 200 Configuration (application/json)

Fields of the 200 answer:

  • active (boolean): The module is active for the tenant
  • classification (object): Document classifier of incoming documents (Original-Eingangsbelege); omitted = defaults
    • enabled (boolean): The document classifier is on (default true)
    • minConfidence (number): Proposals from this confidence on are taken over; below it they wait for review (default 0.85; max 1)
  • defaultRetentionDays (integer): Default retention in days
  • defaultStorageClass (string): Default storage class
  • extraction (object): Text extraction settings; omitted = defaults
    • enabled (boolean): Text extraction is on (default true)
    • layoutCategories (array of string): Document types whose digital pages still go to AI OCR for layout
    • maxPages (integer): Page limit per document (default 200; max 2000)
  • wormCompliance (boolean): WORM compliance mode

Example 200 answer:

{
  "active": true,
  "classification": {
    "enabled": true,
    "minConfidence": 0.85
  },
  "defaultRetentionDays": 3650,
  "defaultStorageClass": "STANDARD",
  "extraction": {
    "enabled": true,
    "layoutCategories": [
      "delivery_note"
    ],
    "maxPages": 200
  },
  "wormCompliance": true
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/dms/v1/config' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI