Share this page

# Interactive API client

The interactive API client lets you conveniently test and run API calls.

In this topic:

## Overview

You can use the interactive API client to explore supported API calls and to modify data.

The entities you can access, and the operations you can perform, are based on the roles and permissions assigned to the API key that you use to sign in.

Note: You cannot use the interactive API client to perform site or space admin actions. Use the user interface or another REST API client tool instead.

You can make API calls directly from the interactive API client, or by copying examples into your code.

## Use the REST API interactively

Follow these instructions to work with the REST API interactively.

1. Prerequisite: Obtain an API access client ID and secret from your admin. The API key must be assigned to a workspace. For details, see API access.

2. In the Help menu , click Interactive API Client.

   Tip: Another way to access the interactive API client is with this URL: `http://<server>:<port>/ui/swagger-ui/swagger.jsp`

3. Enter the API client ID and secret.

   Click Login.

4. If the API key is assigned to more than one workspace, select a workspace in the dropdown list.

5. Entity resources and operations are displayed. Only the entities and operations that are available for the role as defined in your API access key, and for the current workspace, are available.

   Click Generic APIs to view all resources, or CI/CD APIs to see a subset of resources relating to continuous delivery.

   Collapse or expand an entity resource to show / hide its operations (DELETE, GET, POST, PUT).

   Caution: POST, PUT, and DELETE operations modify data, such as adding or editing defects or tests. You, and other users, can view these changes in in real time.

6. Select an entity and an operation, and enter parameter values. The interactive API client guides you by verifying your requests, for example, if you are missing a required field.

7. Click Execute to perform the operation using the parameters you have specified, or copy examples or syntax into your code.

   For details on returned response codes, see Errors and status codes.

## Retrieve interactive client metadata

You can export the interactive client's metadata using the following request:

`https://<server>:<port>/api/shared_spaces/<space id>/workspaces/<work space id>/swagger`

The endpoint supports two specification formats: OAS 2.0 (Swagger2) and OAS 3.0 (OpenAPI3).

- Spaces upgraded from 26.2 and earlier use by default OAS 2.0 (Swagger2).

- New spaces created in 26.3 and later use by default OAS 3.0 (OpenAPI3).

To request a specific format regardless of the default, append a `format` query parameter:

- `/swagger?format=swagger2` — returns OAS 2.0
- `/swagger?format=openapi3` — returns OAS 3.0

Responses in OAS 2.0 format include the following headers to signal that this format is deprecated:

- `Deprecation: true`
- `Sunset: TBD`
- `Link: </swagger?format=openapi3>; rel="successor-version"`

To change your space's OAS format to 3.0, set the ENABLE_SWAGGER_OPENAPI site parameter to true. For details, Configuration parameters.

## See also

- API access
- REST API calls

https://admhelp.microfocus.com Software Delivery Management 8942
Tips to improve your search results... OpenText™ Software Delivery Management Help Center OpenText™ Software Delivery Management Help 26.3 All View Local Help Center View Online Help Center Version: