Edit a Service Connection

After you create a service connection, you can edit it to add and remove endpoints, modify requests, add functions for filtering and sorting responses, and more.

For each of your service connections, you can use the following tabs in the connection editor to view and edit the connection’s details. What you see depends on whether your service connection is static or dynamic:

Tab Description
Overview

Displays the title and version of the REST API that you create a service connection to. You can edit the title of the service as it appears in your visual application editors.

You can also use this tab to add transform functions to the service connection, which would override any corresponding transforms applied to its backend.

Server

If a service connection was created with an association to a backend, the backend is displayed. Server details can be updated from the backend. See Edit a Backend.

Note:

Starting with release 23.10, all service connections used in extensions must be associated with a backend. If you have older service connections that you still want to use, create a new backend, then migrate your existing service connections to it.

You can select the authentication method you want to use when connecting to the service. See Set the Backend's Authentication Method and Connection Type.

Headers

Displays the headers written in the REST call to the service. You can add and edit headers in the tab.

Source

Displays the OpenAPI description of the service’s REST API. The file contains the details about the connection settings, response and request definitions, and other parameters that are used in your applications. You can edit the entries in the Source tab.

Endpoints
  • For static service connections, displays a list of the service endpoints that you selected when you created the connection.

    Each endpoint in the list has an options menu where you can choose to edit, duplicate, or delete the endpoint. To add another endpoint from the service, click + Endpoint.

    You can add transform functions to an endpoint, which would override any corresponding transforms applied to its service connection and backend, by editing it and using its Overview tab.

    See Understand Data Access Through REST for more on the options and parameters that you can use to configure service connections.

  • For dynamic service connections, the tab provides a read-only view of all endpoints in the service's OpenAPI metadata, as retrieved from the source URL.

    You can click Edit Object Selection to add more objects. You can also select or deselect the option to automatically include all related list of values for the selected objects.

Metadata For a dynamic service connection, displays a read-only view of service metadata that is contained in the OpenAPI3 document, which was dynamically retrieved from the source URL.