HTTPRequest
HTTPRequest
HTTPRequest allows CDP to make network requests using HTTP (Hypertext Transfer Protocol) or HTTPS (HTTP + TLS security) protocol.
HTTP is also the base protocol for REST (Representational state transfer) requests. Therefore, HTTPRequest is the element to use when CDP needs to interact with REST services.
HTTPRequest shares common properties with other URLRequests, but has also the following specific configuration properties:
| Property | Description |
|---|---|
| URL<string> | Remote URL to send HTTP request to. Can be prefixed by HTTP protocol schemes (http:// or https://). If not prefixed, http:// is prefixed automatically. Note: URL property will be processed by FormatTranslator before send, so you can use any request channel value in there (can be useful for sending channel values as URL parameter). |
| Method | HTTP method to use for request. Typically choose POST for sending composing and sending request channels into server or GET for retrieving some information into response channels. For REST requests, some other methods like PUT, DELETE or PATCH can be chosen. |
| AuthMethod | Force use of specific HTTP authentication method. Authentication method is negotiated with server and used to send user name and password (specified via UserPwd property) to server. Can be one of the following:
|
| Proxy<string> | Proxy server to be used for request e.g. http://proxyserver:8080/. Useful in some network setups that require a proxy to be used in order to reach the Internet or special network segment the URL is located in. |
| ProxyUserPwd<string> | Login details for password protected proxy servers. String in format [user name]:[password]. |
| ProxyAuthMethod | Force use of specific proxy authentication method. Authentication method is negotiated with proxy server and used to send user name and password (specified via ProxyUserPwd property) to proxy server. Can be one of the following:
|
| UserAgent<string> | User-Agent is a HTTP header to send with request. User-Agent is meant to inform the server which application is accessing it. Sometimes servers will look at this header and determine how to act based on its contents. By default no user-agent header is sent. |
| AdditionalHttpHeaders<string> | Additional HTTP header to send with request. Sometimes remote servers check for some specific header to be present, for example REST access key. Note: You can specify multiple header lines by separating them with C-style newline marker (\n). Note: This property will be processed by FormatTranslator before send, so you can send any request channel value in there (e.g. useful for sending access keys retrieved by another preceding request). |
| Cookie<string> | HTTP cookies to send with request. Sometimes remote servers check for some specific cookies to be present, for example REST access key. Note: Cookies are name and value pairs in format Name=Value. You can specify multiple cookies with this property by separating them with semicolon (;). Note: This property will be processed by FormatTranslator before send, so you can send any request channel value in there (e.g. useful for sending access keys retrieved by another preceding request). |
| CookieFile<string> | File name to read HTTP cookies from to send with request. The cookie data can be in either the old Netscape / Mozilla cookie file format or just Set-Cookie: Name=Value header lines in a file. |
| FollowLocation<bool> | If set to true follow (re-request) to any new URL that is pointed in request response with HTTP 3xx status code and Location header. Default is not to follow. |
See also shared common properties with other Requests (including the properties controlling what events cause the HTTPRequest to be sent).
See also shared common properties with other URLRequests (including request encryption settings).
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.