Configuration APIs

Get Web Configuration (GET)

Returns the web application configuration settings.

Route

URI	/api/v1/info/webconfig
Method	GET
Result	JSON – WebClientConfigModel

Parameters

Name	Type	Mandatory
webApplication	WebApplication	No

Response Structure WebClientConfigModel containing:

- DefaultDomain: string value

- ShowFeedbackButton: Controls the visibilty of the feedback button.

- AllowTypeIdGrouping: bool value

- UseAppInsights: Controls the usage of insights.

- RequestAdminScenario: string value

- ADInactiveAccountsIncludesNullInactiveDays: bool value

- AllowSso: Controls the possibility of log on with single sign-on.

- RedirectSso: string value

- MaxSearchResults: Class for customization details.

- RetainComments: Maximum number of resource search results.

- Customization: Controls if successive comment dialogues retain the value of the previous one.

Example

GET http://localhost/api/v1/info/webconfig

Example Response

{
    "DefaultDomain": "sample",
    "ShowFeedbackButton": true,
    "AllowTypeIdGrouping": true,
    "UseAppInsights": true,
    "RequestAdminScenario": "sample",
    "ADInactiveAccountsIncludesNullInactiveDays": true, 
    "AllowSso": true,
    "RedirectSso": "sample",
    "MaxSearchResults": 1,
    "RetainComments": true,
    "Customization": {}
}

Get License State (GET)

Returns the current license state and information.

Route

URI	/api/v1/info/license
Method	GET
Result	JSON – object

Parameters

Name	Type	Mandatory
webApplication	WebApplication	No

Example

GET http://localhost/api/v1/info/license

Example Response

{
"IsLicensed":true,
"Status":"Ok"
}

Keep Alive (GET)

Keeps the connection alive. Default expiry time is 45 minutes (Release) / 24 hours (Debug).

Route

URI	/api/v1/info/keepalive
Method	GET
Result	JSON – True if successful.

Parameters

Name	Type	Mandatory
webApplication	WebApplication	No

Example

GET http://localhost/api/v1/info/keepalive

License Application Values (GET)

Returns an object with information of additional applications or mates from license file section.

Route

URI	/api/v1/info/license/app/{appId}/values
Method	GET
Result	JSON – An object with keys and values of the given appId from the license file.

'Parameters

Name	Type	Mandatory	Description
appId	string	Yes	The id of the requested application.
webApplication	webApplication	No

GET http://localhost/api/v1/info/license/app/{appId}/values

Version (GET)

Retrieve the tree for a given key element.

Route

URI	/api/v1/info/version
Method	GET
Result	JSON – AppInfoVersion

'Parameters

Response Structure AppInfoVersion containing:

- PnServerVersion: Get the version of the backend 8MAN server.

- ApiVersion: Get the version the this API.

GET http://localhost/api/v1/info/version

{
"PnServerVersion":"sample",
"ApiVersion":0.0
}