Adding Virtual REST Service from Scratch
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 add a Virtual REST Service asset to the catalog, you must have the RAML or Swagger specification file that you want to import. This file can reside on the file system of the computer where your browser is running or it can reside anywhere on the network, as long as its location is addressable through a URL.
To add a Virtual REST Service from scratch
1. In the CentraSite Business UI activity bar, click Create Asset.
This opens the Create New Asset wizard.
2. In the area labeled Basic Information, provide the required information for each of the displayed data fields:
In this field... | Do the following... |
Name | (Optional). Name of the Virtual REST Service asset. The name of a Virtual REST Service asset must be NCName-conformant, meaning that:  The name must begin with a letter or the underscore character (_). The remainder of the name can contain any combination of letters, digits, or the following characters: . - _ (that is, period, dash, or underscore). It can also contain combining characters and extender characters (for example, diacriticals). The name cannot contain any spaces. Furthermore, if the Virtual REST Service name contains any non-conformant character, upon publishing the Virtual REST Service to any gateway, the non-conformant character is simply replaced with the underscore character (_) in Mediator. However, in CentraSite the Virtual REST Service name defined by you is displayed. Note: | The name of a Virtual REST Service asset must be unique within an organization. If, for example, a Virtual REST Service with the same name already exists within the CentraSite registry, a warning message will be issued. |
By default, CentraSite populates the Create a New Virtual Alias field with the display name that was specified for the Native REST Service. |
Type | The asset type, Virtual REST Service. |
Organization | The organization to which you want to add the Virtual REST Service. (The Organization list only displays organizations for which you have the Manage Assets permission or at least the Create Assets permission.) |
Version | (Optional). The version identifier for the Virtual REST Service. You can enter any string in this field, that is, the version identifier does not need to be numeric. You can also leave the field blank. You can later create new versions of the Virtual REST Service. The default is 1.0. Examples: 0.0a
1.0.0 (beta)
Pre-release 001
V1-2007.04.30 |
Description | (Optional). The description for the Virtual REST Service. Note: | This is the description information that users will see when they view this Virtual REST Service asset in the CentraSite user interfaces. Therefore, we recommend that you specify a meaningful description for each Virtual REST Service. |
|
Import a File | The input RAML or Swagger file for the Virtual REST Service. You may want to read the input RAML or Swagger file from a URL-addressable location on the network (the URL option) or from your local file system (the File option). |
Option | Description |
URL | If the RAML or Swagger file you are importing resides on the network, you can specify its URL. |
File | If the specification resides in your local file system, specify the file name. You can use the Browse button to navigate to the required folder. |
3. Click the Advanced Settings chevron to expand the additional options that are available for the Virtual REST Service asset. Provide the required information for each of the displayed fields:
Field | Description |
Credentials | If you have specified a URL and the site you want to access through the URL requires user authentication, type a username and password for authentication at the URL site. |
Resolution | Select a resolution strategy, which will allow you to specify how an already existing imported and included file is handled. For each of the imported and included files you have one of these options: Create new version: Creates a new version of the file with the new content (if, for example, you want to modify a RAML or Swagger file but want to retain its previous version). Always overwrite: Overwrites the importing file with new content. Note: | Currently, CentraSite does not support this option for a REST Service with RAML or Swagger specification. |
|
4. Click Next.
You can not navigate to the next screen unless all the required attributes have been set.
5. In the Preview panel, review the basic information for the Virtual REST Service before you actually add to the CentraSite registry.
6. Click Save.
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.
7. Configure the extended attributes of the Virtual REST Service asset as described later in this topic.
