Manage Web Service Sample Payloads

This example demonstrates how to add and edit a sample payload XML for a web service operation. It also describes how to delete a user-defined sample payload XML.

Adding a Sample Payload XML

Follow these steps to add a sample payload XML for the getEntityList operation of Help Topic Abstract Service:

1. From the Navigator menu, select Tools > Developer Connect.

2. On the Web Service overview page, search for Help Topic Abstract Service, and click the service display name.

3. On the Summary page, click the Sample Payloads tab, and then click Add Sample Payload.

4. Select getEntityList operation from the list, and enter a brief description.

5. Enter the payload XML, and click OK.

Editing a Sample Payload XML

The Developer Connect portal displays predefined and user-defined payloads of the web services. You can edit only the user-defined payloads. Follow these steps to edit a user-defined sample payload of the getEntityList operation of Help Topic Abstract Service:

1. On the Web Service overview page, select Help Topic Abstract Service.

2. On the Summary page of the web service, click the Sample Payloads tab and select getEntityList operation.

3. In the Edit Sample Payload dialog box, edit the payload XML and click OK.

Deleting a Sample Payload XML

You can delete only user-defined payloads, and not predefined payloads. Follow these steps to delete a user-defined sample payload of the getEntityList operation of Help Topic Abstract Service:

1. On the Web Service overview page, select Help Topic Abstract Service.

2. On the Summary page of the web service, click the Sample Payloads tab and select getEntityList operation.

3. Click the delete icon for the selected operation and click OK.