CentraSite Documentation : Working with the CentraSite Business UI : API Management Solutions : Editing the Properties of an API
Editing the Properties of an API
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 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 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.
To edit the attributes of an API
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.
2. In the actions bar for the API, click Edit.
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.
4. To modify the extended attributes associated with the API, do the following:
a. Select the profile that contains the attribute(s) that you want to modify.
b. Edit the attributes on the profile as necessary.
c. Repeat the above steps for each profile that you want to edit.
5. When you have finished making your edits, click Save.
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.
Specifying an Input File
Certain APIs contain one or more associated files. For example, the SOAP API includes a WSDL file and the REST API includes a RAML or Swagger file. You can upload a new file or update an existing file for the API using the Attach action.
*For an instance of SOAP API: Attach a WSDL file to the catalog entry.
*For an asset instance of REST API: Attach a RAML or Swagger file to the catalog entry.
*For an asset instance of OData API: Attach an EDMX file to the catalog entry.
Specifying a Native Endpoint
APIs (Service, REST Service, and OData Service) can contain one or more operations or resources.
*For an instance of SOAP API: Upon attaching a WSDL file, CentraSite automatically populates the WSDL URL and the associated operations in the Technical Details profile.
*For an instance of REST API: Upon attaching a RAML or Swagger file, CentraSite automatically populates the RAML or Swagger URL and the associated resources in the Resources profile.
After you have specified a input file, 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).
*For an instance of OData API: Upon attaching an EDMX file, CentraSite automatically populates the OData URL and the associated operations in the OData Resources profile.
Copyright © 2005-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback