Web Service Input/Output

Web Service Input

The Web Service Input tool is the request endpoint for a published web service. It has no configurable properties that affect the execution of the project. However, it does include a Testing tab where you can simulate a web service request by manually defining request elements.

See the projects in the repository folder Samples\Web Services\ for usage examples.

Web Service Input tool configuration parameters

The Web Service Input tool has no configuration parameters that affect project execution. However, you can configure properties on the Testing tab to simulate a web service request.

Property	Description
HTTP method	Action to perform on the specified web service URL: GET: (default) issues a GET command, corresponding to a "Read" operation. No body is sent, and it is assumed that all parameters are encoded in the URL. It is idempotent, which means that making multiple identical requests has the same result as a single request. POST: issues a POST command, corresponding to a "Create" operation. A body is sent, and the Content-Length header is set. It is non-idempotent; if you execute it multiple times, the server state will change every time. Making two identical POST requests will likely result in two resources containing the same information. PUT: issues a PUT command, corresponding to an "Update/Replace" operation. Sends data to a known resource URI with the request body containing the newly-updated representation of the original resource. It is idempotent and will result in the same server state no matter how many times you execute it. PATCH: issues a PATCH command, corresponding to an "Update/Modify" operation. This is like PUT, but need only contain the changes to the resource, not the complete resource. For example, to change only a couple of columns in a record stored at a specific URI on a server, you could use the PATCH method. Like PUT, it is idempotent.
URL	URL of the web service.
Request body	For POST, PUT, and PATCH methods, the data body immediately following the Request header.
Request headers	(Optional) Headers that are sent with every request. Name may Cookie or Content-type. Value is the literal string associated with Name.

Configure the Web Service Input tool

The Web Service Input tool has no configuration parameters that affect project execution. However, you can configure properties on the Testing tab to simulate a web service request. See the projects in the repository folder Samples\Web Services\ for usage examples.

To configure a Web Service Input tool for testing:

Select the Web Service Input tool.
Go to the Testing tab.
Select HTTP method and choose the desired action: GET, POST, PUT, or PATCH.
Select URL and specify the URL of the target web service.
If you selected a POST, PUT, or PATCH method, enter the Request body.
Optionally, select Name in the Request headers grid, and define Value for Cookie and/or Content-Type.
Optionally, go to the Execution tab, and then set Web service options.

Web Service Output

The Web Service Output tool is the request outpoint for a published web service. See the projects in the repository folder Samples\Web Services\ for usage examples.

Web Service Output tool configuration parameters

The Web Service Output tool has one set of configuration parameters in addition to the standard execution options.

Parameter	Description
Body field	Field to receive the response body.
Enable header input	If selected, enables writing of headers from a separate Header (H) input connection. You must select Commit to display the (H) connector.
Header name field	If Enable header input is selected, the name of the field on the Header (H) input containing the header name. Header names may be duplicated. The header name Content-Length is ignored.
Header value field	If Enable header input is selected, the name of the field on the Header (H) input containing the header value.
Constant and output headers	If defined, headers that are included with every response. Name may be Cookie or Content-Type. Value is the literal string associated with Name. Field is the field from which the Name value will be read at response time. You can define a Value or select a Field, but not both.

Configure the Web Service Output tool

Select the Web Service Output tool.
Go to the Configuration tab.
Select Body field and choose the field to receive the response body.
Optionally, select Enable header input to enable writing of headers from a separate Header (H) input connection. You must select Commit to display the (H) connector.
If you selected Enable header input, select Header name field and Header value field, and choose the fields containing header names and header values.
Optionally, select Name in the Constant and output headers grid, and define Cookie and/or Content-Type. You may define Value or select a Field but not both.
Optionally, set Report options on the Execution tab.