An interface is needed to provide project data from Relatics to an external application. This data can be used to configure external relations. The response of a providing interface consists of the ID and display name of the elements. The ID will be used to create relations in requests of a synchronizing data interface.

Configure an interface in the workspace^*

1. In the workspace menu, click on Application Integration.
2. In the Application integration view, click on New interface for providing data to an external application. As a result, the dialog Create interface for providing data to an external application is opened.
3. For the field Name, enter a text representing the use.
4. For the field Type element, select the desired type element.
5. For the field Relatics API key for requests by external application(s), select the desired entrance key.
6. For the field Endpoint, enter a text that represents the data.
7. Click Create. The interface is created and ready to be used.

Note:

• Only standard type elements can be selected as a type element for an entry interface. Elements of the inner types cannot be selected.

Provide data via API request

An HTTP GET request is required to get data from Relatics. The request consists of an endpoint URL, headers, and a body:

• You can submit the GET request to the Interface endpoint URL. This URL can be found on the detail page of the interface and should look something like this:

https://myenvironment.relatics.com/api/v1/workspaces/755053b0-ba42-494a-b467-c2cf408be65/interfaces/providing/myendpoint

• The headers that need to be set are described in the table below:

• A request body is not needed for this method.

If successful, this method returns the elements in the response body. Depending on the specified value of the ‘Accept’ key in the header, the response will be in json or xml.

Notes:

• You can use the http status to track the success of the request.

* In the workspace, the user type of your user must be set to power user to use this feature.