Field | Description |
Server URL | The server URL for the REST Service. Note: If you are specifying multiple endpoints for a REST Service, it must be unique among all URLs in the REST Service. |
Description | (Optional) Description of the endpoint. |
Sandbox | (Optional). The sandbox category using which you want to classify endpoints for the REST Service. a. Click Choose. A list of defined sandbox categories is displayed in the Choose dialog box. b. Click the chevron next to a Sandbox taxonomy to expand the categorization tree. c. Select the check box of the category you want to use for classifying the endpoint. d. Click OK. CentraSite includes a set of predefined categories for the taxonomy node Sandbox, especially for classifying endpoints of REST Services. By default, the endpoints can be classified into the 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. In the Taxonomies page, navigate to Sandbox in the list of taxonomies. If you want 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 endpoints. CentraSite only displays the names of the top-level categories (that is, categories that are defined for the Sandbox taxonomy) for the classification. |
Add Parameter - Add Variable (link) | A variable is part of a Server URL. The possible and default value provided to the variable, form valid endpoints for accessing an API. Click Add Variable and provide the following information: a. Name: Name of the parameter. b. Description: Description of the parameter. c. Possible Values: Possible values of the parameter. To specify additional possible values, use the plus button (+) next to the textbox to create a new possible values input field, and type another value. To remove a possible value, use the minus button (-). d. Default Value: (Mandatory) Default value of the parameter. If you have defined possible values, then default value should be one of the defined possible values. |
Field | Description |
Namespace | The namespace for request or response message. |
Request Content-Type | The content format for request message. (The Request Content-Type displays a list of the supported content formats for the REST Service.) By default, this field shows an empty value. |
Response Content-Type | The content format for response message. (The Response Content-Type list displays a list of the supported content formats for the REST Service.) By default, this field shows an empty value. |
API Parameters - Add Parameter | (Optional). One or multiple request parameters at the REST Service (API) level. The supported parameters types are: Query-String Header Form Although CentraSite allows you to define parameters of the type, Form, at the REST Service level, these parameters are not supported at run-time. Only parameters of the type - Query-String and Header, are supported at run-time. Note: You cannot add more than one parameter with the same name and the same type at the REST Service level. a. Click the Add Parameter link. This opens the Add Parameter dialog box. b. In the Add Parameter dialog box, specify an input parameter for the REST Service. To specify multiple parameters, click the Add Parameter link to add each new parameter. The newly created parameter is added to the Technical Details profile. To further update the new parameter, hover over the required parameter, and click the Edit icon. Repeat for each parameter for which you want to modify the details. |