Viewing and Modifying Basic Details of Virtual REST Service

In this task you examine and change the various basic and type-specific attributes associated with the Virtual REST Service. In addition, you can examine and change the various components of the Virtual REST Service - Resources, HTTP methods, Parameters, HTTP Requests and Responses, and the Sample Messages in the Resources view and the Methods view, as applicable. You can also delete the existing REST components - Resource Parameters, Method Parameters, HTTP Requests and Responses, and the Sample Messages.

To examine and modify the basic details of a Virtual REST Service

1. In CentraSite Business UI, access the Advanced Search panel in one of the following ways:

Click the Browse link in the upper-left corner of the menu bar.

Click the Search icon next to the Scope list. The default search scope is Assets.

This displays a list of assets in the Search Results page.

2. In the Additional Search Criteria list, select Asset Types.

3. To search for the assets of type, Virtual REST Service, click Choose.

This opens the Choose Asset Types dialog box.

4. In the Choose Asset Types dialog box, select the Assets option button, and follow these steps:

a. Click the chevron next to Assets option button.

b. In the list of asset types, select Virtual REST Service.

c. Click OK.

A list of defined Virtual REST Service assets is displayed in the Search Results page.

5. Click the Virtual REST Service you want to examine and modify the basic attributes.

This opens the Virtual REST Service details page. Also, the actions bar displays a set of actions that are available for working with the Virtual REST Service.

You can hover over the info symbol next to an attribute to display the tooltip text, which describes the purpose of the attribute. The tooltip text displays the values of the attribute's Name, and Description fields that are contained in the Virtual REST Service type definition.

6. To modify the generic attributes that are displayed in the Basic Information profile, on the actions bar, click Edit. Change values of the attributes in the respective data fields as required.

7. Click Save.

The details page of a Virtual REST Service asset includes the following additional information:

Identification Profile (for Assets with Key-based Authentication)

Field	Description
API Key String	Read-only. String. The confidential secret key used to securely authenticate the consumer. The API Key String field is visible only to the consumer who requested an API key.
Expiry Date	Read-only. String. An expiration date for the API key.

Identification Profile (for Assets with OAuth-based Authentication)

Field	Description
Client Id	Read-only. String. The unique identifier that is used by the client to fetch access tokens for the virtual API.
Client Secret	Read-only. String. The secret key value that is used with the client identifier, serves as a password to fetch access tokens for the virtual API.
Client Name	Read-only. String. The name of the client (consumer application) that is attempting to get access to the virtual API.
Scope	Read-only. String. The scope value is the name of the virtual API. If the scope value is valid, API Gateway obtains the access token. If no scope value is provided, API Gateway provides the access token to the scope in which the client is allowed and adds the scope to the response.
Refresh Token	Read-only. String. The unique identifier used by the client to obtain a new access token when the current access token becomes invalid or expires.

API Key Scope Profile

Field	Description
API Service	Read-only. String. The name of the virtual API that is associated with the API key. To view details of the virtual API, click its hyperlinked name.