Search Results

Interactive Documentation

Interactive Documentation is an interactive documentation system for RESTful and SOAP-based APIs. You can specify Interactive Documentation page settings and add definitions to selected APIs. The page lists the Interactive Documentation that is registered on API Control Center.

Design > Interactive Documentation



The following table describes the fields on the Interactive Documentation page. Clicking the New Interactive Documentation allows you to create a new Interactive Documentation item. Clicking the Interactive Documentation Portal Page Settings button opens the Interactive Documentation Portal Page Settings page, where you can define the Page Title and Page Description for the Interactive Documentation page on the portal. For more information, see Interactive Documentation Portal Page Settings.

Field

Description

Title Name of the Interactive Documentation item.
API Name Name of the API Definition.
Document Type IO Doc or Swagger
Last Modified By Name of API Control Center user who last modified the Interactive Documentation item.
Shown By Default If Yes, this is the default Interactive Documentation item that is displayed when the Interactive Documentation page is opened on the portal.
Organization Organization assigned to the Interactive Documentation item.
Created Date and time when the Interactive Documentation item was created.
Updated Date and time when the Interactive Documentation item was last updated.
Actions
Click the icon to modify the Interactive Documentation item.
Click the icon to delete the Interactive Documentation item.