Skip to main content
Feedback

Generating API endpoints with a new linked listener process in an API Service component

Use the Import an Endpoint wizard to create a new linked listener process for the API Service component.

Procedure

  1. In the API Service component, click Import an Endpoint.

    The Import an Endpoint wizard opens.

  2. Select Create a new process.

  3. Click Next.

    The wizard advances to the Create a Process screen.

  4. In the Process Name field, type a name for the new process.

  5. Browse to the Process Location — the folder in which the new process and its Web Services Server operation are to be generated.

  6. In the Add to field, select the endpoint that you want to generate.

OptionDescription
If REST is selected, the following controls are used to configure the REST endpoint.Name
Description
Object
The unique name of the object upon which the generated route operates. This name also identifies the resource for the route.
URL Path
Sets the URL path for requests for the operation.
The fully-formed URL will be the concatenation of
1. The host and port, set in the Shared Web Server panel (Manage > Runtime Management),
2. The Path to REST, visible in the REST tab (this path contains the Base API Path set on the General tab),
Object, and the path set here.
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.
HTTP Method
Sets the HTTP method used in requests for the operation. Your selection determines the Operation Type for the Web Services Server operation in the new process.
If SOAP is selected, the following controls are used to configure the SOAP operation.Name
Description
Operation Name
The unique name of the operation. The recommended naming convention is the listener Operation Type in all lowercase — get, query, create, update, upsert, or delete — followed by the name of the object upon which the generated endpoints will operate — for example getCustomer.
Even if you followed the recommended naming convention, the Object for the Web Services Server operation in the new process will not be populated.
If OData is selected, the following controls are used to configure the OData entity.Name
Description
Entity Name
The unique name of the entity.
Entity Action
Two OData actions are available for each entity:
1. Get Entities
Select Query Passthrough to enable OData client processes to pass query filters as payloads in action requests.
2. Get Entity By Key

  1. Click Finish.

    The wizard closes and the API endpoints are generated, along with the listener process and its Web Services Server operation. The process is linked to the endpoints, and the process’ Start step is pre-configured to use Web Services Server operation.

  2. In the API Service component, click Save or Save and Close.

Next steps

The next task is to configure the newly generated endpoints.

On this Page