The Ecx.Web service from AppBase is responsible for displaying application pages. You can use this service to display pages in other client applications, or to open a page directly in the browser without the standard AppBase shell.

Formulate a URL to a page

The basic structure of the URL is:

{server}/Ecx.Web/do/{page-API-Code}?appid={application-API-Code}d={domain}&{parameter1}={value1}&{parameter2}={value2}&{additional parameters}

The parameters in that URL are:

ParameterDescription
page-API-Code
The API Permanent ID of the page you want to show
To get: Application Studio -> Presentations -> Pages. Click on a blue link of the page and find the API Permanent ID
application-API-Code

The API Permanent ID of the application menu that contains this page
To get: Application Studio -> Applications -> User Applications. Click on the blue link of the application that contains the target page 

domain
The ID of the runtime environment to which the solution is deployed
To get: System Setup -> Enviornments. Click on the blue link of the environment to where this page is deployed.  
parameter1, parameter2These are the input parameters of the rule you are executing.

The output varies depending on the type of rule you are executing and what output parameters it has. In all cases, this command returns back a JSON. In the example below, we called a Paginated SQL Rule whose Rule API Code is root_retrieve_paginated_Clients:

{
	"DATA" : {
		"root_retrieve_paginated_Clients" : {
			"ITEMS" : [{
					"FIRSTNAME" : "John",
					"ID" : "3",
					"LASTNAME" : "Smith",
					"SSN" : "111-1111-1111-1111",
					"RN" : "1"
				}, {
					"FIRSTNAME" : "Amy",
					"ID" : "4",
					"LASTNAME" : "Jones",
					"SSN" : "2222-2222-2222-2222",
					"RN" : "2"
				}, {
					"FIRSTNAME" : "Jack",
					"ID" : "5",
					"LASTNAME" : "Gomez",
					"SSN" : "3333-3333-3333-3333",
					"RN" : "3"
				}, {
					"FIRSTNAME" : "Maya",
					"ID" : "6",
					"LASTNAME" : "Gill",
					"SSN" : "4444-4444-4444-444",
					"RN" : "4"
				}
			],
			"TotalCount" : "4"
		}
	}
}

Note: The exec command can be replaced with get.json.

Execute a rule through GET with XML response

Same as the previous command except the response will be an XML. You can execute a rule via an HTTP GET request that looks like:

{server}/BDS.WebService/DataServiceRest.svc/execxml/{domain}/{rule-API-Code}?t={token}&{parameter1}={value1}&{parameter2}={value2}&{additional parameters}

The parameters in that URL are:

ParameterDescription
uThe path of where you want to create the new folder.
parameter1, parameter2There are the input parameters of the rule you are executing.

The output varies depending on the type of rule you are executing and what output parameters it has. In all cases, this command returns back an XML. In the example below, we called a Paginated SQL Rule whose Rule API Code is root_retrieve_paginated_Clients:

<?xml version="1.0" encoding="UTF-8"?>
<DATA>
   <root_retrieve_paginated_Clients>
      <ITEMS>
         <FIRSTNAME>John</FIRSTNAME>
         <ID>3</ID>
         <LASTNAME>Smith</LASTNAME>
         <SSN>1111-1111-1111-1111</SSN>
         <RN>1</RN>
      </ITEMS>
      <ITEMS>
         <FIRSTNAME>Amy</FIRSTNAME>
         <ID>4</ID>
         <LASTNAME>Jones</LASTNAME>
         <SSN>2222-2222-2222-2222</SSN>
         <RN>2</RN>
      </ITEMS>
      <ITEMS>
         <FIRSTNAME>Jack</FIRSTNAME>
         <ID>5</ID>
         <LASTNAME>Gomez</LASTNAME>
         <SSN>3333-3333-3333-3333</SSN>
         <RN>3</RN>
      </ITEMS>
      <ITEMS>
         <FIRSTNAME>Maya</FIRSTNAME>
         <ID>6</ID>
         <LASTNAME>Gill</LASTNAME>
         <SSN>4444-4444-4444-4444</SSN>
         <RN>4</RN>
      </ITEMS>
      <TotalCount>4</TotalCount>
   </root_retrieve_paginated_Clients>
</DATA>

Note: The execxml command can be replaced with get.xml.