Field | Description | ||
Name | Mandatory. The name of the resource. | ||
Resource Path | Mandatory. The resource URL. | ||
Description | Optional. Additional comments or descriptive information about the resource. | ||
Schema | Optional. The XML Schema Definition (XSD) file for selected API.
| ||
Documents | Optional. External documents that provide additional information about the resource. | ||
Parameters | Optional. One or more request parameters at the resource level. Modify an Existing Parameter i. Mouse hover the parameter name, and click Edit . ii. In the Edit Parameter dialog, modify the details, as needed. iii. Click OK. iv. Repeat for each parameter that you want to modify. Delete an Existing Parameter i. Mouse hover the parameter name, and click Delete . ii. Repeat for each parameter that you want to delete. Add a New Parameter i. Click the Add Parameter link. ii. In the Add Parameter dialog, specify the details, as needed. iii. Click OK. iv. Repeat for each parameter that you want to add. For a complete description of how to set up the request parameters, see Configuring REST Parameters. |
Field | Description |
Name | Mandatory. The name of the method. |
Description | Optional. Additional comments or descriptive information about the method. |
HTTP Method | The HTTP operation to perform on the resource. |
Request Content-Type | The content format for request message. |
Response Content-Type | The content format for response message. |
Parameters | Optional. One or more request parameters at the method level. Modify an Existing Parameter i. Mouse hover the parameter name, and click Edit . ii. In the Edit Parameter dialog, modify the details, as needed. iii. Click OK. iv. Repeat for each parameter that you want to modify. Delete an Existing Parameter i. Mouse hover the parameter name, and click Delete . ii. Repeat for each parameter that you want to delete. Add a New Parameter i. Click the Add Parameter link. ii. In the Add Parameter dialog, specify the details, as needed. iii. Click OK. iv. Repeat for each parameter that you want to add. For a complete description of how to set up the request parameters, see Configuring REST Parameters. |
HTTP Status Codes | Optional. One or more HTTP response status codes that indicate the success or failures of an invocation. Modify an Existing Status Code i. Mouse hover the status code row, and click Edit . ii. In the Edit Status Code dialog, modify the details, as needed. iii. Click OK. iv. Repeat for each status code that you want to modify. Delete an Existing Status Code i. Mouse hover the status code row, and click Delete . ii. Repeat for each status code that you want to delete. Add a New Status Code i. Click the Add Status Code link. ii. In the Add Status Code dialog, specify the details, as needed. iii. Click OK. iv. Repeat for each status code that you want to add. For a complete description of how to set up the status code, see Configuring HTTP Status Codes. |
Sample Requests and Responses | Optional. One or more sample requests to the resources of the web application, and the corresponding sample responses from the application. Modify an Existing Sample i. Mouse hover the sample row, and click Edit . ii. In the Edit Sample Request and Response dialog, modify the details, as needed. iii. Click OK. iv. Repeat for each sample that you want to modify. Delete an Existing Sample i. Mouse hover the sample row, and click Delete . ii. Repeat for each sample that you want to delete. Add a New Sample i. Click the Add Request and Response link. ii. In the Add Sample Request and Response dialog, specify the details, as needed. iii. Click OK. iv. Repeat for each sample that you want to add. For a complete description of how to expose request headers and response messages, see Configuring Sample Request and Response
Messages. |