Add/Edit REST Service Dialog Box

Relevant for: API testing only

This dialog box enables you to define a new REST service.

To access
  1. Do one of the following:

    • Ensure that an API test or component is in focus in the document pane.

    • In the Solution Explorer, select an API test or component.

  2. Do one of the following:

    • Click the Add REST Service button on the toolbar and select REST Service Editor or Import WADL.

    • Select a REST Service or Web Application service node in the Toolbox pane, and choose Edit Service from the right-click menu.

Relevant tasks

Create a REST service model

Some user interface elements are available only when you select a specific node. The user elements are (unlabeled elements are shown in angle brackets):

UI Elements

Description

Expand All. Expands all of the nodes of the parent REST service.

Collapse All. Collapses all of the children nodes of the parent REST service.

Add Method. Adds a method to the selected REST service node.

Add Resource. Adds a resource to the selected REST service or resource.

Delete. Deletes the selected REST service, resource, or method.

Rename. Renames the selected REST service, resource, or method.

Run Method. Runs the selected method and shows the results in the lower part of the pane.

Note: Available only when you select a method.

<properties pane>

The properties of the REST service methods. For details, see the The Canvas.

<REST Services tree>

Displays a list of the REST services that match the filter condition.

<results pane>

The results of the Run Method command. This section also shows the property values and the response.

Filter box

Filters the display by the entered text.