DriveWorks Pro 15: Send HTTP Request [send feedback...]

Send HTTP Request

The Send HTTP request Task, when applied, will send a REST request to a web service.

This task essentially:

  • Connects DriveWorks to the internet
  • Enables data to be shared with external services

Properties

Property NameDescription
Request Body (optional)The HTTP request body.
Request Body cannot be set with a GET or HEAD request; therefore anything entered in this field when these Verbs are set will be omitted from the request.
Request Headers (optional)A pipe delimited list of headers to be sent with the request.
  • Each key value pair should be separated with the pipe symbol ( | ) and each pair must separate the key and value with a colon character ( : )
  • For example, the string "content-type:text/xml | Accept:text/json" would represent 2 pairs, with the keys content-type and Accept
  • DriveWorks will automatically set the user agent (DriveWorks + Version Number) but this can be overridden with a user-specified value if required.
Request URLThe URL where the web request should be sent.
  • This should be set to the listening endpoint of the REST service. (e.g. https://maps.googleapis.com/maps/api/distancematrix/xml)
  • Some services may require query string parameters to be added to the URL (e.g.https://maps.googleapis.com/maps/api/distancematrix/xml?origins=Thelwall&destinations=Warrington)
Request VerbThe resource action to perform.

The task will accept any valid request verb; the most common being:

  • POST - mostly used to send data to an external service
  • GET - mostly used to read data from an external source
  • PUT - usually used for updating data
  • DELETE - as you would expect
Response Body Constant Name (optional)The name of the constant to drive the response body to.
When provided with the name of a constant, the task will drive the body of the response received from the REST service to it. This will enable users to process the response to retrieve requested data.
Response Header Constant Name (optional)The name of the constant to drive the response headers to.
When provided with the name of a constant, the task will drive the headers of the response received from the REST service to it. This will enable users to process the response to retrieve requested data.
TitleChanges the Title (not the name) of the task.

The following functions exist to help with the creation and processing of the HTTP Request.

DriveWorks Tech Tips Portal

Send HTTP Request

Look at how to request data from a web service using the HTTP Request task in DriveWorks. You can also look at how to retrieve data from the result using Xpath.

View all Tech Tips

DriveWorks Tech Tips Portal is available to DriveWorks Pro customers with an active subscription and support contract.

Tech Tips provide cut down projects that highlight specific functionality for faster and more effective learning.

To access the portal:

  1. Go to https://hub.driveworks.co.uk/tech-tips/
  2. Login with your DriveWorks Pro account credentials, if asked
  3. Click the Visit Tech Tips Portal button for access

The portal provides a search facility, start typing the name of the Tech Tip (as indicated above) to display the Tip you require.

Table of Contents