Software AG Products 10.7 | Using CentraSite | Asset Management | Managing Assets through CentraSite Business UI | REST Service Management | Modifying REST Service Details | Modifying Extended Details of REST Service
 
Modifying Extended Details of REST Service
You use the Resources and Methods profile of a REST Service to view, modify, and delete the extended REST components - Resources and Methods. CentraSite Business UI displays a list of the currently defined Resources, or Methods based on the Resource-Centric view or Method-Centric view that you select.
If you have multiple Resources and Methods defined for a REST Service, you would modify these Resources and Methods using the corresponding Edit icons in the Resources and Methods profile.
*To modify the details of resources and methods
1. In CentraSite Business UI, access the Advanced Search panel in one of the following ways:
*Click the Browse link in the upper-left corner of the menu bar.
*Click the Search icon next to the Scope list. The default search scope is Assets.
This displays a list of assets in the Search Results page.
2. In the Additional Search Criteria list, select Asset Types.
3. To search for the assets of type, REST Service, click Choose.
This opens the Choose Asset Types dialog box.
A list of scopes that are available to you is displayed. By default, CentraSite contains the following predefined scopes:
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.
4. In the Choose Asset Types dialog box, select the Assets option button, and follow these steps:
a. Click the chevron next to Assets option button.
A list of defined asset types in CentraSite is displayed.
b. In the list of asset types, select REST Service.
c. Click OK.
A list of defined REST Service assets is displayed in the Search Results page.
5. Click the REST Service you want to examine and modify the attributes.
This opens the REST Service details page. Also, the actions bar displays a set of actions that are available for working with the REST Service.
You can hover over the info symbol next to an attribute to display the tooltip text, which describes the purpose of the attribute. The tooltip text displays the values of the attribute's Name, and Description fields that are contained in the REST Service type definition.
6. To modify the REST Service details that are displayed in the Resource and Methods profile, on the actions bar, click Edit.
7. Select the Resource and Methods profile. Add or modify the REST information at the Resource level and at the Method level, as required.
*Resource level details include the basic information for a REST Resource, and its Request Parameters.
*Method level details include the basic information for a REST Method, its Request parameters, Content Types, Status Codes, Links, Callbacks, and HTTP Messages that are defined for the REST Method.
8. To modify the details of a REST Resource, follow these steps:
a. In the list of Resources, hover over the Resource for which you want to modify the attributes.
This displays icons for one or more actions that you can perform on the Resource.
b. Click the Edit icon.
This opens the Edit Resource dialog box
c. In the Edit Resource dialog box, provide the required information for each of the displayed data fields:
Field
Description
Resource 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.
Parameters
(Optional). Request Parameters for the REST Resource.
Modify an Existing Parameter
Note:
You cannot the modify parameters that are referred from Components.
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
Note:
When you delete parameters that are referred from Components, the parameters are deleted only from this resource and are present in the components.
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.
You can choose an existing parameter from Components.
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.
9. To modify the details of a REST Method, follow these steps:
a. In the list of Resources, expand a Resource to view the corresponding methods.
This displays one or more methods in the Resource.
b. Click the Edit icon.
This opens the Edit Method dialog box
c. In the Edit Method dialog box, provide the required information for each of the displayed data fields:
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
Note:
You cannot the modify parameters that are referred from Components.
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
Note:
When you delete parameters that are referred from Components, the parameters are deleted only from this resource and are present in the components.
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.
You can choose an existing parameter from Components.
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
Note:
You cannot the modify requests that are referred from Components.
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
Note:
When you delete requests that are referred from Components, the requests are deleted only from this resource and are present in the components.
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.
You can choose an existing request from Components.
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
Note:
You cannot the modify responses that are referred from Components.
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
Note:
When you delete responses that are referred from Components, the responses are deleted only from this resource and are present in the components.
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.
You can choose an existing response from Components.
To specify multiple responses, click the Add Response link, and provide values for the new responses.
c. Click OK.
d. Repeat for each Response that you want to add to the REST Method.
Callbacks
(Optional). Displays the Callbacks defined for the REST Method.
Modify an Existing Callbacks
Note:
You cannot the modify callbacks that are referred from Components.
a. In the list of Callbacks, hover over the Callback for which you want to modify the attributes.
This displays icons for one or more actions that you can perform on the Callback.
b. Click the Edit icon.
This opens the Edit Callback dialog box.
c. In the Edit Callback dialog box, provide new values for the fields.
d. Click OK.
e. Repeat for each Callback that you want to modify in the REST Method.
Delete an Existing Callback
Note:
When you delete callbacks that are referred from Components, the callbacks are deleted only from this resource and are present in the components.
a. In the list of Callbacks, hover over the Callback you want to delete.
This displays icons for one or more actions that you can perform on the Callback.
b. Click the Delete icon.
c. Repeat for each Callback that you want to delete from the REST Method.
Add a New Callback
a. Click the Add Callback link.
This opens the Add Callback dialog box.
b. In the Add Callback dialog box, provide values for the callback.
You can choose an existing callback from Components.
To specify multiple requests, click the Add Callback link, and provide values for the new requests.
c. Click OK.
d. Repeat for each Callback that you want to add to the REST Method.
10. Click Save.