CentraSite Documentation : Runtime Governance with CentraSite : Virtualized APIs in CentraSite Business UI : Viewing or Changing a Virtual API
Viewing or Changing a Virtual API
 
Profile Information for an Virtual API
This section describes how to view the information stored for a virtual API and how to change them.
When editing the details of a virtual API, keep the following general points in mind:
*If you are not the owner of the API, you cannot edit the virtual API unless you have Modify permission on that API (granted though either a role-based permission or an instance-level permission).
*When you view the details for the 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.
*Some attributes are designed to be read-only and cannot be edited even if they appear in a virtual 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 an API on which you have Modify permission.
*This is of specific relevance to virtual REST APIs. Beginning with version 9.7, CentraSite supports the enhanced interface for REST APIs (in contrast, earlier versions of CentraSite supported a standardized interface for virtual REST APIs). Documentation of the prior REST and XML service interface is available to Software AG customers who have a current maintenance contract in Empower, Software AG's global extranet (http://empower.softwareag.com/).
*If you have virtual REST APIs that were created prior to version 9.7 or if you are using the current version of CentraSite Business UI, you will only be able to view details of these APIs in CentraSite Control. You cannot edit virtual REST API using the CentraSite Control user interface (not even if you belong to the CentraSite Administrator role). This is because; CentraSite Control does not support the enhanced REST interface. You will only be able to edit virtual REST API using the CentraSite Business UI.
To view or edit the details page of a virtual API
1. In CentraSite Business UI, display the detail page of the virtual API whose details you want to modify. If you need procedures for this step, see Working with the CentraSite Business UI .
2. To modify the basic attributes, such as, Name, Description or Version number, place the cursor in the appropriate field and modify the text as required.
3. To modify the extended attributes associated with the virtual 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.
4. To modify the run-time actions configured for the virtual API, do the following:
a. Navigate to the Virtualize <API_Name> (Step 2 of 3) wizard.
b. To add an action to the Message Flow area, do the following:
i. In the Policy Actions area, expand the desired accordion (Request Handling, Policy Enforcement, Response Handling or Error Handling).
ii. Locate the action you want to add for the virtual API.
iii. Drag and drop the action in the appropriate stage (Receive, Enforce, Routing or Response) in Message Flow area.
iv. Repeat the above steps for each action that you want to add.
c. To reconfigure an existing action in the Message Flow area, do the following:
i. In the Message Flow area, locate and mouse hover the action whose parameters you want to modify.
ii. Choose the Configure  icon to the right of the action name.
iii. In the <action name> dialog box, set the values for the parameters as necessary.
iv. Click OK to save the parameter settings.
v. Repeat the above steps for each action that you want to modify.
5. Remove an action from the Message Flow area using the Delete  icon to the right of the action name.
6. To publish or unpublish the virtual API to one or more gateways, do the following:
a. Navigate to the Virtualize <API_Name> (Step 3 of 3) wizard.
b. Select or unselect the gateways from that you want to publish or unpublish the virtual API.
c. Click Publish or Unpublish button, appropriately.
Copyright © Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback