If you have an existing API definition in a file, you can import the API definition to quickly import multiple operations to the REST API on the REST API page.
When you import an API definition, you select the file that contains the definition, the URL that points to the definition, or APIs of IDMC services. You can import an API definition from the following sources:
•OpenAPI 3.0 JSON
•OpenAPI 3.0 YAML
•Swagger 2.0 JSON
•Swagger 2.0 YAML
After you specify the source file or URL, API Center parses the source and loads the operations. You select the operations to import.
Importing Application Integration processes to API Center
You can import all the Application Integration processes to API Center. The processes on the Service Name corresponds to the API Name and the Source Name corresponds to the Name in Application Integration.
This import capability helps you easily transition the REST APIs of published Application Integration processes into API Center. You can easily design, publish, and create managed APIs in API Center.
Importing an API definition
On the REST API page, import an API definition to create a REST API.
1On the right panel of the REST API page, click Import an API Definition or Import.
2Select the API definition type to import. In the Source field, select one of the following source types:
- File. Select an API definition file from your local system.
- URL. Specify a URL that points to the location of the API definition file.
Note: If the URL points to a specification that requires authentication, you can't select the URL option. You must download the specification as a file by providing the authentication details, save it as local file, and then import it as a file.
- IDMC Services. Select the IDMC service from which you want to import the APIs.
3Click Next.
The Select Assets tab appears. API Center parses the file and displays the operations on the Select Operations tab. If there are conflicts between the operations and the API, or any issue with the source file, API Center displays the warning details. Fix the API definition file and try again.
When you select Application Integration as the source, all published processes in Application Integration appear. You can filter the data by service name.
When you select Data Quality as the source, the deployment or API created on the Data Quality assets appear. Select the deployed asset that you want to import.
Note: If your organization is not provisioned for Data Quality, you can't import the Data Quality assets. Contact your organization administrator for information about provisioning your organization.
4Select the operations to import and click Next.
The Summary tab displays a summary of the assets that you selected.
5Click Import.
API Center imports the selected policies and operations. You can update the policies and operations if needed. For more information, see Creating an API operation.
Note: You can import operations from only one type of IDMC provider for an API. For a single API, you add operations either from an Application Integration process or from a Data Quality asset.
6Click Save.
Importing and mapping an Application Integration process
You can import all the published REST APIs of Application Integration to API Center. You can import all published processes in Application Integration.
1On the right panel of the REST API page, click Import an API Definition, or click Import.
2Select the API definition type to import. In the Source field, select IDMC Services.
3Select Application Integration as the provider.
4Click Next.
In the Select Assets tab, all published processes in Application Integration appear. The list displays the service name, source name, status, protocol, and description of each published Application Integration process. You can filter the data by service name.
The following table shows the fields in API Center with their corresponding fields in Application Integration:
API Center Field
Application Integration Field
Source Name
Process Name
Service Name
API Name
Description
Description in the General tab of Start Properties.
5Select an asset to import and click Next.
You can select only one asset at a time.
The Summary tab displays a summary of the assets that you selected.
6Click Import.
API Center imports the selected assets and the related Swagger definitions from Application Integration and populates the operation metadata area.
The following table explains the correlation between the API Center and imported Application Integration assets:
API Center Tabs
Application Integration Field
Request method
Auto-populated from the Swagger definition.
Parameters
NA. Application Integration doesn't support any query or path parameters.
Request
All properties defined in the Input Fields of the Application Integration process. Required fields in Application Integration appear as True in API Center.
Response
All properties defined in the Output Fields of the Application Integration process.
Required fields in Application Integration appear as True in API Center.
Response headers present in Application Integration appear in API Center.
When you import an API definition with multiple response codes, you can view all the response codes. You can edit the response codes. However, you can't add any new response on the Response tab.
Implementation
The imported Application Integration process is already mapped and all the relevant fields are populated accordingly.
Policies
NA. API Center retains its default policy configurations.
7Click Save.
8Validate and publish the API.
Importing Data Quality assets
You can import Data Quality assets to API Center to design and publish an API endpoint.
You can import rule specifications that you have enabled in Data Quality into API Center to design and publish an API. You can then create a managed API endpoint from the published API. Use the managed API endpoint URL to integrate the rule specification capabilities directly within your application. For more information about Data Quality rule specifications, see Rule specification assets in Data Quality help.
Additionally, you can import a Data Integration mapplet that contains a Data Quality transformation as an API and design a custom endpoint to expose the mapplet, enabling seamless integration and reuse of Data Quality capabilities through your APIs. For more information about mapplets, see Components in Data Integration help.
1On the right panel of the REST API page, click Import an API Definition or Import.
2Select the API definition type to import. In the Source field, select IDMC Services.
3Select Data Quality as the provider.
4Click Next.
On the Select Assets tab, you see all assets that you enabled in Data Quality as APIs.
5Select an asset to import and click Next.
You can select only one asset at a time.
The Summary tab displays a summary of the asset that you selected. The summary includes the source name, provider name, asset name, description, operation name, and warnings, if any.
6Click Import.
API Center imports the selected asset and populates the operation metadata area based on the API specifications of the data quality asset.
The following table describes the correlation between the API Center and imported Data Quality assets:
API Center Tabs
Data Quality Field
Request method
Operation path auto-populated from the Data Quality rule specification.
Parameters
Not applicable. Data Quality doesn't support query parameters and path parameters.
Request
All properties defined in the Inputs field of the Data Quality rule set.
Required fields in Data Quality appear as False in API Center.
Response
All properties defined in the Outputs field of the Data Quality rule set.
When you import an API definition with multiple response codes, you can view all the response codes. You can edit the response codes. However, you can't add a new response on the Response tab.
Implementation
The imported Data Quality rule specification is already mapped and all the relevant fields are populated accordingly.
The Mapped Rule field indicates the mapped Data Quality rule specification. You can click on the rule to navigate to the configuration workspace for the rule specification in Data Quality.
Policies
All Data Quality operations must contain a session ID based authentication policy.
You can either create a new session ID or inherit and use an existing session ID.
For more information about session ID authentication, see API Policies.
7Click Save.
8Validate and publish the API.
After you publish an API, create a managed API from the published API. You can then share the API endpoint URL with your API consumers so that they can access the operations of the managed APIs. For more information about managing the lifecycle of a managed API, see Manage APIs.