Web API: Serverinfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The '''ServerInfo''' operation returns basic information of the server | The '''ServerInfo''' operation returns basic information of the server, needed by the user interface. The ServerInfo operation doesn't require user to login (as the information is used by the login screen already before login). | ||
<pre> | <pre> | ||
| Line 6: | Line 6: | ||
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. Language options are same as in the [[PA_Configuration_database_table_in_QPR_ProcessAnalyzer#General_Settings|DefaultUiLanguage]]. | ||
* '''defaultDateFormat''' (string): Default date format (that new user accounts get by default). The date format does not contain the time part (e.g. hours, minutes and seconds). Defined using the .Net date format (https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). | |||
* '''defaultFirstDayOfWeek''' (string): Default first day of the week (that new user accounts get by default). '''0''' is Sunday and '''1''' is Monday. This information is used by the UI when showing e.g. calendars. | |||
* '''defaultUse12HourClock''' (string): Defines whether the 12-hours clock is in use by default for the new user accounts (instead of the 24-hours clock). Defined as '''true''' or '''false'''. | |||
* '''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. | ||
Revision as of 14:01, 20 September 2021
The ServerInfo operation returns basic information of the server, needed by the user interface. The ServerInfo operation doesn't require user to login (as 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. Language options are same as in the DefaultUiLanguage.
- defaultDateFormat (string): Default date format (that new user accounts get by default). The date format does not contain the time part (e.g. hours, minutes and seconds). Defined using the .Net date format (https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
- defaultFirstDayOfWeek (string): Default first day of the week (that new user accounts get by default). 0 is Sunday and 1 is Monday. This information is used by the UI when showing e.g. calendars.
- defaultUse12HourClock (string): Defines whether the 12-hours clock is in use by default for the new user accounts (instead of the 24-hours clock). Defined as true or false.
- 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.