Important: | During virtualization of a REST Service, CentraSite does not support the following HTTP methods: HEAD, OPTIONS, TRACE, and CONNECT. This is because, when a Virtual REST Service is published to Mediator gateway, CentraSite only supports the HTTP methods: GET, POST, PUT, PATCH, and DELETE, at run-time. |
Resource URI | Supported HTTP Methods | Description |
/phones | GET | List all phones. |
/phones | POST | Creates a new phone with product code 412456. |
/phones/412456 | GET | Retrieves details of a phone whose product code is 412456. |
/phones/412456 | DELETE | Removes a phone whose product code is 412456. |
/phones/412456?fields=(make,features, bodytype) | GET | Retrieves additional details (such as Brand, Features, Body Type) of a phone whose product code is 412456. |
/phones/412456/make | GET | Identifies the brand of a phone whose product code is 412456. |
/phones/search?q=(make,eq,apple) | GET | Retrieves a list of all phones whose brand is Apple. |
/phones/412456?make=apple&features=3g | PUT | Updates a phone whose product code is 412456, brand is Apple, and also 3G compatible. |
Field | Description | ||
Name | Name of the REST (HTTP) Method. | ||
Description | (Optional). The description for the REST Method. | ||
HTTP Method | The HTTP operation you want to perform on the REST Resource. (The HTTP Method list displays a list of the supported HTTP Methods.) | ||
Request Content-Type | The content format for HTTP 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 HTTP Response message. (The Response Content-Type displays a list of the supported content formats for the REST Service.) By default, this field shows an empty value. | ||
Deprecated | (Optional). Specify if the REST Method is deprecated. | ||
Parameters - Add Parameter (link) | (Optional). Request Parameters for the REST Method. The supported parameters types are: Query-String Header Form Although CentraSite allows you to define parameters of the type, Form, at the Resource level, these parameters are not supported at run-time. Only parameters of the type - Query-String, and Header, are supported at run-time.
a. Click the Add Parameter link. This opens the Add Parameter dialog box. b. In the Add Parameter dialog box, provide values for the REST Parameter. c. Click OK. The newly created parameter is added to the REST Method. 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. To specify multiple parameters, click the Add Parameter link, and provide values for the new parameters. | ||
Requests - Add Request (link) | (Optional). The HTTP requests to the Resources of the REST Service. | ||
Responses - Add Response (link) | (Optional). The HTTP responses to the Resources of the REST Service. | ||
Sample Requests and Responses - Add Request and Response (link) | (Optional). The sample requests to the Resources of the REST Service, and the corresponding sample responses from the Resources of the REST Service. |