Viewing or Changing a Virtualized API
This section describes how to view the information stored for a virtualized API and how to change them.
When editing the details of a virtualized API, keep the following points in mind:
If you are not the owner of a particular virtualized API, you cannot edit that virtualized API unless you have a Modify permission on the API (granted though either a role-based permission or an instance-level permission).
When you view the details for the virtualized API, you will only see profiles for which you have View permission. You will only be able to edit the profiles on which you have Modify permission.
In addition to the above described permissions for managing a particular virtualized API, make sure that you have the specific roles and permissions required for reconfiguring the run-time actions and republishing the virtualized APIs to
Mediator and
API-Portal gateways as specified in
Roles and Permissions Needed to Create and
Manage Virtualized APIs.
Some attributes are designed to be read-only and cannot be edited even if they appear in a virtualized API on which you have Modify permission.
Some attributes accept only specific types of information.
Some attributes are designed to be read-only and cannot be edited even if they appear in a virtualized API on which you have Modify permission.
To view or modify the details that you have stored for a virtualized API, proceed as follows:
To view or modify the virtualized API's details
1. In CentraSite Business UI, display the list of virtualized APIs (see Working with the CentraSite Business UI for details).
2. In the displayed list, click the link of the virtualized API whose details you want to view or modify. This shows the details of the virtualized API.
The details include:
The virtualized API's basic information (the virtualized API's version identifier, asset type, owning organization, last modified date, owning user, and a general description of the Native Virtual).
In addition to the generic attributes listed above, the virtualized API contains the following information, based on it's consumption.
Attribute | Description |
Native Service | Displays the Native API that is associated with the virtualized API. |
Watchers | The number of users who are watching the virtualized API. |
Consumers | The number of users who are registered as consumers for the virtualized API. |
Consumed Assets | The number of assets to which the virtualized API is registered as a consumer. |
Pending Approvals | The number of requests that are pending for approval. |
Requested User | Displays the consumer who has requested for an API key or an OAuth2 Client access token. |
Additional information about the virtualized PI (namely, technical and specification details, provider and consumer information, gateways to which the virtualized API is published, and so on.)
3. If you want to make changes to the virtualized API's generic details that are displayed in the Basic Information section, click the Edit icon. You can then enter new values for the API's fields.
4. If you want to make changes related to the extended attributes of the virtualized API, do the following:
a. Select the profile that contains the attribute(s) that you want to modify.
b. Edit the attributes on the profile as necessary.
c. Repeat steps 3.a and 3.b for each profile that you want to edit.
5. Then click the Save icon to save the changes.
If you want to make changes related to the virtualized API's run-time configuration, follow the instructions in
Assigning Run-Time Actions to a Virtualized API.
If you want to make changes related to publishing the virtualized API to the gateways, follow the instructions in
Publishing and Unpublishing APIs to and from
Gateways.