Viewing Details for an API
CentraSite provides several attributes that offer general and additional information about an API. The information rendered as attributes are grouped together as profiles.
When you view the details of an API, keep the following points in mind:
The set of APIs that are available to you are the APIs on which you have View permission. You can obtain View permission on an API in the following ways:
By belonging to a role that includes any of the following permissions.
This permission... | Allows you to... |
View Assets | View all APIs within a specified organization. |
Modify Assets | View and edit all APIs within a specified organization. |
Manage Assets | View, edit, and delete all APIs within a specified organization, and set instance-level permissions on those APIs. This permission also allows you to create APIs. |
Create Assets | Add new APIs to a specified organization. You automatically receive Full permission (which implies Modify and View permission) on all APIs that you create. |
By having View, Modify, or Full instance-level permissions on a particular API.
By default, all
CentraSite users belong to the Asset Consumer role. This role includes the View Assets permission for the organization to which a user belongs.
Having the Asset Consumer role gives you implicit view permission on all the APIs in your organization. You can view APIs from other organizations only if you are given permission to do so through the assignment of additional role-based or instance-level permissions.
In rare instances, an administrator might not grant view permissions to all of the users in an organization. If the administrator of your organization has done this, you will need instance-level permissions on an API in order to view it. For more information about roles and permissions, see
Getting Started with CentraSite.
CentraSite renders the
Basic Information profile by default.
Beginning with version 9.8,
Advanced Information profile is typically hidden from users who look for details of the object types to reuse. As a result, all the generic and custom profiles defined for an API are rendered in a flat structure.
In the navigation panel of the API details page, the profile selected for rendering displays highlighted with a font awesome icon.
CentraSite displays a font awesome icon if the profile has one or more mandatory attributes with empty value.
Profiles that have no data are displayed in gray in the navigation panel when you are in view mode. These profiles become active in edit mode.
Attributes that only have a value are displayed in the content panel when you are in view mode. However,
CentraSite maintains all of the attributes associated with a profile in edit mode, irrespective of their values.
You can view a tooltip text on mouse over of the truncated profile name. The tooltip text gives the fully qualified name of the profile as defined in the API's asset type definition.
You can view a tooltip text for any attribute in a profile of the API's details by moving the cursor over the attribute. The tooltip text gives a summary of the attribute's purpose. The tooltip text shown is the content of the attribute's
Description field, and is as defined for the API in the asset type definition.
When you move the cursor over an action on the actions bar, a pop-up label displays the action name.
The actions displayed vary depending on your current configuration settings and the type of asset instance.
You will only see the profiles for which you have View permission. If you have Modify permission on the API, you can edit the API’s attributes. For procedures, see
Editing the Properties of an API.
Profiles that have no data are displayed in gray in the navigation panel when you are in view mode. These profiles become active in edit mode.
This is of specific relevance to 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 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 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 or delete REST APIs 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 or delete REST APIs using the
CentraSite Business UI.
To view the details that you have stored for an API, proceed as follows:
To view details for an API
2. In the displayed list, click the link of the API whose details you want to view. This shows the details of the API.
The details include:
The API's basic information (the API's version identifier, asset type, owning organization, last modified date, owning user, and a general description of the API).
Attribute | Description |
Native Service | (Applicable for a virtualized API only.) Displays the native API that is associated with the virtualized API. |
Virtual Services | (Applicable for a native API only.) Displays the virtualized APIs that are associated with the native API. If the native API has a single virtualized API associated to it, this attribute displays the name of that particular virtualized API. If the native API has more than one virtualized API associated to it, then this attribute simply displays the count of the associated virtualized APIs. When you click this count, CentraSite lists the associated virtualized APIs. |
Watchers | The number of users who are watching the native API and/or it's associated virtualized APIs. |
Consumers | The number of users registered as consumers for the native API and/or it's associated virtualized APIs. |
Consumed Assets | The number of assets to which the native API and/or its virtualized APIs 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 API (namely, technical and specification details, provider and consumer information, gateways to which the API is published, and so on).
3. On the individual profiles of the API, examine the attributes as necessary.