Using deploy anywhere integrations in REST APIs

Creating REST APIs that use deploy anywhere assets is the same as creating regular REST APIs. But, you must configure runtime and sync your APIs.

Before you begin

If you want to use services defined in a webMethods packages, make sure that the packages are added to your project.

Procedure

  1. Create a REST API.
  2. In the Resources and Methods page, select the package service or deploy anywhere flow service that you want to run through this API in the Select services drop-down menu.
  3. Select a runtime from the Runtime drop-down menu. Select Show all runtimes for the list of all runtimes and virtual runtimes that exist in the environment.
    The runtimes and the associated virtual runtimes are displayed.
  4. To create a new virtual runtime, enter the virtual runtime name in the Runtime menu and then click Create virtual runtime.
  5. Click Sync to sync the services.
    The service is linked to the appropriate runtime replicas when you do a synchronization operation.
  6. Save and run the API.

Results

The REST APIs runs on the selected runtime.
Note:
  • Publish-deploy for REST API by using flow services and workflow that has package services is supported. However, if the package services are directly used in REST APIs, you must select the runtimes again in the target environment after each deployment. Otherwise, connections point to the source environment only after deployment.
  • You can clone a REST API by using package service, but you need to add the package to the target project.