Modules API

List module readiness and enablement

List module readiness and enablement for the current workspace.

GET/v1/modules

capability modules.list · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

This operation has no request fields.

Response

Successful responses use Dawn's data envelope.

dataModuleStateListrequired
- id"scheduling"required
- enabledbooleanrequired
- defaultEnabledbooleanrequired
- settingKey"modules.scheduling.enabled"required
- appsobjectrequired
  - apiobjectrequired
  - dawnobjectrequired
  - patientobjectrequired
  - agentsobjectrequired
metaobject

Errors

Error responses use the shared error envelope.

401Authentication is required.
503Module settings are temporarily unavailable.

Request

import { createDawnClient } from "@dawn/api";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["modules.list"]();

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": [
    {
      "id": "scheduling",
      "enabled": true,
      "defaultEnabled": true,
      "settingKey": "modules.scheduling.enabled",
      "apps": {
        "api": {
          "ready": true,
          "status": "enabled"
        },
        "dawn": {
          "ready": true,
          "status": "enabled"
        },
        "patient": {
          "ready": true,
          "status": "enabled"
        },
        "agents": {
          "ready": true,
          "status": "enabled"
        }
      }
    }
  ],
  "meta": {}
}