All endpoints within the Janus API share a common root:

https://services.mhs.com/Janus/2022-10/

Where “2022-10”, in this example, is the version number of the API being implemented. 2022-10 is presently the latest implementation of the Janus API.

In order to successfully make a request to the Janus API, a subscription key must be provided along with the request body. The subscription key should be included in a header named “Ocp-Apim-Subscription-Key". These keys should always be treated as confidential information; API keys provide unrestricted API access to your account, licensed processes, and, potentially based on policy, your organization’s data.

There are some JSON body properties that are shared between most endpoints within the Janus API:

host

"host": {
    "computeProvider": {},
    "storageProvider": {},
    "invokeAsAsynchronous": false
},

Contains details about how a job is run. The "computeProvider" and "storageProvider" properties are presently placeholders for data processing and data storage sovereignty needs respectively.

→ See: Sovereignty

The "invokeAsAsynchronous" property is available on some endpoints to process a run in an asynchronous manner, returning an early response and completing processing afterwards. Use events to receive notifications on asynchronous processes.

eventNotifications

"eventNotifications": {
    "sessionCreated": false,
    "sessionComplete": false,
    "dataGathererInvoked": false,
    "dataGathererSetupComplete": false,
    "dataGathererResultsAvailable": false,
    "dataGathererComplete": false,
    "evaluatorInvoked": false,
    "evaluatorResultsAvailable": false,
    "evaluatorComplete": false,
    "enrichmentInvoked": false,
    "enrichmentResultsAvailable": false,
    "enrichmentComplete": false
}

Allows the caller to register to receive events from Janus. Each endpoint will make use of the relevant subset of events only, with the exception of the Session endpoint which allows the caller to set all possible events for any resource created within that session.

→ See: Events

runAs

"runAs": {
    "identifier": "00000000-0000-0000-0000-000000000000",
    "jobCode": "string"
}

Contains additional information about the source of the request. The "identifier" is an open field that can be used to reference an internal identifier of the caller, to assist in scenarios such as debugging. The "jobCode" property is a field provided to provide flexibility for internal billing and accounting, as it can be queried if required.