Adding a REST API to CentraSite
Note: | Beginning with Version 9.7, CentraSite supports the ability to define APIs using the Business UI only. Please note that using the CentraSite Control interface to define REST APIs is no longer supported. |
Pre-requisites
To define a REST API in an organization, you must belong to a role that has the Create Assets or Manage Assets permission for that organization. For more information about roles and permissions, see Getting Started with CentraSite.
Perform these steps to create the simple REST API and save it to CentraSite.
To add a REST API
1. In the activity bar, click Create Asset. This opens the Create Asset wizard.
2. In the Basic Information profile, enter the following information in the fields provided:
In this field... | Do the following... |
Name | Mandatory. Enter a name for the new REST API. This name 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: . - _ (such as, 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 REST API name contains any non-conformant character, upon publishing the virtual copy of this REST API to any gateway, the non-conformant character is simply replaced with the underscore character (_) in Mediator. However, in CentraSite the REST API name defined by you is displayed. Note: | The API name does not need to be unique. However, to reduce ambiguity, we recommend that you adopt appropriate naming conventions to ensure that API is distinctly named within an organization. |
|
Type | The REST Service asset type. |
Organization | Select the organization in which the new API will be created. (The drop-down list displays the list of organizations in which you are permitted to create APIs.) |
Version | Optional. Specify a version identifier for the new API. |
Description | Optional. Enter a description for the new API. Note: | This is the description information that users will see when they view instances of this type in the user interface, therefore, the description should be meaningful. |
|
URL or File | Specify whether the input file will be read from your local file system (the File option) or from a URL-addressable location on the network (the URL option). If the file you are importing resides on the network, specify its URL. If the file resides in your local file system, specify the file name. You can use the Browse button to navigate to the required folder. |
3. Expand the Advanced Settings node. Enter the following information:
In this field... | Do the following... |
Credentials | If you have specified a URL and the site you want to access via the URL requires user authentication, enter a username and password for authentication at the URL site. |
Resolution | Choose a resolution strategy which will allow you to specify how an already existing imported/included file is handled. For each of the imported/included files you have one of these options: Overwrite the importing file with new content. Create a new version of the file with the new content (if, for example, you want to modify a XSD file but want to retain its previous version). |
4. Click Next.
Be aware that you will not be allowed to move to the next panel unless all of its required parameters have been set.
5. After you specify the value for all of the required fields, click the Save icon to save and add the new REST API to CentraSite registry.
The newly created API's details page is displayed. Here you can enter the values of various attributes of the new API.
6. Configure the API's extended attributes as described in the subsequent sections.
