Web Services › HTTP Operators: Common Output Parameters

HTTP Operators: Common Output Parameters

Output variables do not contain data when the operator does not receive an HTTP response due to an error such as the following:

• Input contains an unknown URL.
• The HTTP connection times out.
• The socket times out.

HTTPRequestUrl

Specifies the HTTP request URL, including any URL parameters.

HTTPResponseStatusLine

Specifies the status line of the HTTP response. The status line is the first line of the HTTP response message. The status line consists of the protocol version, the status code, and the associated reason phrase.

HTTPResponseStatusCode

Specifies the status code of the HTTP response. The operator fails or succeeds depending on this status code.

• The operator fails if the status code is greater than or equal to 300.
• The operator succeeds if the status code is less than 300.

HTTPResponseReasonPhrase

Specifies the reason phrase of the HTTP response.

HTTPResponseProtocolVersion

Specifies the protocol version of the HTTP response.

HTTPResponseContentType

Specifies the content-type header of the HTTP response content.

HTTPResponseContentCharset

Specifies the character encoding of the HTTP response content. This character encoding is part of the content-type header, and appears in the following form:

“content-type= xxxxx; charset=xxxx”

This charset is only set with an all character content-type such as text/xxx.

HTTPResponseContentLength

Specifies the number of bytes of the HTTP response content. A negative number means that the content length is not known.

HTTPResponseContentEncoding

Specifies the content-encoding header of the HTTP response content. Blank indicates that the content-encoding is unknown.

HTTPResponseContentIsChunked

True indicates that the HTTP response content was received with chunked encoding. False is returned if the True condition is not met.

HTTPResponseContentFilePath

Specifies the path to the file where the HTTP response content was saved. Blank indicates that the operator is not set up to save the HTTP response content (message body) to a file.

• If the input for If Response File exists? was 0 and the file path that was specified as input in HTTP Response Content File Path exists, then the HTTPResponseContentFilePath field contains the path to the new file where the HTTP response content was saved.
• If the input for If Response File exists? was 1 and the file path that was provided as input in HTTP Response Content File Path exists, then the HTTPResponseContentFilePath field contains the path provided in HTTP Response Content File Path.

HTTPResponseContent

Specifies the HTTP response content, up to the number of bytes entered in HTTP Response Dataset Variable Size Limit (bytes) field. Blank can indicate that the operator is not set up to save the HTTP response content (message body) to its dataset. Blank also can indicate that the HTTP response content is empty.

HTTPResponseHtmlContent

Specifies the HTTP response content rendered as HTML in the dataset of the operator. The content-type header starting with "text/html" indicates that the HTTP response content is HTML. When CA Process Automation detects that the HTTP response content is HTML, the HTTP response content is rendered as HTML in the dataset of the operator. The raw data remains accessible for javascript code in HTTPResponseContent. Blank can indicate that the operator is not set up to save the HTTP response content (message body) to a dataset. Blank can also mean that CA Process Automation detects that the HTTP response content is not HTML or that the HTTP response content is empty.

Note: CA Process Automation renders only basic HTML pages. CA Process Automation does not render complex HTML pages.

HTTPResponseHeaders

Specifies the HTTP headers of the HTTP response. The headers are returned as an indexed ValueMap where each ValueMap contains a single header and the following two parameters:

Key

Specifies the name of the HTTP header.

Value

Specifies the value of the HTTP header.

HTTPRequestHeaders

Specifies the HTTP headers of the HTTP request that was sent. This field contains the HTTP headers that were provided as input in the HTTP Headers or HTTP Headers ValueMap fields of the operator. This field also contains the HTTP headers for authentication, proxy, and others that the operator added before sending the request.

The headers are returned as an indexed ValueMap where each ValueMap contains a single header and the following parameters:

Key

Specifies the name of the HTTP header.

Value

Specifies the value of the HTTP header.

HTTPRequestLine

Specifies the request line of the HTTP request that was sent. The HTTP request line contains the HTTP method, the URL, and the HTTP version.

HTTPCookiesStore

Specifies the parsed version of the HTTP cookies sent in the request and the HTTP cookies embedded in the response headers. The cookies are returned as an indexed ValueMap where each ValueMap contains a single cookie that was defined with the following parameters:

Name

Specifies the name of this HTTP cookie.

Value

Specifies the value of this HTTP cookie.

Version

Specifies the version of the cookie specification that this HTTP cookie conforms to.

Domain

Specifies the domain of this HTTP cookie. The HTTP cookie is valid in this Domain.

Path

Specifies the path of this HTTP cookie. This value specifies the subset of URLs, for which this HTTP cookie applies, on the original HTTP server.

ExpirationDate

Specifies the expiration date of this HTTP cookie. Some cookies return an expiration date, while others return a maximum age. The expiration date is returned in the following format:

"yyyy.MM.dd 'at' HH:mm:ss z"

MaxAge

Specifies the maximum age of this HTTP cookie. Some cookies return a maximum age, while others return an expiration date.

Comment

Specifies the purpose of this HTTP cookie.

Ports

Specifies the ports of this HTTP cookie. The ports are returned as a string of comma-separated values. This value specifies the ports on which this HTTP cookie can be sent back in a request header.

IsSecure

One of the following options:

• True - Indicates that this HTTP cookie can be sent only on a secure connection.
• False - Indicates that a secure connection is not necessary for sending this cookie.

ResponseHeaderName

Specifies the name of the response header that contains this HTTP cookie. This value can be “Set-Cookie” or “Set-Cookie2”.

Result

This value is one of the following options:

1

Indicates that the operator finished successfully.

-1

Indicates that the operator failed.

Reason

This value is one of the following options:

Completed

This reason is associated with the result of 1, successful completion.

<error message>

An explanation of why the error occurred; associated with the result of -1, where the operator failed.