Web API: Serverinfo: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
* '''serverVersion''' (string): QPR ProcessAnalyzer build version.
* '''serverVersion''' (string): QPR ProcessAnalyzer build version.
* '''ssoConfigured''' (boolean): Whether SSO (SAML) has been setup to the server.
* '''ssoConfigured''' (boolean): Whether SSO (SAML) has been setup to the server.
* '''hasValidActivation ''' (boolean): Server activation is currently valid.
* '''codeRevision''' (string): Revision information from the version management system.
* '''codeRevision''' (string): Revision information from the version management system.
* '''databaseMajorVersion''' (number): Database major version.
* '''databaseMajorVersion''' (number): Database major version.

Revision as of 17:21, 26 January 2021

The ServerInfo operation returns basic information of the server that is needed by the user interface. The ServerInfo operation doesn't require user login, because the information is used by the login screen already before login.

Url: GET /api/serverinfo

Returns a JSON object containing the following properties:

  • defaultUiLanguage (string): Language code of the default user interface language (language that new user accounts get by default). The login page is translated using this default language.
  • serverVersion (string): QPR ProcessAnalyzer build version.
  • ssoConfigured (boolean): Whether SSO (SAML) has been setup to the server.
  • hasValidActivation (boolean): Server activation is currently valid.
  • codeRevision (string): Revision information from the version management system.
  • databaseMajorVersion (number): Database major version.
  • databaseMinorVersion (number): Database minor version.
  • pacmFileVersion (number): PACM export file version.
  • wcfProtocolVersion (number): Excel client protocol version.

See more about the version numbers.