Skip to content
NexumAPI Docs

EpisysInformationService⁠

Operations⁠

getGeneralEpisysInformation⁠

POST

Retrieves general status information about the Episys core.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
OperatingSystemDateTimestringoptionalDate and time of the operating system
BusinessDateTimestringoptionalDate and time of the business
PreviousBusinessDatestring · dateoptionalPrevious business date
OperatingSystemHostNamestringoptionalHost name of the operating system
InstitutionNumberintegeroptionalInstitution number of of Episys
SymNumberintegeroptionalThe Symitar number of the SymXchange instance
SymXchangeInstanceNamestringoptionalInstance name for SymXchange
SymXchangeClientNumberintegeroptionalClient number for SymXchange
InMemoModebooleanoptionalIndicates if the system is in memo mode
EpisysVersionstringoptionalVersion of Episys
EpisysServicePackintegeroptionalService pack number of Episys
IsEpisysAlphaReleasebooleanoptionalIndicates if the Episys release is an alpha release
IsEpisysBetaReleasebooleanoptionalIndicates if the Episys release is a beta release
IsEpisysPreReleasebooleanoptionalIndicates if the Episys release is a pre-release
EpisysQuestVersionstringoptionalEpisys Quest version number
SymXChangeInstanceIdintegeroptionalInstance ID for SymXchange
SymXChangeLastOnHostDateTimestringoptionalDate and time of last interaction with the host for SymXchange
ServerTimeZonestringoptionalTime zone of the server
POST/nexum/{sym}/2022.01/episysinformation/getGeneralEpisysInformation
POST /nexum/627/2022.01/episysinformation/getGeneralEpisysInformation HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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