Viewing and Modifying Virtual OData Service Details

You use the details page of a Virtual OData Service asset to examine and modify the EDMX specification.

The asset type Virtual OData Service has a unique set of profiles. However, an administrator can configure this asset type to display a customized set of profiles and attributes.

The following general guidelines apply when modifying the details of a Virtual OData Service asset in CentraSite Business UI:

If you are not the owner of the Virtual OData Service, you cannot examine or modify the details of the Virtual OData Service, unless you have the View or Modify permission on the Virtual Service (granted though either a role-based permission or an instance-level permission).

When you view the details page of a Virtual OData Service, you will only see profiles for which you have the profile-level View permission. You will only be able to modify the attributes of the profiles on which you have the Modify permission.

When you hover over an attribute, CentraSite displays the tooltip text that provides a short description of the attribute's purpose.

Some attributes accept only specific types of information. For example, if the Virtual OData Service asset type includes a URL type attribute, you must supply a URL when you modify that attribute. Other attribute types that require a specific type of value include the Date and Email attributes.

Some attributes are designed to be read-only. You cannot modify the read-only attributes even if you have the CentraSite Administrator role.

In this task you modify the basic and type-specific attributes that are associated with a Virtual OData Service.

To examine and modify the details of a Virtual OData Service asset

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 OData Service, click Choose.

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

a. Click the chevron next to Assets option button.

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

c. Click OK.

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

This opens the Virtual OData Service details page. Also, the actions bar displays a set of actions that are available for working with the Virtual OData 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 OData 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. To modify the extended attributes that are displayed in the individual profiles, follow these steps:

a. Select the profile that contains the attribute(s) you want to modify.

b. Change values of the attributes in the respective data fields as necessary.

c. Repeat steps 7.a and 7.b for each profile for which you want to modify the attributes.

8. Click Save.

The details page of a Virtual OData 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.