/GenericAFBean/applications/{applicationName}

post

https://rz3.aeb.de/test4ce/rest/GenericAFBean/applications/{applicationName}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationName

string

required

Body Params

A generic request for an application facade.

client

string

The client of the new session. This should be a legal identCode of a client in the system.
If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the UI API. (See IFoundationBF.getAllClients()).
When the UI API web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.

user

string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the API will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

workstationId

string

The unique workstation identifier of the new session.

The identifier of the workstation must be configured and unique within the same client.

workstationSessionId

string

The unique workstation agent session identifier of the new session.
It defines a concrete and already established session agent bound to the local workstation e.g. locally started service agent.
The workstation agent is used for accessing local peripheries (e.g. local printers).

The caller must ensure that the corresponding session has been established

language

string

The two letter ISO code of the language of the new session.

displayFullWorkplace

boolean

true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.

isACEmbedded

boolean

true to display header and statusbar, false if ac should be embedded in another

displayStatusbar

boolean

true to display statusbar, false

displayTitlebar

boolean

true to display header, false if ac should not show header

stylevariant

string

Deprecated.

acceptTechnology

string

Specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: VAADIN) if null a default technology is chosen.

productname

string

Optional field, which may be set if productname differs from standard product name

productShortName

string

Optional field, which may be set if productShortName differs from standard product name

preferredWidth

int32

Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

preferredHeight

int32

Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way

openToTray

boolean

Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored

readOnly

boolean

Defaults to false

Defines whether or not the application shall be opened in read-only mode.

parameters

array of objects

A set of generic parameters for the application, that shall be opened.

parameters

Response

defaultdefault response