After a platform operator finalizes an API's details, they can release it. Once released, the API's corresponding capability and all its versions appear on the open platform portal. This topic describes how to release and unrelease APIs.
Prerequisites
A capability catalog has been created. For more information, see Manage capability catalog.
Release APIs
Log on to BizWorks. Select Capability Platform from the Select Platform drop-down list. Click the Operations tab.
In the Capability Management navigation pane, choose .
Optional: On the API Management page, you can select the Business View or Application View tab, and then click a target catalog node to view the APIs in that catalog.
NoteBy default, the API Management page displays all APIs.
The left side of the page provides the Business View and Application View tabs to switch between views, with a business category tree below. The upper-right area contains search and filter options. You can search by API Name/Path, Release Status, or Environment Type. You can perform Batch Operations from the upper-right corner. The API list below displays information such as API name, method, path, release status, environment type, project, application, and last update time. The Actions column contains the Edit and Unrelease options.
Find the target API and click Edit in the Actions column.
On the Edit API Details page, complete the configuration information.
Enter the Basic Information, including a description, the API owners, and the catalog. You can select multiple API owners. The selected owners will receive application requests for this API and can review and approve them.
Optional: Configure the Applicable Scenarios, including a title, description, and an icon.
Optional: Configure the Business Value, including a title, description, and an icon.
Optional: Add Integration Steps to help consumers integrate the capability. This includes a step title, role name, step description, and tag color.
Optional: View the Version History. This section is automatically generated by the system and cannot be modified.
Optional: Add an FAQ section to help consumers troubleshoot common issues.
In the upper-right corner of the Edit API Details page, click Save as Draft, Preview, or Submit.
NoteIf you click Preview, you can see how the API will appear on the open portal. If you click Submit, the system saves your changes.
On the API Management page, you can release APIs in one of three ways.
Method 1: Release a single API. In the Actions column for the target API, click Release.
If the API does not have an assigned owner, the Release API dialog box appears. Select an API Owner and click Submit.
Method 2 (batch release): Release APIs in a batch based on the selected capabilities.
Select the checkboxes for the APIs you want to release, click Batch Operations in the upper-right corner, and select Batch Release by Selected Capability.
In the Batch Release by Selected Capability dialog box, specify an API Owner and click Submit.
Method 3 (batch release): Release APIs in a batch based on the selected applications.
From the Batch Operations drop-down list, select Batch Release by Selected Application.
In the Select Applications for Batch Release dialog box, select the applications, specify an API Owner, and click Submit.
Unrelease APIs
On the API Management page, you can unrelease APIs in one of three ways.
Method 1: On the API Management page, in the Actions column for the target API, click Unrelease.
Method 2 (batch unrelease): Unrelease APIs in a batch based on the selected capabilities.
Select the checkboxes for the APIs you want to unrelease, click Batch Operations in the upper-right corner, and select Batch Unrelease by Selected Capability.
In the Batch Unrelease by Selected Capability dialog box, specify an API Owner and click Submit.
Method 3 (batch unrelease): Unrelease APIs in a batch based on the selected applications.
From the Batch Operations drop-down list, select Batch Unrelease by Selected Application.
In the Select Applications for Batch Unrelease dialog box, select the applications, specify an API Owner, and click Submit.