Before You Begin
Before you edit the details of an API, keep in mind the following points:
If you are not the owner of the API, you cannot edit the API unless you have Modify permission on the API (granted though either a role-based permission or instance-level permission). For more information about roles and permissions, see the
CentraSite Administrator’s Guide .
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 an API on which you have Modify permission.
If you are viewing the API details page, you can choose between display in
Resources view and
Methods view. The
Methods view is set by default.
When you are viewing the resources and methods, you can delete one or more of the top level REST details - resources and methods by using the
Delete icon. For more information about resources and methods and the
Delete option, see
Viewing the Details of a REST API.
However, if you are editing the resources and methods, then you can delete the remaining resources and methods, namely - request parameters, status codes and sample requests and responses.
If you want to edit the resources and methods, ensure that the
Resources and Methods profile of the API is selected in the edit mode by using
Edit in the action bar for the API.
In the edit mode, you will only see an editable user interface of the Resource-Centric View. There is no Method-Centric View in the edit mode.
If you are editing the API details page, you can modify one or more of the existing entities - resources, methods, request parameters, status codes, sample requests and responses; also you can delete these entities by using
Delete .