REST Resources Wizard

webMethods CloudStreams 10.3 | webMethods CloudStreams Documentation 10.3 | CloudStreams Governance Project | Virtual Services (REST) | REST Resources Wizard

To open the REST Resources wizard:

1. In the CloudStreams Governance view, expand your CloudStreams Governance project and click the virtual service name. (If the Properties view is not already open, click Window > Show View > Other > General > Properties). Click the virtual service name and then click the “Advanced” tab.

2. On the Advanced page in the Properties view, click the Resource button.

Complete the following fields:

Resource

Specify the name of the REST resource that the service will access.

Note: To add a REST resource to the service after the service has been created, right-click the service name and select Attach Resource from the context menu.

HTTP Method

The HTTP methods that the virtual service should be allowed to perform on the REST resource (GET, POST, PUT and DELETE).

It is important to specify all the HTTP methods that are supported for the virtual service. For example, if the virtual service is deployed to CloudStreams and only the GET method was selected in the virtual service definition, then CloudStreams will only permit GET invocations. A POST request will be rejected with a return of statusCode 405 even if the native service happens to support POSTs. It is also important for the native service to return the correct “Content-Type” header with its responses.

At run time, CloudStreams determines the type of a request message based on the message's HTTP method and its Content-Type. For a list of valid HTTP method/Content-Type combinations, see the section The Request Message's HTTP Methods and Content-Types for REST Services in the document Administering webMethods CloudStreams.

Content Type

Select Application/xml or Application/json.

Query String

Specify the search string as required. Any text typed in is not case sensitive. This field is used only for documentation purposes at this time. It is not included in the service's "virtual service definition" (VSD) that is deployed to CloudStreams, so this value has no impact at runtime.

Import From

Import the schemas that the virtual service will use. Choose one of the following options. To select multiple schemas, click the plus button to add a row.

URL: Specify the URL of a schema and click the Add button. Optionally choose the following option::

URL authentication: If you have specified a URL and the site you want to access using the URL requires user authentication, select this option. This opens an Authentication sub-dialog in which you can enter a user name and password for authentication at the URL site.

File: Click Browse to select a schema from your local file system.