InformationService

Get critical information about the core.

Symitar eDocs References: SYSTEMINFO, Memo Post Mode

Operations

getGeneralInformation

Retrieves general status information about the Symitar core.

POSThttps://naas.ymcu.libum.io/nexum/627/persistent/information/getGeneralInformation

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

OperatingSystemDateTimedateTime

Date and time of the operating system

Example: "2023-04-25T08:00:00Z"

BusinessDateTimedateTime

Date and time of the business

Example: "2023-04-25T08:00:00Z"

PreviousBusinessDatestring (date)

Previous business date

Example: "2023-04-24"

OperatingSystemHostNamestring

Host name of the operating system

InstitutionNumberinteger

Institution number of of Symitar

SymNumberinteger

The Symitar number of the SymXchange instance

Example: 627

SymXchangeInstanceNamestring

Instance name for SymXchange

Example: "LIBUM"

SymXchangeClientNumberinteger

Client number for SymXchange

InMemoModeboolean

Indicates if the system is in memo mode

Versionstring

Version of Symitar

Example: 2022.01

ServicePackinteger

Service pack number of Symitar

AlphaReleaseboolean

Indicates if the Symitar release is an alpha release

BetaReleaseboolean

Indicates if the Symitar release is a beta release

PreReleaseboolean

Indicates if the Symitar release is a pre-release

QuestVersionstring

Symitar Quest version number

Example: "3.2022.1.120"

SymXChangeInstanceIdinteger

Instance ID for SymXchange

SymXChangeLastOnHostDateTimedateTime

Date and time of last interaction with the host for SymXchange

Example: "2023-04-25T08:00:00Z"

ServerTimeZonestring

Time zone of the server

Example: "PST8PDT"

Statusobject

Status of the system

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/persistent/information/getGeneralInformation', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "AdministrativeCredentials": {
          "Password": "suwn37834b91&"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "OperatingSystemDateTime": "2023-04-25T08:00:00Z",
  "BusinessDateTime": "2023-04-25T08:00:00Z",
  "PreviousBusinessDate": "2023-04-24",
  "OperatingSystemHostName": [
    "object Object"
  ],
  "InstitutionNumber": [
    "object Object"
  ],
  "SymNumber": 627,
  "SymXchangeInstanceName": "LIBUM",
  "SymXchangeClientNumber": [
    "object Object"
  ],
  "InMemoMode": [
    "object Object"
  ],
  "Version": 2022.01,
  "ServicePack": [
    "object Object"
  ],
  "AlphaRelease": [
    "object Object"
  ],
  "BetaRelease": [
    "object Object"
  ],
  "PreRelease": [
    "object Object"
  ],
  "QuestVersion": "3.2022.1.120",
  "SymXChangeInstanceId": [
    "object Object"
  ],
  "SymXChangeLastOnHostDateTime": "2023-04-25T08:00:00Z",
  "ServerTimeZone": "PST8PDT",
  "Status": {
    "StatusCode": 0,
    "Message": ""
  }
}