Editing the Properties of an API

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 can include, refer to the section "Attribute Data Types" in the CentraSite Administrator’s Guide.

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.

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 REST API 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 REST API using the CentraSite Business UI.

1. 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 Details for an API.

3. To edit an API’s basic attributes (Name, Version, Organization, Description, and so on), place the cursor in the appropriate field and modify the text as required.

Note:

If at any time you want to abandon your unsaved edits, click Close. CentraSite will ask you if you want to save your edits. Click No to abandon your edits and return the API’s attributes to their previous settings.

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 asset instance of SOAP-based API: Attach the WSDL file to the catalog entry using the Attach action in the API’s actions menu.

For an asset instance of XML or REST-based API: Attach the schema file to the catalog entry using Attach in the API’s actions menu.

For an instance of SOAP-based API If you are using WSDLs along with your SOAP API, attach the WSDL file to the catalog entry using Attach action in the actions bar for the API.

CentraSite automatically populates the WSDL URL and the associated operations in the Technical Details profile.

For an instance of XML or REST-based API If you are using XML schemas along with your XML / REST API, attach the schema file to the catalog entry using Attach action in the actions bar for the API.

CentraSite automatically populates the schema URL and the associated resources in the Technical Details profile.

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).