Adding Virtual REST Service using an Archive
Pre-requisites:
To add a Virtual REST Service asset to an organization's asset catalog, you must belong to a role that has the Create Assets or Manage Assets permission for that organization.
Note:
By default, users with the CentraSite Administrator or Asset Administrator role have this permission.
Before you import a Virtual REST Service asset to the catalog, you must have the archive file (.zip file). This file must reside on the file system of the computer where your browser is running.
You can import a Virtual REST Service using the archive file (.zip file) to which the Virtual REST Service was previously exported. You can import Virtual REST Services into the same CentraSite registry from which they were originally exported or to a different CentraSite registry.
To add a Virtual REST Service asset using importer
1. In the CentraSite Business UI activity bar, click Create Asset.
This opens the Create New Asset wizard. The bottom panel of the Create New Asset wizard displays the option to import an archive file.
2. To import an archive file, click Choose to navigate to the folder where an exported archive file of the Virtual REST Service asset resides, and choose the file.
When you choose a file to import, the fields in the area labeled Basic Information cannot be edited.
3. Click Next.
The Create New Asset wizard displays a list of the referenced objects for the Virtual REST Service to import. The check box next to each object indicates whether the referenced object should be imported. By default, all objects displayed are included in the import set.
4. To exclude any referenced object from the import set, clear the corresponding check box.
5. Click the Advanced Settings chevron to expand the additional options that are available for the Virtual REST Service asset. Provide values for each of the displayed options:
Option | Description |
Change Owner | The imported Virtual REST Service can be assigned to the same owner as in the source CentraSite registry, or you can assign a new owner. The Change Owner field is type-ahead field. As you type characters in this field, the dialog box lists the user names that match the characters you specify. |
Change Organization | When you import a Virtual REST Service, you can import it into the same organization in the target CentraSite registry as in the source CentraSite registry from which they were exported, or you can assign a new organization. The Change Organization field is type-ahead field. As you type characters in this field, the dialog box lists the organization names that match the characters you specify. |
Retain lifecycle state | This option determines whether the lifecycle state of the imported Virtual REST Service is preserved. Enable the option to retain the lifecycle state of the Virtual REST Service which is imported. |
Overwrite existing entities | This option specifies that an existing Virtual REST Service with the same uuid in the target CentraSite registry will be overwritten, even if the Virtual REST Service in the archive is older than the one in the target CentraSite registry. Enable the option to overwrite the existing Virtual REST Service. |
Import groups that the user belongs to | This option determines that when you import a user, whether you want to import the groups that the user belongs to. This applies only to user-defined groups. System-defined groups are not imported. Enable the option to import the groups. |
Ignore API keys and OAuth2 tokens | This option determines whether the API keys and OAuth2 tokens of the imported assets are to be imported into the target CentraSite registry. Enable the option to ignore the API keys and OAuth2 tokens during the import process. |
6. Click Import to import the Virtual REST Service.
After the import operation completes, the import wizard informs you if the import was successful or if there were any errors and warnings.
7. Click Download Import Log to view the import logs.
The import log lists the status of all the objects stating whether they were successfully imported or if there were errors and warnings.
8. Click OK to terminate the import wizard.
A Virtual REST Service asset instance is created in the specified organization and registered with the CentraSite registry/repository. The details page for the Virtual REST Service asset that you just created is displayed.
9. Configure the extended attributes of the Virtual REST Service asset as described later in this topic.
Tip:
If you had previously imported a RAML/Swagger file that has an associated schema file and you now re-import just the schema file with modifications, your browser might not display the updated contents of the schema file. This can happen if the browser cache is not being updated automatically. To rectify the problem, you can change your browser settings so that pages are always updated on every visit.