Skip to main content
Feedback

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.

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.

FieldDescription
TitleName of the Interactive Documentation item.
API NameName of the API Definition.
Document TypeIO Doc or Swagger.
Last Modified ByName of API Control Center user who last modified the Interactive Documentation item.
Shown By DefaultIf Yes, this is the default Interactive Documentation item that is displayed when the Interactive Documentation page is opened on the portal.
OrganizationOrganization assigned to the Interactive Documentation item.
CreatedDate and time when the Interactive Documentation item was created.
UpdatedDate 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.