Web API: Serverinfo: Difference between revisions
Jump to navigation
Jump to search
m (Ollvihe moved page Web API: ServerInfo to Web API: Serverinfo without leaving a redirect) |
No edit summary |
||
| (20 intermediate revisions by the same user not shown) | |||
| 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> | ||
Url: GET /api/serverinfo | Url: GET qprpa/api/serverinfo | ||
</pre> | </pre> | ||
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 | * '''defaultUiLanguage''' (string): Language code of the default user interface 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#General_Settings|DefaultUiLanguage]]. | ||
* '''serverVersion''' (string): QPR ProcessAnalyzer version. | * '''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). | ||
* '''ssoConfigured''' (boolean): Whether SSO (SAML) | * '''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-hour clock (instead of the 24-hour clock) is in use by default for the new user accounts when showing time information in the UI. Defined as '''true''' or '''false'''. More information about the 12-hour clock: https://en.wikipedia.org/wiki/12-hour_clock. | |||
* '''serverVersion''' (string): QPR ProcessAnalyzer build version. | |||
* '''ssoConfigured''' (boolean): Whether SSO (SAML 2.0 authentication) is in use in the environment. | |||
* '''hasValidActivation ''' (boolean): Server activation is currently valid. | |||
* '''enabledFeatures''' (string array): List of features that are configured and available to use in the server. Possible features are: | |||
** '''snowflake''': connection to Snowflake data cloud | |||
** '''sqlserver''': datatable can be stored to a separate SQL Server database | |||
** '''openai''': Open AI Chat Completions API | |||
* '''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. | |||
Latest revision as of 11:17, 4 March 2024
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 qprpa/api/serverinfo
Returns a JSON object containing the following properties:
- defaultUiLanguage (string): Language code of the default user interface 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-hour clock (instead of the 24-hour clock) is in use by default for the new user accounts when showing time information in the UI. Defined as true or false. More information about the 12-hour clock: https://en.wikipedia.org/wiki/12-hour_clock.
- serverVersion (string): QPR ProcessAnalyzer build version.
- ssoConfigured (boolean): Whether SSO (SAML 2.0 authentication) is in use in the environment.
- hasValidActivation (boolean): Server activation is currently valid.
- enabledFeatures (string array): List of features that are configured and available to use in the server. Possible features are:
- snowflake: connection to Snowflake data cloud
- sqlserver: datatable can be stored to a separate SQL Server database
- openai: Open AI Chat Completions API
- 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.