CentraSite Documentation : Working with REST-based APIs : Modeling a RESTful API : Configuring the Global Details of a REST API : Adding a Base URL to the REST API
Adding a Base URL to the REST API
Configure the base URLs for the API using which users would traverse to any of the API's resources. In order to execute this task, you must know the URL of the server that is hosting the API you intend to model.
To add a base URL
1. Display the details page for the REST API that you want to configure. If you need procedures for this step, see Viewing the Details of a REST API.
2. In the actions bar for the API, click Edit  icon.
3. Navigate to Advanced Information > Technical Details profile.
4. Enter the following information in the fields provided:
In this field...
Do the following...
Base URL
Optional. Enter the server base URL in the text box.
Note:  
If you are specifying multiple base URLs for an API, it must be unique among all URLs in the API.
If you want to specify additional base URLs, use the plus button beside the text box to create a new base URL input field, and enter another URL.
If at any time you want to remove a base URL, use the minus button.
Sandbox
Optional. The sandbox category by which you want to classify base URL for the API.
a. Click Choose.
b. When you click the button, the Choose Sandbox Categories dialog appears which allows you to select the required categories for base URL.
c. Click the expand node next to Sandbox taxonomy to view the categorization tree.
d. Mark the checkbox beside the name of the category to classify the base URL.
e. Click OK.
CentraSite includes a set of predefined categories for the taxonomy node "Sandbox", especially for classifying base URLs of REST APIs. By default, the base URLs can be classified into these following predefined categories: Development, Production, Test.
For information on the Sandbox categories that CentraSite supports out-of-the-box, in CentraSite Control, go to Administration > Taxonomies. On the Taxonomies page, navigate to Sandbox in the list of taxonomies.
If you would like to use sandbox categories that are not supported by CentraSite, you can define your custom categories.
Note:  
Although it is possible to define subcategories for the predefined and custom categories within the Sandbox taxonomy, you cannot use these subcategories to classify the base URLs. CentraSite only displays the names of the top-level categories (that is, categories that are defined for the Sandbox taxonomy) for the classification.
Namespace
Optional. Specify the target namespace.
Parameters - Add Parameter
Optional. Specify one or more request parameters at the API level.
Note:  
You cannot add more than one parameter with the same name and the same type within the API level.
a. Click the Add Parameter link to open the Add Parameter dialog.
b. In this dialog, you define input parameters at the API level. To specify multiple parameters, click on the Add Parameter link to add each new parameter.
The new parameter is added to the Technical Details profile. For a complete description of how to add the request parameters, see Adding a Parameter to the REST API.
5. Depending on the requirements, you can specify the path parameters, query parameters, and header parameters.
6. To further update the new parameter, click Edit .
7. To specify multiple parameters, click the Add Parameter link to add each new parameter.
8. After you specify the value for all of the required fields, click Save  to save the API.
Copyright © Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback