This section describes how to view an API's attributes and how to change them.
When editing the properties of an API, keep the following general points in mind:
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 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 accept only specific types of information. For example, if the asset type includes a URL type attribute, you must supply a URL when you edit that attribute. Other attribute types that require a specific type of value include Date attributes and Email attributes. For a list of the attributes types that an API in the catalog can include, see Attribute Data Types in the document Managing the CentraSite Catalog.
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.
Use the following procedure to edit the attributes associated with an API.
To edit the attributes of an API
In CentraSite Business UI, display the detail page of the API whose attributes you want to edit. If you need procedures for this step, see Viewing the Details of an API.
On the API’s actions menu, click ).
To edit an API’s Name, Description or Version number, place the cursor in the appropriate field and modify the text as required.
To modify the extended attributes associated with the API, do the following:
Select the profile that contains the attribute(s) that you want to modify.
Edit the attributes on the profile as necessary.
Certain APIs contain one or more associated files. For example, the SOAP API includes a WSDL file and the XML / REST API includes a schema file. You can upload a new file or update an existing file for the API accordingly.
For an instance of a SOAP API only. Attach the WSDL file
to the catalog entry using ) in the API’s actions
menu.
For an instance of a XML or REST API only.
Optional. Attach the schema file to the catalog entry using
) in the API’s actions
menu.
APIs (Service, XML service and REST service) can contain one or more operations or resources.
For an instance of a SOAP API only. If you are using
WSDLs along with your SOAP API, attach the WSDL file to the catalog entry using
) in the API’s actions
menu.
CentraSite automatically populates the WSDL URL and the associated operations in the Technical Details profile.
For an instance of a XML or REST API only. If you are
using XML schemas along with your XML / REST API, attach the schema file to the
catalog entry using ) in the API’s actions
menu.
CentraSite automatically populates the schema URL and the associated resources in the Technical Details profile.
After you have specified a schema, specify the following:
Attribute | Description |
---|---|
Endpoint | An endpoint for the API that allows consumers of the API to find and communicate with the API. |
Namespace | A binding namespace for the endpoint. |
Resource | A name for the resource. You can specify multiple resources for an endpoint. |
HTTP Method | HTTP request method(s) for bridging protocols (GET, POST, PUT, DELETE). |
Repeat steps 3.a and 3.b for each profile that you want to edit.
When you have finished making your edits, click
).
Note:
If at any time you want to abandon your unsaved edits, click
(). CentraSite will ask you if you want to save your
edits. Click to abandon your edits and return the
API’s attributes to their previous settings.