<?xml version="1.0" encoding="UTF-8"?>
<keywordspec format="ROBOT" type="LIBRARY" generated="2022-01-09T15:05:20Z" scope="GLOBAL" name="HttpRequestLibrary" specversion="3">
<version/>
<doc>``HttpRequestLibrary`` is a [http://code.google.com/p/robotframework/|Robot Framework] test library that uses the [https://hc.apache.org/index.html|Apache HTTP client].</doc>
<tags>
</tags>
<inits>
</inits>
<keywords>
<kw name="Create Digest Session">
<arguments repr="alias, url, headers=, cookies=, auth=, timeout=0, proxy=, verify=False, debug=False">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="url" kind="POSITIONAL_OR_NAMED" required="true">
<name>url</name>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="cookies=" kind="POSITIONAL_OR_NAMED" required="false">
<name>cookies</name>
<default/>
</arg>
<arg repr="auth=" kind="POSITIONAL_OR_NAMED" required="false">
<name>auth</name>
<default/>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
<arg repr="proxy=" kind="POSITIONAL_OR_NAMED" required="false">
<name>proxy</name>
<default/>
</arg>
<arg repr="verify=False" kind="POSITIONAL_OR_NAMED" required="false">
<name>verify</name>
<default>False</default>
</arg>
<arg repr="debug=False" kind="POSITIONAL_OR_NAMED" required="false">
<name>debug</name>
<default>False</default>
</arg>
</arguments>
<doc>Create a HTTP session to a server

``url`` Base url of the server

``alias`` Robot Framework alias to identify the session

``headers`` Dictionary of default headers

``auth`` List of username &amp; password for HTTP Digest Auth

``timeout`` Connection timeout



``proxy`` Dictionary that contains proxy information. Only one proxy supported per session. Dictionary should contain at least following keys: *protocol*, *host* and *port* of proxy. It can also contain *username* and *password*

``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

``debug`` Enable http verbosity option more information. Note that this is not bound to session, but for the state of system. So if another session with debug=False is created, the earlier with debug=True is not printing debug from HTTPclient anymore</doc>
<shortdoc>Create a HTTP session to a server</shortdoc>
</kw>
<kw name="Create Session">
<arguments repr="alias, url, headers=, cookies=, auth=, timeout=0, proxy=, verify=False, debug=False">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="url" kind="POSITIONAL_OR_NAMED" required="true">
<name>url</name>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="cookies=" kind="POSITIONAL_OR_NAMED" required="false">
<name>cookies</name>
<default/>
</arg>
<arg repr="auth=" kind="POSITIONAL_OR_NAMED" required="false">
<name>auth</name>
<default/>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
<arg repr="proxy=" kind="POSITIONAL_OR_NAMED" required="false">
<name>proxy</name>
<default/>
</arg>
<arg repr="verify=False" kind="POSITIONAL_OR_NAMED" required="false">
<name>verify</name>
<default>False</default>
</arg>
<arg repr="debug=False" kind="POSITIONAL_OR_NAMED" required="false">
<name>debug</name>
<default>False</default>
</arg>
</arguments>
<doc>Create a HTTP session to a server

``url`` Base url of the server

``alias`` Robot Framework alias to identify the session

``headers`` Dictionary of default headers

``auth`` List of username &amp; password for HTTP Basic Auth

``timeout`` Connection timeout



``proxy`` Dictionary that contains proxy information. Only one proxy supported per session. Dictionary should contain at least following keys: *protocol*, *host* and *port* of proxy. It can also contain *username* and *password*

``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

``debug`` Enable http verbosity option more information. Note that this is not bound to session, but for the state of system. So if another session with debug=False is created, the earlier with debug=True is not printing debug from HTTPclient anymore</doc>
<shortdoc>Create a HTTP session to a server</shortdoc>
</kw>
<kw name="Delete Request">
<arguments repr="alias, uri, data='', params=, headers=, allow_redirects=True, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="data=''" kind="POSITIONAL_OR_NAMED" required="false">
<name>data</name>
<default>''</default>
</arg>
<arg repr="params=" kind="POSITIONAL_OR_NAMED" required="false">
<name>params</name>
<default/>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="allow_redirects=True" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>True</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a DELETE request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the DELETE request to

``data`` a dictionary of key-value pairs that will be urlencoded and sent as DELETE data or binary data that is sent as the raw body content

``params`` url parameters to append to the uri

``headers`` a dictionary of headers to use with the request



``allow_redirects`` Boolean. Set to False if redirect following is not allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a DELETE request on the session object found using the</shortdoc>
</kw>
<kw name="Get Json Response">
<arguments repr="alias">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
</arguments>
<doc>Gets latest response in JSON format from given alias.</doc>
<shortdoc>Gets latest response in JSON format from given alias.</shortdoc>
</kw>
<kw name="Get Request">
<arguments repr="alias, uri, headers=, params=, allow_redirects=True, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="params=" kind="POSITIONAL_OR_NAMED" required="false">
<name>params</name>
<default/>
</arg>
<arg repr="allow_redirects=True" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>True</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a GET request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the GET request to

``params`` url parameters to append to the uri

``headers`` a dictionary of headers to use with the request



``allow_redirects`` Boolean. Set to False if redirect following is not allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a GET request on the session object found using the</shortdoc>
</kw>
<kw name="Get Response Status Code">
<arguments repr="alias">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
</arguments>
<doc>Returns HTTP status code of latest response for given alias.</doc>
<shortdoc>Returns HTTP status code of latest response for given alias.</shortdoc>
</kw>
<kw name="Head Request">
<arguments repr="alias, uri, headers=, allow_redirects=False, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="allow_redirects=False" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>False</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a HEAD request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the HEAD request to

``headers`` a dictionary of headers to use with the request



``allow_redirects`` Boolean. Set to True if redirect following is allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a HEAD request on the session object found using the</shortdoc>
</kw>
<kw name="Options Request">
<arguments repr="alias, uri, headers=, allow_redirects=True, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="allow_redirects=True" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>True</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a OPTIONS request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the OPTIONS request to

``headers`` a dictionary of headers to use with the request



``allow_redirects`` Boolean. Set to False if redirect following is not allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a OPTIONS request on the session object found using the</shortdoc>
</kw>
<kw name="Patch Request">
<arguments repr="alias, uri, data=, headers=, files=, allow_redirects=True, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="data=" kind="POSITIONAL_OR_NAMED" required="false">
<name>data</name>
<default/>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="files=" kind="POSITIONAL_OR_NAMED" required="false">
<name>files</name>
<default/>
</arg>
<arg repr="allow_redirects=True" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>True</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a PATCH request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the PATCH request to

``data`` a dictionary of key-value pairs that will be urlencoded and sent as PATCH data or binary data that is sent as the raw body content

``headers`` a dictionary of headers to use with the request

``files`` a dictionary of file names containing file data to PATCH to the server



``allow_redirects`` Boolean. Set to False if redirect following is not allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a PATCH request on the session object found using the</shortdoc>
</kw>
<kw name="Post Request">
<arguments repr="alias, uri, data='', params=, headers=, files=, allow_redirects=True, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="data=''" kind="POSITIONAL_OR_NAMED" required="false">
<name>data</name>
<default>''</default>
</arg>
<arg repr="params=" kind="POSITIONAL_OR_NAMED" required="false">
<name>params</name>
<default/>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="files=" kind="POSITIONAL_OR_NAMED" required="false">
<name>files</name>
<default/>
</arg>
<arg repr="allow_redirects=True" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>True</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a POST request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the POST request to

``data`` a dictionary of key-value pairs that will be urlencoded and sent as POST data or binary data that is sent as the raw body content

``params`` url parameters to append to the uri

``headers`` a dictionary of headers to use with the request

``files`` a dictionary of file names containing file data to POST to the server



``allow_redirects`` Boolean. Set to False if redirect following is not allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a POST request on the session object found using the</shortdoc>
</kw>
<kw name="Pretty Print Json">
<arguments repr="content">
<arg repr="content" kind="POSITIONAL_OR_NAMED" required="true">
<name>content</name>
</arg>
</arguments>
<doc>Prints out given string as pretty printed JSON.</doc>
<shortdoc>Prints out given string as pretty printed JSON.</shortdoc>
</kw>
<kw name="Put Request">
<arguments repr="alias, uri, data='', params=, headers=, files=, allow_redirects=True, timeout=0">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="uri" kind="POSITIONAL_OR_NAMED" required="true">
<name>uri</name>
</arg>
<arg repr="data=''" kind="POSITIONAL_OR_NAMED" required="false">
<name>data</name>
<default>''</default>
</arg>
<arg repr="params=" kind="POSITIONAL_OR_NAMED" required="false">
<name>params</name>
<default/>
</arg>
<arg repr="headers=" kind="POSITIONAL_OR_NAMED" required="false">
<name>headers</name>
<default/>
</arg>
<arg repr="files=" kind="POSITIONAL_OR_NAMED" required="false">
<name>files</name>
<default/>
</arg>
<arg repr="allow_redirects=True" kind="POSITIONAL_OR_NAMED" required="false">
<name>allow_redirects</name>
<default>True</default>
</arg>
<arg repr="timeout=0" kind="POSITIONAL_OR_NAMED" required="false">
<name>timeout</name>
<default>0</default>
</arg>
</arguments>
<doc> Send a PUT request on the session object found using the

given `alias`

``alias`` that will be used to identify the Session object in the cache

``uri`` to send the PUT request to

``data`` a dictionary of key-value pairs that will be urlencoded and sent as PUT data or binary data that is sent as the raw body content

``params`` url parameters to append to the uri

``headers`` a dictionary of headers to use with the request

``files`` a dictionary of file names containing file data to PUT to the server



``allow_redirects`` Boolean. Set to False if redirect following is not allowed.

``timeout`` connection timeout</doc>
<shortdoc> Send a PUT request on the session object found using the</shortdoc>
</kw>
<kw name="Response Code Should Be">
<arguments repr="alias, expected HTTP status code">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="expected HTTP status code" kind="POSITIONAL_OR_NAMED" required="true">
<name>expected HTTP status code</name>
</arg>
</arguments>
<doc>Compares status code from latest response from given connection with given expected value.</doc>
<shortdoc>Compares status code from latest response from given connection with given expected value.</shortdoc>
</kw>
<kw name="Response Should Contain">
<arguments repr="alias, expected content, case_sensitive=False">
<arg repr="alias" kind="POSITIONAL_OR_NAMED" required="true">
<name>alias</name>
</arg>
<arg repr="expected content" kind="POSITIONAL_OR_NAMED" required="true">
<name>expected content</name>
</arg>
<arg repr="case_sensitive=False" kind="POSITIONAL_OR_NAMED" required="false">
<name>case_sensitive</name>
<default>False</default>
</arg>
</arguments>
<doc>Checks that latest response from given connection contains given expected value. Default check is case sensitive.</doc>
<shortdoc>Checks that latest response from given connection contains given expected value. Default check is case sensitive.</shortdoc>
</kw>
<kw name="To Json">
<arguments repr="content">
<arg repr="content" kind="POSITIONAL_OR_NAMED" required="true">
<name>content</name>
</arg>
</arguments>
<doc>Convert a string to a JSON object.</doc>
<shortdoc>Convert a string to a JSON object.</shortdoc>
</kw>
</keywords>
<datatypes>
</datatypes>
</keywordspec>
