Bardioc APIs

Versions and specifications of the APIs this platform serves.

Resources

Developer portal is available at dev-portal.test.engine.datagroup.de
User guides is available at user-guides.test.engine.datagroup.de

Developer information

The current APIs in JSON format are at /api/version, which client software can use to check its own compatibility.
The full list of supported versions is at /api/versions.

Available APIs

Base URL https://core.test.engine.datagroup.de

Name	Version	Lifecycle	Status	Endpoint	Protocol	Spec
action	1.0	stable	supported	/api/action/1.0/	—	↗
action-ws	1.0	stable	supported	/api/action-ws/1.0/	action-1.0.0	↗
app	7.0	stable	supported	/api/app/7.0/	—	↗
app-admin	1.2	internal	supported	/api/app-admin/1.2/	—	↗
auth	6.6	stable	supported	/api/auth/6.6/	—	↗
authz	6.1	internal	supported	/api/authz/6.1/	—	↗
events-ws	6.2	deprecated	supported	/api/events-ws/6.2/	events-1.0.0	↗
graph	7.4	stable	supported	/api/graph/7.4/	—	↗
graph-ws	6.1	stable	supported	/api/graph-ws/6.1/	graph-2.0.0	↗
health	7.0	stable	supported	/api/health/7.0/	—	↗
iam	6.2	internal	supported	/api/iam/6.2/	—	↗
ki	6	stable	unsupported	/api/ki/6/	—	↗
timeseries	1.0	stable	supported	/api/timeseries/1.0/	—	↗
transaction	1.0	experimental	unsupported	/api/transaction/1.0/	—	↗
variables	6	stable	unsupported	/api/variables/6/	—	↗

Base URL connectors.test.engine.datagroup.de

Name	Version	Lifecycle	Status	Endpoint	Protocol	Spec
connector-framework	0.6	experimental	supported	/	grpcs	↗

↗ OpenAPI rendering demo, not served by any backend

↗ AsyncAPI rendering demo, not served by any backend

↗ Protobuf (gRPC) rendering demo, not served by any backend

Status

Name	Description
supported	The API is supported, bugs are actively fixed, help is available via support. Use for production.
unsupported	The API is not supported. Do not use.

Lifecycle

Name	Description
experimental	The API is fresh. Expect changes without prior notice. May be removed at any time without warning.
stable	The API is stable. Backwards compatibility is looked out for. Use for production.
deprecated	The API is deprecated and will be removed. Do not use and actively switch to a replacement.
internal	The API is accessible only for internal use.
removed	The API is removed and has ceased to function.

Version document

