'dmsquery' capability for WebSocket User API

Contents

Overview

Execution of an arbitrary SQL Select query against the DB of the class model data. Request and response format, restrictions, and warnings are as in WebSocket Token API.

Access to the capability is determined by user roles (route /ws#dmsquery, WEBSOCKET method). Read permissions for individual classes in the REST API are not checked when executing the query. Access to the query is additionally limited by the ws role parameter dmsquery_mode: by default (admin) — only for users and integration channels with the admin role.

Example request
[
  "dmsquery",
  {
    "qid": 0.1234,
    "classpath": "/rest/v1/model/SomeClass",
    "sqlText": "Select id as i, name From SomeSchema.SomeTable"
  }
]