Web API

You can package and deploy a Web API along with its associated artifacts from one environment or repository to another environment or repository.

To add Web API 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.

   The Web API window appears.

3. Right-click on a Web API, 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 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 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.

Runtime Initialization Settings

You can configure runtime initialization settings for Web APIs. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

Configuration Settings for Web API

The Web API 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 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 exists: Use this property to take appropriate action when the Web API that is being installed is present in the target environment.

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

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

• Web API Configuration: Displays the URL of the Web API in the source environment and it also allows you to specify the URL of the Web API in the target environment:

  • Source Base Address: Displays the URL of the Web API in the source environment

  • Target Base Address: Specify the URL of the Web API in the target environment. If it is left blank, then the source base address will be considered.

  • Source Authentication Mode: Displays one of the following authentication mode options in the source environment:

    • No Authentication: If the Web API does not require authentication.

    • Windows: If the Web API is Windows authenticated.

    • User Access Token: If the Web API requires the currently logged-in user's access token.

    • Basic Authentication: If the Web API requires basic authentication. Displays the user name with domain and the password.

    • Certificate: If the Web API requires certificate authentication. Displays the thumbprint and the password.

    • Service to Service Access Token: If the Web API requires Service to Service Access Token.

  • Target Authentication Mode: Select one of the following authentication mode options in the target environment:

    • No Authentication: If the Web API does not require authentication.

    • Windows: If the Web API is Windows authenticated.

    • User Access Token: If the Web API requires the currently logged-in user's access token.

    • Basic Authentication: If the Web API requires basic authentication. Provide the user name with domain and the password.

    • Certificate: If the Web API requires certificate authentication. Provide the certificate thumbprint and the password.

      Note: To establish the Web API connection in the target environment, you need to edit the Web API and provide the certificate.

    • Service to Service Access Token: If the Web API requires Service to Service Access Token. Provide Authority URL, Audience, Client ID, Client Secret, and Scope to get the access token.
      
      In the Authority URL, provide the token end-point of the respective repository provider. For example,
      
      CONNECT: {authority url}/oauth/token
      Azure Active Directory: {authority url}/oauth2/v2.0/token
      AVEVA Identity Manager: {authority url}/connect/token

Update

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

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

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

    Web API is modified: Use this option to retain, rollback to original state, or delete the Web API in the target environment even after the package is updated. This property is applicable only if the Delete Web API is set to Yes and the Web API is modified.

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

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

    • Delete: Select this option to delete the Web API from the target environment when updating the package.

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

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

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

• Install to overwrite existing Web API: Select this option to overwrite the Web API that is present in the target environment with the one that 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: Use this property to decide if you want to retain or delete the Web API in the target environment even after the package is uninstalled.

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

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

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

  • Retain: Select this option to retain the Web API 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 after it was installed in the target environment will be reverted. However, the Web API will be retained in the target environment.

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

Associated Artifacts of Web API

Web API can have Web API Source as the associated artifact.

Child Artifacts of Web API

Web API does not have any child artifacts.

Security Artifacts of Web API

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