Add or Remove Exposed Endpoints

When your application has many inter-related business objects, you can add or remove endpoints that these business objects expose. Tailoring the endpoints to expose only those that you require controls the size of the metadata file that describes your endpoints and maximizes application performance, both at design time and runtime.

Endpoints for a business object are generated by traversing accessors in a tree structure. By default, only the first level of accessors (those owned by the business object) are added to the object's resource definition. You can change this default definition to add deeper endpoints when related objects are nested several levels down or to remove unwanted endpoints.

Let’s say your application uses the Employee, Department, Location, and Project business objects, which refer to one other as follows:

Description of the illustration bo-endpoints-edit-relationship.png

With this relationship, the first level of accessor endpoints for the main Employee object (/departmentObject and /projectObject) are included by default in the Employee object's resource definition. Other deeper endpoints are not included. Now, if you want to show the department and location names in a Table of Employees, you need to add endpoints that are not included by default, but which are required to expose this data. For example, you must add the nested /departmentObject/locationObject endpoint (not selected by default) to show an employee's location.

Optionally, if you want to restrict access to employee project information, you can remove the /projectObject endpoint (selected by default).

To select the endpoints you want to expose for a business object:

1. Open the business object's Endpoints tab.
2. In the Endpoints node, click Edit Endpoints.
   
   

   
   Description of the illustration bo-endpoints-edit.png

   
   
3. In the Business Object Resource Editor, drill down to each related business object to view available endpoints. The endpoints are uniquely identified by their accessors, enabled when one business object references another (see View, Create, and Edit Business Object Relationships).
4. For each related business object, select or deselect endpoints to add or remove them.
   
   

   
   Description of the illustration bo-endpoints-edit-bore.png

   
   

   By default, only endpoints that are one level down from the parent node are selected. This example adds the deeper Employee/departmentObject/locationObject endpoint and removes the Employee/projectObject endpoint.

5. Click Save. To take the default setting, click Apply Defaults.