GET api/v0/Status?apiKey={apiKey}&lang={lang}

Returns the current status of the Calculation Manager.

Request Information

URI Parameters

NameDescriptionTypeRemarks
apiKey

Required A unique identifier that serves as a form of authentication that verifies the identity of the user making the API request. See the documentation for more details.

string
lang

The expected locale of the output, e.g. 'en' or 'de'.

string

Body Parameters

None.

Request Formats

URL

GET  https://calculationmanager.wehrspohn.info/api/v0/Status?apiKey=AF2D3D828177416BBE1599B0000BAD98&lang=en

Response Information

Resource Description

The current status of the Calculation Manager.

Status
NameDescriptionTypeRemarks
IsRunning

Gets a boolean that indicates if the Calculation Manager is running.

boolean
RunningJobs

Gets the number of calculation jobs are being processed at the moment.

int
WaitingJobs

Gets the number of calculation jobs waiting for the processing.

int
StartedOn

Gets the date and time when the Calculation Manager has been started.

date
IsLicensed

Gets a boolean that indicates if the instance of the Calculation Manager is licensed. If the license is not there, the Calculation Manager returns zeroes for the simulation results.

boolean
DebugMode

Gets a boolean that indicates if the debug mode of the application is activated. The Calculation Manager functions normally in debug mode, however, the performance may degrade.

boolean
KernelVersion

Gets the version number of the kernel component in the following format: Major.Minor.Build.Revision

string

Response Formats

Body (application/json, text/json)

Sample:
{
    "IsRunning": true,
    "RunningJobs": 1,
    "WaitingJobs": 3,
    "StartedOn": "\/Date(1769346262177)\/",
    "IsLicensed": true,
    "DebugMode": false,
    "KernelVersion": null
}