CentraSite Documentation : Working with REST-based APIs : Managing RESTful APIs : Viewing a REST API
Viewing a REST API
 
Using the Method-Centric View
Using the Resource-Centric View
Viewing the List of REST APIs
Viewing the Details of a REST API
You use the details page of the REST API to examine your existing documentation.
Before You Begin
The following general guidelines apply when examining an existing API documentation:
*If you are not the owner of the API, you cannot view the API unless you have View permission on the API (granted though either a role-based permission or instance-level permission). For more information about roles and permissions, see Getting Started with CentraSite.
*You will only see profiles for which you have the instance-level View permission.
*If you are viewing the API details page, you can choose to display in Resources view and Methods view. The Methods view is set by default.
*In either of the views, mouse hover the resource or method details and delete that resource or method using the Delete icon.
If You Migrate REST APIs from a Pre-9.7 Release
If you have REST APIs that were created prior to version 9.7, those APIs will continue to hold the old version's metadata in the enhanced REST API interface implemented by current version of CentraSite.
Getting Started with CentraSite offers the Resource Centric and Method Centric Views for examining the details of a REST API.
Copyright © 2005-2015 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback