Web API Source

You can package and deploy a Web API Source from one environment or repository to another environment or repository.

To add Web API Source to Package Template

1. Log on to the Enterprise Console.

2. In the Enterprise Console, click the Menu button, click Settings and then click Web API Source.

3. Right-click on a Web API Source, and then click Add to Package Template.

   The Add to Package Template dialog box appears.

   For more information about adding artifacts to Package Template, see Adding Artifacts to a Package Template.

   You can set the configuration properties of the Web API Source in the Add to Package Template window. The left side of the configuration window shows the package template and its configurations. You can set the configuration properties of the Web API Source package in the Settings form on the right side of the Add to Package Template window.

4. Configure the required settings.

5. Click Save Template to save the configured settings.

Configuration Settings for Web API Source

The Web API Source has a unique set of configuration settings required to install, update, and uninstall the package. You can view and edit the configuration settings from one of the following windows:

• Source Environment > Package Template window

• Target Environment > Manage Package window

Settings

You can define the configuration settings of the Web API Source artifact in the Settings tab. Set the properties in this tab to take appropriate actions while installing, updating, or uninstalling the package.

Install

Use this tab to set the configurations for installing the package.

• Web API Source listitem exists: Use this property to take appropriate action when the Web API Source that is being installed is present in the target environment.

  • Do not install Web API Source listitem: Select this option to use the Web API Source listitem that is present in the target environment.

  • Install to overwrite the existing Web API Source listitem: Select this option to overwrite the Web API Source listitem that is present in the target environment with the one that is present in the package.

Update

Use the settings in this tab to update an installed package.

• Delete Web API Source listitem: Use this property to delete or retain an existing Web API Source listitem that is present in the target environment.

  • Yes: Select this option to remove the Web API Source listitem from the target environment.

  • No: Select this option if you want to retain the Web API Source listitem in the target environment.

• Web API Source listitem exists: Use this property to take appropriate action when the Web API Source listitem that is being installed is present in the target environment.

  • Do not install Web API Source listitem: Select this option to use the Web API Source listitem that is present in the target environment.

  • Install to overwrite existing Web API Source listitem: Select this option to overwrite the Web API Source listitem that is present in the target environment with the one that is present in the package.

Uninstall

Use this tab to configure the settings when the package is being uninstalled from the target environment.

• Delete Web API Source listitem: Use this property to decide if you want to retain or delete the Web API Source listitem in the target environment even after the package is uninstalled.

  • Yes: Select this option to delete the Web API Source listitem from the target environment when the package is uninstalled.

  • No: Select this option to retain the Web API Source listitem in the target environment even after the package is uninstalled.

• Web API Source listitem is modified: Use this property to retain, rollback to original state, or delete the Web API Source listitem in the target environment even after the package is uninstalled. This property is displayed only if Delete Web API Source listitem is set to Yes. However, if Delete Web API Source listitem is set to No, this property is not displayed.

  • Retain: Select this option to retain the Web API Source listitem along with the modifications in the target environment even after the package is uninstalled.

  • Rollback to original state: Select this option to rollback to the original state. All modifications that were done to the Web API Source listitem after it was installed in the target environment will be reverted. However, the Web API Source will be retained in the target environment.

  • Delete: Select this option to delete the Web API Source listitem from the target environment when uninstalling the package

Associated Artifacts of Web API Source

Web API Source does not have any associated artifacts.

Child Artifacts of Web API Source

Web API Source does not have any child artifacts.

Security Artifacts of Web API Source

You can enable the security settings of the Web API Sources that you want to include in the package. For more information about including security artifacts, see Include Security Artifacts.