Add a native endpoint
The OpenAPI Specification explains the structure and purpose of an endpoint specification. If you create a Service from a specification, APIM 3.0 defines the endpoints, paths, HTTP methods, and configures the request and response for you.
To add a Triggered Task or Ultra Task endpoint to a Service created from a specification or from scratch:
Create the endpoint
- With the appropriate version of the Service open, make sure that the Endpoints tab is selected.
- Click Add endpoint. The New endpoint panel opens:
- For endpoint type, click Triggered or Ultra.
- Click the Task field and select the task to add.
- In the Tags field, enter one or more tags and press
Enter to apply them. Endpoint tags provide a way to group related endpoints.
Endpoints without a tag show up as Ungrouped in the endpoint dropdown list as
shown below.
- Optionally, select a Snaplex to override the Server selected at the Service level.
- Click Create. The endpoint opens and a message informs you that there are No paths yet.
Add Paths
For each Path (route) for this endpoint:
- Click Add path to open the Add new path panel:
- Add a Description to clarify the purpose of this endpoint path.
- For Routing method, click Rules to specify a simple path or Expression to define a condition for the path. Refer to Endpoint configuration for an example expression.
- Optionally, add an Upstream path that will be appended to the URL.
- Click plus to add any required parameters. The parameters will be appended to the URL. Parameter configuration describes parameter options.
- Click plus to add one or more Methods. Method configuration describes method options.
- Click Create.
If the Catalog Policy contains the appropriate rules, the endpoint is ready. If not, apply a Policy at the Service or endpoint level, and you are ready to test.