Requirements for Dependent Layouts
To ensure that your dependent layouts function without error, Oracle Visual Builder Add-in for Excel requires that the REST service complies with the requirements set out here.
URL Path Requirements
To ensure all operations of dependent layouts can be done without errors, the add-in requires the following:
- Parent business object:
- Collection path:
/{parentResource}
- Item path:
/{parentResource}/{parentResource_Id}
- Collection path:
- Child business object
- Collection path:
/{parentResource}/{parentResource_Id}/{childResource}
- Item path:
/{parentResource}/{parentResource_Id}/{childResource}/{childResource_Id}
- Collection path:
- Grandchild business object
- Collection path:
/{parentResource}/{parentResource_Id}/{childResource}/{childResource_Id}/{grandchildResource}
- Item path:
/{parentResource}/{parentResource_Id}/{childResource}/{childResource_Id}/{grandchildResource}/{grandchildResource_Id}
- Collection path:
This example shows the collection and item paths for the parent, child, and grandchild business objects in the following three-level hierarchy:
Parent paths:
- Collection path:
/PurchaseOrders
- Item path:
/PurchaseOrders/{PurchaseOrders_Id}
Child paths:
- Collection path:
/PurchaseOrders/{PurchaseOrders_Id}/lines
- Item path:
/PurchaseOrders/{PurchaseOrders_Id}/lines/{lines_Id}
Grandchild paths:
- Collection path:
/PurchaseOrders/{PurchaseOrders_Id}/lines/{lines_Id}/schedules
- Item path:
/PurchaseOrders/{PurchaseOrders_Id}/lines/{lines_Id}/schedules/{schedules_Id}
GET and POST Response Requirements
GET and POST responses must contain self links that uniquely identify a record. For example:
"links": [
{
"rel": "self",
"href": "http://localhost:8888/ords/hr_rest/ExpenseReports/15001"
}
]
Notes on Oracle REST Data Services Support
- Support for Oracle REST Data Services (ORDS) requires version 22.1.0 or later. Previous versions of ORDS are known to have an issue with an incorrect payload definition for the POST handler. See ORDS Release Notes 22.1.0.
- ORDS AutoRest does not provide service paths as described in this section. However, you can write custom ORDS using SQL and PL/SQL to satisfy these requirements. See ORDS RESTful Web Services Architecture Diagrams and Manually Creating RESTful Services Using SQL and PL/SQL.