Load a web application form

Use this resource to load a web application form in an independent portlet. This allows loading data without a dedicated portal server or process user configuration in INUBIT. The request creates an entry in the Queue Manager. The returned data consists of HTML, Ext JS, and JavaScript, which can be loaded directly into any application.

Request

To load the web application form, send a POST request to the endpoint defined below.

URL: /webapp/standalone/view/{id}

Method: POST

Authorization: required

POST /ibis/rest/webapp/standalone/view/2082ed32-7f00-0101-4530-9c08b2617e57 HTTP/1.1
Accept: application/xml
Host: localhost:8080

Path Parameters

The following table lists the path parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`id`	Enter the unique UUID of the Web Application Connector module.	yes	Alphanumeric string with hyphens

id

Enter the unique UUID of the Web Application Connector module.

yes

Alphanumeric string with hyphens

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`includeCss`	Specify whether to include the default INUBIT theme. The default value is `true`. Set this to `false` to use custom themes.	no	`true` or `false`
`includeScript`	Specify whether to include the default scripts available with INUBIT. The default value is `true`.	no	`true` or `false`
`portletId`	Enter the ID of the portlet used to generate the namespace.	yes	Alphanumeric string
`portalUrl`	Enter the context path of the portal. This URL is used for communication from the frontend to the INUBIT server.	yes	URL string
`actionUrl`	Enter the URL to be called for the submit action.	yes	URL string
`user`	Enter the name of the portal user for processing in INUBIT.	yes	Alphanumeric string

includeCss

Specify whether to include the default INUBIT theme. The default value is true. Set this to false to use custom themes.

true or false

includeScript

Specify whether to include the default scripts available with INUBIT. The default value is true.

true or false

portletId

Enter the ID of the portlet used to generate the namespace.

yes

Alphanumeric string

portalUrl

Enter the context path of the portal. This URL is used for communication from the frontend to the INUBIT server.

yes

URL string

actionUrl

Enter the URL to be called for the submit action.

yes

URL string

user

Enter the name of the portal user for processing in INUBIT.

yes

Alphanumeric string

Request Body

The request body must contain the property input data.

<?xml version="1.0" encoding="UTF-8"?>
<Properties version="4.1">
    <Property name="ISPortalUser">test1</Property>
    <Property name="ISPortalTenant">Liferay</Property>
    <Property name="ISSessionId">199F71D8859D8A0A5A4C9B6C2D4FF712</Property>
    <Property name="ISPortletActionUrl">/webapp/standalone/submit/2082ed32-7f00-0101-4530-9c08b2617e57</Property>
    <Property name="ISUserName">inubitISPortalUser@@@intern</Property><Property name="ISWebContextPath"/>
    <Property name="ISPortletNamespace">i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql</Property>
    <Property name="ISParameters">&lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;Parameters version="4.1"/&gt;</Property>
    <Property name="ISWebLanguage">en</Property>
</Properties>

Response

The response contains the web application data.

HTTP/1.1 200 OK
Content-Type: application/xml

<div xmlns:xs="http://www.w3.org/2001/XMLSchema" id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_bodyIS">
    <div id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_innerIS" class="portlet-font">
        <link rel="stylesheet" type="text/css" href="http://localhost:8080/o/FormProxyServlet?url=inubitrepository:///Global/System/Widgets/resources/theme-classic-all_1.css">
        <link rel="stylesheet" type="text/css" href="http://localhost:8080/o/FormProxyServlet?url=inubitrepository:///Global/System/Widgets/resources/theme-classic-all_2.css">
        `<script type="text/javascript" src="http://localhost:8080/o/FormProxyServlet?url=inubitrepository:///Global/System/Widgets/resources/Script.js"></script><script type="text/javascript" src="http://localhost:8080/o/FormProxyServlet?url=inubitrepository:///Global/System/Widgets/resources/AjaxScript.js"></script><script type="text/javascript" src="http://localhost:8080/o/FormProxyServlet?url=inubitrepository:///Global/System/Widgets/resources/jquery-3.5.1.js"></script><script type="text/javascript" language="javascript">

        try {
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_vForms=new Array();
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_panels=new Array();
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_errorViewer=new Array();
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_validate=true;
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_warningColor='#ffcccc';
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_contextPath='http://localhost:8080/o';



        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_ajaxValidation=false;

        dataIS['ajaxLoad']='true';
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_form='2082ed32-7f00-0101-4530-9c08b2617e57';
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_done=false;
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_genericClient='false';
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_lang='en';
        dataIS.i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_webFormName='webform@@@LaunchWebApp/form_loginwebapp(62)_basicwebapp@@@200005.xml';

        } catch(e) { if("ReferenceError"!=e.name) alert(e); }

    </script><form action="http://localhost:8080/testconfig?p_p_id=LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql&amp;p_p_lifecycle=1&amp;p_p_state=normal&amp;p_p_mode=view&amp;p_auth=cSnljKm6" name="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_" id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_formIS" method="post" accept-charset="UTF-8" enctype="multipart/form-data" onsubmit="return checkForExt((typeof event !=='undefined') ? event : null, 'i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_', '', getFormDataIS('i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_'),'')"><input type="hidden" name="submitId" id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_submitId" value="submitId"><input type="hidden" name="hiddenSubmitIS" id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_hiddenSubmitIS" value="_nothing"><div id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_main" style="display:block;">
        <div class="outerGroupIS" style="position: static;">
            <table cellpadding="0" cellspacing="0" border="0" id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_main.table" class="groupInvisibleIS" style="position: static;&#xA;            background-color: #ffffff; background-image: none;&#xA;            border-color: #ffffff;" width="100%">
                <tbody>
                    <tr>
                        <td style="vertical-align: top; text-align: left;"><input type="text" size="30" onkeydown="dataIS.key=event.keyCode" class="portlet-form-input-field" value="" id="i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_TextField_191698769" name="TextField_191698769" style="position: ;width: 300px; "></td>
                    </tr>
                    <tr>
                        <td style="vertical-align: top; text-align: left;"><input class="portlet-form-button" name="#sb_value" value="Submit" onClick=";&#xA;javascript:setSubmitPropertyIS('value','false','i_LiferayMVCPortlet_INSTANCE_AfYrAMY2vHql_');&#xA;dataIS.submitter=this;&#xA;      " type="submit" style="position: ;"></td>
                    </tr>
                </tbody>
            </table>
        </div>
    </div>
    </form><script type="text/javascript" language="javascript">;</script></div>
</div>

Response Headers

The response includes the following headers.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`webappIdentifier`	The response includes the web application form name. This name corresponds to the filename in the Queue Manager.	yes	Alphanumeric string

webappIdentifier

The response includes the web application form name. This name corresponds to the filename in the Queue Manager.

yes

Alphanumeric string

Errors

This request might return one of the following error codes:

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.