Business Objects Harvested from OpenAPI Metadata

Oracle Visual Builder Add-in for Excel identifies business objects in an OpenAPI document primarily by examining the paths defined in the service metadata.

The add-in creates a business object for each collection path defined in the OpenAPI document. A valid collection path:

• Does not end with a path parameter replacement token like {department_id}
• Defines GET and/or POST operations

Examples of valid collection paths are:

• /Departments
• /Departments/{department_id}/child/Employees

The add-in associates the collection path with any related paths. For example, the add-in associates an item path with a collection path if the path value is identical with the addition of a path parameter replacement token at the end. This comparison is case sensitive. An item path value of /Departments/{department_id} would be correctly associated with a collection path value of /Departments. In contrast, /Departments and /departments/{department_id} would not be associated with each other.

A business object is then defined by its collection path, item path (if present), and any other associated paths (custom actions, for example).

Note:

Certain paths may be ignored by the add-in depending on the service type.

Relationships between business objects are also determined by comparing the path information. A business object is considered a descendant of another business object if the collection path value starts with the collection and/or item path of another business object. This comparison is case sensitive. A business object with collection path /Departments/{department_id}/child/Employees is a valid child of a business object with collection path /Departments and item path /Departments/{department_id}.