Version 9.5 SP1
 —  API Management Solutions  —

Editing the Properties of an API

This section describes how to view an API's attributes and how to change them.


General

When editing the properties of an API, keep the following general points in mind:

Top of page

Edit the Attributes of an API

Use the following procedure to edit the attributes associated with an API.

Start of instruction setTo 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 the Details of an API.

  2. On the API’s actions menu, click Edit (graphics/action_edit.gif).

  3. To edit an API’s Name, Description or Version number, 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:

    1. Select the profile that contains the attribute(s) that you want to modify.

    2. Edit the attributes on the profile as necessary.

      Specifying an Input File

      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 Attach (graphics/action_attach.gif) 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 Attach (graphics/action_attach.gif) in the API’s actions menu.

      Specifying a Native Endpoint

      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 Attach (graphics/action_attach.gif) 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 Attach (graphics/action_attach.gif) 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).
    3. Repeat steps 3.a and 3.b for each profile that you want to edit.

  5. When you have finished making your edits, click Save (graphics/action_save.gif).

    Note:
    If at any time you want to abandon your unsaved edits, click Close (graphics/icon_close.png). 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.

Top of page