Skip to main content
Feedback

Adding a REST endpoint to an API Service component

Click Add an Endpoint on the API Service component’s REST tab to add a REST endpoint.

About this task

These steps represent an alternative to generating endpoints by selecting processes to link.

Procedure

  1. In the API Service component, select the REST tab.

  2. Click Add an Endpoint.

    The Add REST Endpoint dialog opens.

  3. Optional: In the Resource Path field, type the Object Name for requests to the route's specified operation and the Path ParametersURL path for parameter requests in the path.

    To specify parameters in the path, delineate them with braces — for example, {id}. Parameters in the matched part of the path are available to the linked process as dynamic process properties named param_name, where name is the parameter name — for example, param_id.

    The full URL has this form:

    http://Host:port/REST_url_path/Object/Path_Parameters

    where

    • Host and port are set on the Shared Web Server panel (Manage > Runtime Management).

    • REST_url_path is the Path to REST shown on the REST tab (the Base API Path that you specify on the General tab is appended to the Path to REST).

    • Object is the Object specified.

    • Path_Parameters is the Path Parameters specified in this step.

    For example:

    http://machine.domain.tld:9090/ws/rest/Customer/{customerId}

  4. Optional: In the HTTP Method list, select the HTTP method for the route.

  5. Optional: The Match the exact end point checkbox controls how incoming API requests are routed. The request only respond to precisely defined requests including path and query parameters, with no variations allowed. This means the system requires static path components to match exactly. Any request must have the same structure as defined in the endpoint configuration. While path variables are recognized and their values can be captured, their positions within the path must also align precisely with the defined structure. Exact match configurations are respected only if the corresponding process is deployed; if not, the endpoint is considered undeployed, and its configuration does not apply. When the checkbox is unchecked it works on the principle of Best Match where the system finds the most specific or closest matching pattern among deployed endpoints.

  6. Optional: In the Request Handled by Process field, select or create a process to handle the incoming requests.

  7. Click OK.

    The new route and, if a resource was added, the new resource, appear in the REST Resources list.

  8. Click Save or Save and Close.

Next steps

The next task is to configure the new route, or if this is a new resource, to configure its route(s). As part of the route configuration you can specify alternative routing by HTTP header.

On this Page