Software AG Products 10.5 | Using API Gateway | APIs | Viewing API List and API Details | OData API Details
 
OData API Details
Open Data Protocol (OData) enables the creation of REST-based APIs, which allow resources to be exposed as endpoints and identified using the Uniform Resource Identifiers (URIs). In general, OData is represented by an abstract data model called Entity Data Model (EDM). This Entity Data Model allows Web clients to publish and edit REST services and their resources using simple HTTP messages. OData leverages the principles of HTTP, REST and ATOM, and combines the simplicity of REST and SOAP metadata definitions to describe service interfaces, data models, and semantics.
API Gateway supports OData V4 and V2 services.
The API details view for a OData API displays the details of the API such as Basic and Technical information, OData entity sets, singletons, function imports, actions imports and specifications. You can also view the policies enforced, registered applications and the API-specific analytics.
The API Gateway UI exposes only OData navigation properties to visualize the resource path structure of OData APIs. Any other OData property is not displayed.
Note:
API Gateway does not support the querying of Derived Entity Types. This includes the following operations:
*Requesting a Derived Entity
*Requesting a Derived Entity Collection
*Filter on Derived Type
Operations on Derived Types are rejected by API Gateway.
The table lists the API details displayed for the API:
Field
Description
Basic information
Displays the information about the API, such as Name, Version, the teams that the API is assigned to, status of the API whether its is Active or Inactive, the date on which the API was created, and a brief description of the API.
Technical information
Displays base URL of the API and the OData version supported.
OData entity sets
Displays a list of OData entity sets. An entity set element represents a single entity or a collection of entities of a specific entity type in the data model.
The list of entity sets is sorted alphabetically. Click each entity set to view the resource path, entity type, resource parameter details, and the corresponding HTTP methods.
The entity types are structured records consisting of named and typed properties and key properties whose values uniquely identify one instance from another.
OData singletons
Displays a list of OData singletons. Singletons are single entities which are accessed as children of the entity container.
The list of singletons is sorted alphabetically. Click each singleton to view the resource path, entity type, the corresponding HTTP methods, and the navigation properties that allow navigation from an entity to related entities.
The OData navigation property has an impact on the resource structure. This property is represented as an OData Resource and denoted as OData Navigation properties inside the OData Resources profile. There is no restriction to the number of levels you can drill down.
OData function imports
Displays a list of OData function imports. The Function Import element represents a Function in an entity model.
The list of OData function imports is sorted alphabetically. Click each function import to view the resource path, entity type, and the corresponding HTTP methods.
OData action imports
Displays a list of OData action imports. The Action Import element represents an Action in an entity model.
The list of OData action imports is sorted alphabetically. Click each action import to view the resource path, entity type, and the corresponding HTTP methods.
Documentation
Displays a list of specifications for the API.
The metadata document. The metadata document describes the Entity Data Model that is, the structure and organization of the OData service resources) exposed as HTTP endpoints by that particular service. This document describes the entity types, entity sets, functions and actions.
Various tabs displayed in the API details page display the following details:
*The Policies tab displays the policies enforced for the API.
*The Applications tab displays all the applications registered with the API.
*The Analytics tab displays the API-specific analytics for the time interval selected.
You can perform the following operations from the API details page:
*You can update an API by importing from URL by clicking the Update button. This option is available when the API is in the deactivated state.
*You can create a new version of the API by clicking the Create new version button.
*You can modify details of an API by clicking the Edit button. This option is available when the API is in the deactivated state. Only the following properties of an OData API can be modified:
*Name
*Description
*Version
*API group
*Maturity state
For updating the OData entity sets, singletons, function imports and action imports a new import has to be performed.
*You can activate an API by clicking the Activate button. If the API is already activated, you can deactivate it by clicking the Deactivate button.