EpisysInformationService

Get critical information about the Episys core.

Symitar eDocs References: SYSTEMINFO, Memo Post Mode

Operations

getGeneralEpisysInformation

post

Retrieves general status information about the Episys core.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

OperatingSystemDateTimestringOptional

Date and time of the operating system

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

BusinessDateTimestringOptional

Date and time of the business

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

PreviousBusinessDatestring · dateOptional

Previous business date

Example: 2023-04-24

OperatingSystemHostNamestringOptional

Host name of the operating system

Example: ["object Object"]

InstitutionNumberintegerOptional

Institution number of of Episys

Example: ["object Object"]

SymNumberintegerOptional

The Symitar number of the SymXchange instance

Example: 627

SymXchangeInstanceNamestringOptional

Instance name for SymXchange

Example: LIBUM

SymXchangeClientNumberintegerOptional

Client number for SymXchange

Example: ["object Object"]

InMemoModebooleanOptional

Indicates if the system is in memo mode

Example: ["object Object"]

EpisysVersionstringOptional

Version of Episys

Example: 2022.01

EpisysServicePackintegerOptional

Service pack number of Episys

Example: ["object Object"]

IsEpisysAlphaReleasebooleanOptional

Indicates if the Episys release is an alpha release

Example: ["object Object"]

IsEpisysBetaReleasebooleanOptional

Indicates if the Episys release is a beta release

Example: ["object Object"]

IsEpisysPreReleasebooleanOptional

Indicates if the Episys release is a pre-release

Example: ["object Object"]

EpisysQuestVersionstringOptional

Episys Quest version number

Example: 3.2022.1.120

SymXChangeInstanceIdintegerOptional

Instance ID for SymXchange

Example: ["object Object"]

SymXChangeLastOnHostDateTimestringOptional

Date and time of last interaction with the host for SymXchange

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

ServerTimeZonestringOptional

Time zone of the server

Example: PST8PDT

post

/getGeneralEpisysInformation

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/episysinformation/getGeneralEpisysInformation HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "BusinessDateTime": "2010-04-25T09:54:06",
  "EpisysQuestVersion": "3.2023.1.63",
  "EpisysServicePack": "5",
  "EpisysVersion": "2023.01",
  "InMemoMode": "false",
  "InstitutionNumber": "0",
  "IsEpisysAlphaRelease": "true",
  "IsEpisysBetaRelease": "false",
  "IsEpisysPreRelease": "false",
  "OperatingSystemDateTime": "2024-03-29T09:54:06",
  "OperatingSystemHostName": "bmoepivendvip.jhacorp.com",
  "PreviousBusinessDate": "2010-04-24",
  "ServerTimeZone": "PST8PDT",
  "Status": {
    "Message": "",
    "StatusCode": "0"
  },
  "SymNumber": "627",
  "SymXChangeInstanceId": "0",
  "SymXChangeLastOnHostDateTime": "2024-03-26T19:26:33",
  "SymXchangeClientNumber": "1",
  "SymXchangeInstanceName": "LIBUM",
  "customFields": {
    "appId": "glaci"
  }
}