Scope | Description |
Everything | Displays a list of the currently available assets, organizations, and users in CentraSite registry. |
Assets | Displays a list of the currently available assets in CentraSite registry. This is the default scope. |
Field | Description |
Name | Name of the REST Resource. Make sure the name you specify in this field is a valid value for NCName. |
Resource Path | The Resource URI. |
Description | (Optional). The description for the REST Resource. |
Upload Schema | (Optional). The XML Schema Definition (XSD) file for the REST Resource. Note: If you have a REST Service that uses XML as content, then you can optionally upload an XML schema document. |
Upload Files | (Optional). Input files that provide additional information about the REST Resource. |
Parameters | (Optional). Request Parameters for the REST Resource. Modify an Existing Parameter a. In the list of Parameters, hover over the Parameter for which you want to modify the attributes. This displays icons for one or more actions that you can perform on the Parameter. b. Click the Edit icon. This opens the Edit Parameter dialog box. c. In the Edit Parameter dialog box, provide new values for the fields. d. Click OK. e. Repeat for each Parameter that you want to modify in the REST Resource. Delete an Existing Parameter a. In the list of Parameters, hover over the Parameter you want to delete. This displays icons for one or more actions that you can perform on the Parameter. b. Click the Delete icon. c. Repeat for each Parameter that you want to delete from the REST Resource. Add a New Parameter 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. To specify multiple parameters, click the Add Parameter link, and provide values for the new parameters. c. Click OK. d. Repeat for each Parameter that you want to add to the REST Resource. |
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. |
Request Content-Type | The content format for HTTP Request message. |
Response Content-Type | The content format for HTTP Response message. |
Parameters | (Optional). Request Parameters for the REST Method. Modify an Existing Parameter a. In the list of Parameters, hover over the Parameter for which you want to modify the attributes. This displays icons for one or more actions that you can perform on the Parameter. b. Click the Edit icon. This opens the Edit Parameter dialog box. c. In the Edit Parameter dialog box, provide new values for the fields. d. Click OK. e. Repeat for each Parameter that you want to modify in the REST Method. Delete an Existing Parameter a. In the list of Parameters, hover over the Parameter you want to delete. This displays icons for one or more actions that you can perform on the Parameter. b. Click the Delete icon. c. Repeat for each Parameter that you want to delete from the REST Method. Add a New Parameter 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. To specify multiple parameters, click the Add Parameter link, and provide values for the new parameters. c. Click OK. d. Repeat for each Parameter that you want to add to the REST Method. |
Requests | (Optional). HTTP Requests indicating the operation that could be performed with the addressed REST Resource. Modify an Existing Request a. In the list of HTTP Requests, hover over the Request for which you want to modify the attributes. This displays icons for one or more actions that you can perform on the Request. b. Click the Edit icon. This opens the Edit Request dialog box. c. In the Edit Request dialog box, provide new values for the fields. d. Click OK. e. Repeat for each Request that you want to modify in the REST Method. Delete an Existing Request a. In the list of HTTP Requests, hover over the Request you want to delete. This displays icons for one or more actions that you can perform on the Request. b. Click the Delete icon. c. Repeat for each Request that you want to delete from the REST Method. Add a New Request a. Click the Add Request link. This opens the Add Request dialog box. b. In the Add Request dialog box, provide values for the HTTP Request. To specify multiple requests, click the Add Request link, and provide values for the new requests. c. Click OK. d. Repeat for each Request that you want to add to the REST Method. |
Responses | (Optional). HTTP Responses indicating the success or failure of a request invocation. Modify an Existing Response a. In the list of HTTP Responses, hover over the Response for which you want to modify the attributes. This displays icons for one or more actions that you can perform on the Response. b. Click the Edit icon. This opens the Edit Response dialog box. c. In the Edit Response dialog box, provide new values for the fields. d. Click OK. e. Repeat for each Response that you want to modify in the REST Method. Delete an Existing Request a. In the list of HTTP Responses, hover over the Response you want to delete. This displays icons for one or more actions that you can perform on the Response. b. Click the Delete icon. c. Repeat for each Response that you want to delete from the REST Method. Add a New Response a. Click the Add Response link. This opens the Add Response dialog box. b. In the Add Response dialog box, provide values for the HTTP Response. To specify multiple requests, click the Add Response link, and provide values for the new requests. c. Click OK. d. Repeat for each Response that you want to add to the REST Method. |
Sample Requests and Responses | (Optional). Sample Requests to the Resources of the REST Service, and the corresponding Sample Responses from the REST Service. Modify an Existing Sample a. In the list of Sample Requests and Responses, hover over the Sample for which you want to modify the attributes. This displays icons for one or more actions that you can perform on the Sample. b. Click the Edit icon. This opens the Edit Sample Request and Response dialog box. c. In the Edit Sample Request and Response dialog box, provide new values for the fields. d. Click OK. e. Repeat for each Sample that you want to modify in the REST Method. Delete an Existing Sample a. In the list of Sample Requests and Responses, hover over the Sample you want to delete. This displays icons for one or more actions that you can perform on the Sample. b. Click the Delete icon. c. Repeat for each Sample that you want to delete from the REST Method. Add a New Sample a. Click the Add Request and Response link. This opens the Add Sample Request and Response dialog box. b. In the Add Sample Request and Response dialog box, provide values for the Sample. To specify multiple samples, click the Add Response link, and provide values for the new samples. c. Click OK. d. Repeat for each Sample that you want to add to the REST Method. |