Viewing the Details of a REST API
In this task you view the various basic and type-specific attributes associated with the API. You can view the resources, methods and parameters in the Resources view and the Methods view; in addition, you can delete the existing API parameters, resources and methods.
To view the details of a REST API
2. In the displayed list, click the link of the API whose details you want to view. This shows the API's basic information (version identifier, last updated date, asset type, owning organization, owning user, a description of the API).
You can view a tooltip text for some of the attributes in the profiles of the API's details by moving the cursor over the info icon. The tooltip text gives a summary of the attribute's purpose. The tooltip text shown is the content of the attribute's Name and Description fields as defined in the API.
3. Use the Resources and Methods profile to view the extended details of the API, namely, resources, methods, parameters, status codes, and request and response messages
The content in the Resources and Methods profile reflects the view selection that you make - resource-centric, or method-centric. The profile displays multiple fields which are dependent on the view you select.
4. To select a view, use the Resources | Methods menu displayed on the right hand side. Depending on the view selected, the profile displays a list of resources, or methods.
5. Expand the resource name whose details you want to view.
6. Click the name button of the method to view its details.
7. Drill down to different levels in the API Parameters, Resource Parameters, Method Parameters, HTTP Requests, HTTP Responses, and Sample Requests and Responses to see details of each of them.
8. Click the hyperlinked parameter name to its view details.
9. If you have resources and methods defined for the API, you can delete one or more of these entities by using the Delete icon in the Resources and Methods profile as follows:
a. Ensure that the Resources and Methods profile of the API is selected in the API's detail view mode.
b. In the Resource-Centric View, locate the resource that you want to delete. Do the following:
a. Move the cursor over the resource you want to delete.
b. Click the Delete icon
c. Repeat for each resource that you want to delete.
d. You can also drill down to the individual HTTP methods that are defined for the selected resource and repeat the previous steps for each method as required.
c. In the Method-Centric View, locate the HTTP method that you want to delete. Do the following:
a. Move the cursor over the method you want to delete.
b. Click the Delete icon.
c. Repeat for each method that you want to delete.
Contact Support
|
Community
|
Feedback