Manage APIs

Back Next

Creating a designed API

Create a designed API from a published REST API. To create a designed API, you must be assigned the Deployer or Admin role.

On the

API Console

page, click the

Published APIs

tab.

The

Published APIs

tab shows all the published APIs sorted by the

Last Modified Date

Click the

Actions

menu on the row of the selected published API and select

Create a Designed API

This option is available only for a REST API that is published from an Application Integration process.

The

Create Designed API

dialog box appears.

On the

Location

tab, select a project or folder, and then click

On the

API Details

tab, enter the required information.

Field Name	Description
API Name	Actual name of the REST API asset that saved in API Center. The name must be unique in the selected location. You can't edit the API Name after you create the API. The API Name can contain up to 50 characters, including ASCII letters, digits, Japanese characters, hyphens, dashes, and underscores.
Name	The name is auto-generated based on the API name that you enter.
Location	The Location field is populated based on the project or folder that you selected on the previous tab. To edit the location, go back to the previous tab.
Description	Optional. Enter a description. The description should not exceed 4,000 characters.
Version	The Version field is auto-generated. The version number remains v1 on API Details tab of the Create Designed API dialog box. The version number gets incremented when you create a new version of the newly created designed API.

Click

The

Summary

tab displays all the configured details.

Click

Create

The designed API is created and published. The

Provider Source Name

of the published API gets updated by the designed API name and is appended with the version number (v1).

The

Provider

field of the designed API changes to

API Center

and you can't create another designed API from this published API. The

Last Modified Date

gets updated to the time of creation of the designed API.

You can then edit the designed API or create a managed API from the published API. For more information, see Creating a managed API.

The

Updates Available

icon under the

Published API Name

column on the

Managed APIs

tab in the

API Console

page denotes that a designed API is updated and published. You can view, compare, and accept the available updates. For more information, see Viewing and accepting updates for managed APIs.

Rename Saved Search

Table of Contents

Manage APIs

Manage APIs

Creating a designed API

Creating a designed API