Web API: Serverinfo: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
m (Ollvihe moved page Web API: ServerInfo to Web API: Serverinfo without leaving a redirect)
No edit summary
Line 7: Line 7:
Returns a JSON object containing the following properties:
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.
* '''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 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.
* '''codeRevision''' (string): Revision information from the version management system.
* '''databaseMajorVersion''' (number): Database major version.
* '''databaseMinorVersion''' (number):  Database minor version.
* '''pacmFileVersion''' (number): PACM file version.
* '''wcfProtocolVersion''' (number): Excel client protocol version.
* '''buildTimestamp''' (datetime): Timestamp when the software build was done in format e.g. ''/Date(-1820550215000+0300)/'' where the number is the number of milliseconds since the 1970 epoch.


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]

Revision as of 09:16, 14 October 2020

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 user 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.
  • codeRevision (string): Revision information from the version management system.
  • databaseMajorVersion (number): Database major version.
  • databaseMinorVersion (number): Database minor version.
  • pacmFileVersion (number): PACM file version.
  • wcfProtocolVersion (number): Excel client protocol version.
  • buildTimestamp (datetime): Timestamp when the software build was done in format e.g. /Date(-1820550215000+0300)/ where the number is the number of milliseconds since the 1970 epoch.