In this field... | Do the following... | ||
Name | Optional. Enter a name for the method. | ||
Description | Optional. Enter descriptive information about the method. | ||
HTTP Method | Choose the HTTP operation you want to perform on the resource. (The drop-down list will contain the list of supported HTTP methods.) | ||
Request Content-Type | Choose the content format for request message. (The drop-down list will contain the list of supported content formats.) If you want to specify multiple formats, use the plus button to add additional rows.
| ||
Response Content-Type | Choose the content format for response message. (The drop-down list will contain the list of supported content formats.) If you want to specify multiple formats, use the plus button to add additional rows.
| ||
Parameters - Add Parameter (link) | Optional. Specify one or more request parameters at the method level.
a. Click the Add Parameter link to open the Add Parameter dialog. b. In this dialog, you define input parameters at the method level. To specify multiple parameters, click on the Add Parameter link to add each new parameter. The new parameter is added to the method. For a complete description of how to set up the request parameters, see Adding a Parameter to the REST API. | ||
HTTP Status Codes - Add Status Code (link) | Optional. Define one or more HTTP response status codes that indicates the success or failure of an invocation. For a complete description of how to set up the status code, see Adding a Status Code to the RESTful
API. | ||
Sample Requests and Responses - Add Request and Response (link) | Optional. Write one or more sample requests to the resources of the REST API, and the corresponding sample responses from the API. For a complete description of how to expose the HTTP requests and response messages, see Adding a Request and Response Message
to the REST API. |