{
  "action": {
    "version": "1.0",
    "endpoint": "/api/action/1.0/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "action.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "action-ws": {
    "version": "1.0",
    "endpoint": "/api/action-ws/1.0/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "action-1.0.0",
    "specs": "action-ws.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "app": {
    "version": "7.0",
    "endpoint": "/api/app/7.0/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "app.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "app-admin": {
    "version": "1.2",
    "endpoint": "/api/app-admin/1.2/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "internal",
    "protocols": "",
    "specs": "app-admin.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "auth": {
    "version": "6.6",
    "endpoint": "/api/auth/6.6/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "auth.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "authz": {
    "version": "6.1",
    "endpoint": "/api/authz/6.1/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "internal",
    "protocols": "",
    "specs": "authz.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "connector-framework": {
    "version": "0.6",
    "endpoint": "/",
    "lifecycle": "experimental",
    "protocols": "grpcs",
    "specs": "connector-framework.proto",
    "support": "supported",
    "host": "connectors.test.engine.datagroup.de",
    "docs": "https://core.test.engine.datagroup.de/help"
  },
  "events-ws": {
    "version": "6.2",
    "endpoint": "/api/events-ws/6.2/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "deprecated",
    "protocols": "events-1.0.0",
    "specs": "events-ws.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "graph": {
    "version": "7.4",
    "endpoint": "/api/graph/7.4/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "graph.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "graph-ws": {
    "version": "6.1",
    "endpoint": "/api/graph-ws/6.1/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "graph-2.0.0",
    "specs": "graph-ws.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "health": {
    "version": "7.0",
    "endpoint": "/api/health/7.0/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "health.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "iam": {
    "version": "6.2",
    "endpoint": "/api/iam/6.2/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "internal",
    "protocols": "",
    "specs": "iam.yaml",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "ki": {
    "version": "6",
    "endpoint": "/api/ki/6/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "ki.yaml",
    "support": "unsupported",
    "host": "core.test.engine.datagroup.de"
  },
  "timeseries": {
    "version": "1.0",
    "endpoint": "/api/timeseries/1.0/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "timeseries.json",
    "support": "supported",
    "host": "core.test.engine.datagroup.de"
  },
  "transaction": {
    "version": "1.0",
    "endpoint": "/api/transaction/1.0/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "experimental",
    "protocols": "",
    "specs": "transaction.yaml",
    "support": "unsupported",
    "host": "core.test.engine.datagroup.de"
  },
  "variables": {
    "version": "6",
    "endpoint": "/api/variables/6/",
    "docs": "https://core.test.engine.datagroup.de/help",
    "lifecycle": "stable",
    "protocols": "",
    "specs": "variables.yaml",
    "support": "unsupported",
    "host": "core.test.engine.datagroup.de"
  }
}

Versions document

{
  "action": [
    {
      "version": "1.0",
      "endpoint": "/api/action/1.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "action.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "action-ws": [
    {
      "version": "1.0",
      "endpoint": "/api/action-ws/1.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "action-1.0.0",
      "specs": "action-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "app": [
    {
      "version": "7",
      "endpoint": "/api/app/7/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "app.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 7.x"
    },
    {
      "version": "7.0",
      "endpoint": "/api/app/7.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "app.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "app-admin": [
    {
      "version": "1",
      "endpoint": "/api/app-admin/1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "app-admin.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 1.x"
    },
    {
      "version": "1.0",
      "endpoint": "/api/app-admin/1.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "app-admin.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "1.1",
      "endpoint": "/api/app-admin/1.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "app-admin.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "1.2",
      "endpoint": "/api/app-admin/1.2/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "app-admin.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "auth": [
    {
      "version": "6",
      "endpoint": "/api/auth/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 6.x"
    },
    {
      "version": "6.0",
      "endpoint": "/api/auth/6.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.1",
      "endpoint": "/api/auth/6.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.2",
      "endpoint": "/api/auth/6.2/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.3",
      "endpoint": "/api/auth/6.3/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.4",
      "endpoint": "/api/auth/6.4/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.5",
      "endpoint": "/api/auth/6.5/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.6",
      "endpoint": "/api/auth/6.6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "auth.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "authz": [
    {
      "version": "6",
      "endpoint": "/api/authz/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "authz.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 6.x"
    },
    {
      "version": "6.0",
      "endpoint": "/api/authz/6.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "authz.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.1",
      "endpoint": "/api/authz/6.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "authz.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "connector-framework": [
    {
      "version": "0.6",
      "endpoint": "/",
      "lifecycle": "experimental",
      "protocols": "grpcs",
      "specs": "connector-framework.proto",
      "support": "supported",
      "host": "connectors.test.engine.datagroup.de",
      "docs": "https://core.test.engine.datagroup.de/help"
    }
  ],
  "events-ws": [
    {
      "version": "6",
      "endpoint": "/api/events-ws/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "deprecated",
      "protocols": "events-1.0.0",
      "specs": "events-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 6.x"
    },
    {
      "version": "6.0",
      "endpoint": "/api/events-ws/6.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "deprecated",
      "protocols": "events-1.0.0",
      "specs": "events-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.1",
      "endpoint": "/api/events-ws/6.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "deprecated",
      "protocols": "events-1.0.0",
      "specs": "events-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.2",
      "endpoint": "/api/events-ws/6.2/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "deprecated",
      "protocols": "events-1.0.0",
      "specs": "events-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "graph": [
    {
      "version": "7",
      "endpoint": "/api/graph/7/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "graph.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 7.x"
    },
    {
      "version": "7.0",
      "endpoint": "/api/graph/7.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "graph.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "7.1",
      "endpoint": "/api/graph/7.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "graph.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "7.2",
      "endpoint": "/api/graph/7.2/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "graph.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "7.3",
      "endpoint": "/api/graph/7.3/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "graph.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "7.4",
      "endpoint": "/api/graph/7.4/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "graph.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "graph-ws": [
    {
      "version": "6",
      "endpoint": "/api/graph-ws/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "graph-2.0.0",
      "specs": "graph-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 6.x"
    },
    {
      "version": "6.0",
      "endpoint": "/api/graph-ws/6.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "graph-2.0.0",
      "specs": "graph-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.1",
      "endpoint": "/api/graph-ws/6.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "graph-2.0.0",
      "specs": "graph-ws.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "health": [
    {
      "version": "7",
      "endpoint": "/api/health/7/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "health.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 7.x"
    },
    {
      "version": "7.0",
      "endpoint": "/api/health/7.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "health.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "iam": [
    {
      "version": "6",
      "endpoint": "/api/iam/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "iam.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 6.x"
    },
    {
      "version": "6.0",
      "endpoint": "/api/iam/6.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "iam.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.1",
      "endpoint": "/api/iam/6.1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "iam.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    },
    {
      "version": "6.2",
      "endpoint": "/api/iam/6.2/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "internal",
      "protocols": "",
      "specs": "iam.yaml",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "ki": [
    {
      "version": "6",
      "endpoint": "/api/ki/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "ki.yaml",
      "support": "unsupported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "timeseries": [
    {
      "version": "1.0",
      "endpoint": "/api/timeseries/1.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "timeseries.json",
      "support": "supported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "transaction": [
    {
      "version": "1",
      "endpoint": "/api/transaction/1/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "experimental",
      "protocols": "",
      "specs": "transaction.yaml",
      "support": "unsupported",
      "host": "core.test.engine.datagroup.de",
      "note": "access to latest stable 1.x"
    },
    {
      "version": "1.0",
      "endpoint": "/api/transaction/1.0/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "experimental",
      "protocols": "",
      "specs": "transaction.yaml",
      "support": "unsupported",
      "host": "core.test.engine.datagroup.de"
    }
  ],
  "variables": [
    {
      "version": "6",
      "endpoint": "/api/variables/6/",
      "docs": "https://core.test.engine.datagroup.de/help",
      "lifecycle": "stable",
      "protocols": "",
      "specs": "variables.yaml",
      "support": "unsupported",
      "host": "core.test.engine.datagroup.de"
    }
  ]
}