Endpoints are created and edited in a convenient GUI editor. When creating a new endpoint, first you need to select a connection. After this, the Endpoint Editor page opens.
Endpoint editor consists of four main parts. They are header, toolbar, connection object list, and diagram.
The endpoint editor header displays the back button that closes the editor, an icon of the data source, data of which the endpoint exposes, and the endpoint name. Here you can rename the endpoint. For this point to the endpoint name and then click the button. After this enter the new endpoint name.
Connection objects list on the left displays all the available connection objects. You can drag the objects from the connection object list to the diagram in order to add them to the endpoint. To quickly find an object in the list, you can use the search box at the top of the list.
Diagram on the right displays the entity types already added to the endpoint and relationships (associations).
Entity types are displayed as rectangle shapes. They consists of three parts:
|1.||Header with the table icon and entity type name is the topmost part.|
|2.||The list of entity properties is located under the header. It displays all entity properties that correspond to the exposed fields of the corresponding connection object. The key properties are marked with the key icon.|
|3.||The bottom part of an entity type shape displays the list of navigation properties.|
You can freely drag entity shapes on the diagram to layout them in a more convenient and informative way.
To delete an entity from the endpoint, point to its header and click the cross on the right side of its header. All the relationships with this entity and corresponding navigation properties in other entities will also be deleted.
By default, when you drag a connection object to the diagram, all its fields are exposed. To hide some of the fields so that they won't be available via OData protocol from this endpoint, double-click the entity on the diagram. The Edit Entity dialog box will open, where you can hide or expose fields of the connection object. In this dialog box you can also change the name of the OData entity and entity set. You can find more details in the Edit Entity Dialog Box.
Relationships (associations) are displayed as blue lines connecting entities. If there are several relations between the same two entities, they are displayed as one line on the diagram.
For each of the associations, you can open the Association editor by pointing the corresponding navigation property in an entity shape and then clicking the button. In the Association editor you can modify the names of the relationship navigation properties in the corresponding entities.
Toolbar of the endpoint editor allows you to save endpoint, manage endpoint security - user accounts and IP address ranges, for which access to the endpoint data is allowed, and specify OData versions, supported by the endpoint.
OData editor toolbar contains the following elements:
Click to save the endpoint changes. Note that saving the endpoint does not automatically redirects you from the endpoint editor. To close the endpoint editor, click the left arrow in the endpoint editor header.
Click to open the Users dialog box and manage the endpoint user accounts.
Click to open the IP Adresses dialog box and manage the ranges of IP addresses, from which the access to the endpoint data is allowed.
In this drop-down list you can select the OData version, the endpoint will be compatible with. The following values are available:
|•||OData v1-3 - endpoint will be compatible with OData v1 - v3.|
|•||OData v4 - endpoint will be compatible with OData 4.0|
|•||OData Last - endpoint will be compatible with the latest current version of OData. When a newer OData version will be approved, made available, and supported by Skyvia Connect, the endpoint will become compatible with this new version.|