Webinar

October 12, 2021 12:00 PM EDT
The future of RPA: Migrating to Gen-2 toolsOctober 12, 2021 12:00 PM EDT
Are you wondering if it is worth the time and money to switch RPA platforms? Join our RPA experts as they discuss all things migration & Gen-2 tools.

Create Client Cert Session

Create Session: create a HTTP session to a server

Arguments

Argument Type Default value Description
aliasnull
urlnull
headers{}
cookies{}
client_certsNone
timeoutNone
proxiesNone
verifyFalse
debug0
max_retries3
backoff_factor0.1
disable_warnings0
retry_status_list[]
retry_method_list['PUT', 'HEAD', 'OPTIONS', 'TRACE', 'DELETE', 'GET']

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

client_certs ['client certificate', 'client key'] PEM files containing the client key and certificate

timeout Connection timeout

proxies Dictionary that contains proxy urls for HTTP and HTTPS communication

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to False.

debug Enable http verbosity option more information https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt. By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry. eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed. By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted. eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Custom Session

Create Session: create a HTTP session to a server

Arguments

Argument Type Default value Description
aliasnull
urlnull
authnull
headers{}
cookies{}
timeoutNone
proxiesNone
verifyFalse
debug0
max_retries3
backoff_factor0.1
disable_warnings0
retry_status_list[]
retry_method_list['PUT', 'HEAD', 'OPTIONS', 'TRACE', 'DELETE', 'GET']

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

auth A Custom Authentication object to be passed on to the requests library. http://docs.python-requests.org/en/master/user/advanced/#custom-authentication

timeout Connection timeout

proxies Dictionary that contains proxy urls for HTTP and HTTPS communication

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to False.

debug Enable http verbosity option more information https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt. By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry. eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed. By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted. eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Digest Session

Create Session: create a HTTP session to a server

Arguments

Argument Type Default value Description
aliasnull
urlnull
authnull
headers{}
cookies{}
timeoutNone
proxiesNone
verifyFalse
debug0
max_retries3
backoff_factor0.1
disable_warnings0
retry_status_list[]
retry_method_list['PUT', 'HEAD', 'OPTIONS', 'TRACE', 'DELETE', 'GET']

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

auth ['DOMAIN', 'username', 'password'] for NTLM Authentication

timeout Connection timeout

proxies Dictionary that contains proxy urls for HTTP and HTTPS communication

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to False.

debug Enable http verbosity option more information https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt. By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry. eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed. By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted. eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Ntlm Session

Create Session: create a HTTP session to a server

Arguments

Argument Type Default value Description
aliasnull
urlnull
authnull
headers{}
cookies{}
timeoutNone
proxiesNone
verifyFalse
debug0
max_retries3
backoff_factor0.1
disable_warnings0
retry_status_list[]
retry_method_list['PUT', 'HEAD', 'OPTIONS', 'TRACE', 'DELETE', 'GET']

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

auth ['DOMAIN', 'username', 'password'] for NTLM Authentication

timeout Connection timeout

proxies Dictionary that contains proxy urls for HTTP and HTTPS communication

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to False.

debug Enable http verbosity option more information https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt. By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry. eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed. By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted. eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Session

Create Session: create a HTTP session to a server

Arguments

Argument Type Default value Description
aliasnull
urlnull
headers{}
cookies{}
authNone
timeoutNone
proxiesNone
verifyFalse
debug0
max_retries3
backoff_factor0.1
disable_warnings0
retry_status_list[]
retry_method_list['PUT', 'HEAD', 'OPTIONS', 'TRACE', 'DELETE', 'GET']

alias Robot Framework alias to identify the session

url Base url of the server

headers Dictionary of default headers

cookies Dictionary of cookies

auth List of username & password for HTTP Basic Auth

timeout Connection timeout

proxies Dictionary that contains proxy urls for HTTP and HTTPS communication

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

debug Enable http verbosity option more information https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt. By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry. eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed. By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted. eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

DELETE

Sends a DELETE request.

Arguments

Argument Type Default value Description
urlnull
expected_statusNone
msgNone
kwargsnull

The endpoint used to send the request is the url parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Delete All Sessions

Removes all the session objects

Delete On Session

Sends a DELETE request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to send the request is the url parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Delete Request

*DEPRECATED* Please use `DELETE On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
dataNone
jsonNone
paramsNone
headersNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use DELETE On Session instead.

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

json a value that will be json encoded and sent as request data if data is not specified

headers a dictionary of headers to use with the request

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

timeout connection timeout

Download

An alias for the ``HTTP Get`` keyword.

Arguments

Argument Type Default value Description
urlstrnull
target_filestr, NoneNone
verifybool, strTrue
force_new_sessionboolFalse
overwriteboolFalse
streamboolFalse
kwargsnull

An alias for the HTTP Get keyword.

The difference in use is that the URL is always downloaded based on the URL path (even without target_file). If there is a filename in the path, then that is used as target_file to save to. By default, the filename will be "downloaded.html".

url target URL for GET request

target_file filepath to save request content, default None

verify if SSL verification should be done, default True, a CA_BUNDLE path can also be provided

force_new_session if new HTTP session should be created, default False

overwrite used together with target_file, if True will overwrite the target file, default False

stream if False, the response content will be immediately downloaded

GET

Sends a GET request.

Arguments

Argument Type Default value Description
urlnull
paramsNone
expected_statusNone
msgNone
kwargsnull

The endpoint used to retrieve the resource is the url, while query string parameters can be passed as string, dictionary (or list of tuples or bytes) through the params.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs here is a list:

data Dictionary, list of tuples, bytes, or file-like object to send in the body of the request.
json A JSON serializable Python object to send in the body of the request.
headers Dictionary of HTTP Headers to send with the request.
cookies Dict or CookieJar object to send with the request.
files Dictionary of file-like-objects (or {'name': file-tuple}) for multipart encoding upload.
file-tuple can be a 2-tuple ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') or a 4-tuple ('filename', fileobj, 'content_type', custom_headers), where 'content-type' is a string defining the content type of the given file and custom_headers a dict-like object containing additional headers to add for the file.
auth Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout How many seconds to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.
allow_redirects Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to True.
proxies Dictionary mapping protocol to the URL of the proxy.
verify Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to True. Warning: if a session has been created with verify=False any other requests will not verify the SSL certificate.
stream if False, the response content will be immediately downloaded.
cert if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.

For more updated and complete information verify the official Requests api documentation: https://requests.readthedocs.io/en/latest/api/

Get Current Session Alias

Get request session alias that was used with the ``HTTP Get`` keyword.

Get request session alias that was used with the HTTP Get keyword.

Return name of session alias.

Get File For Streaming Upload

Opens and returns a file descriptor of a specified file to be passed as ``data`` parameter to other requests keywords.

Arguments

Argument Type Default value Description
pathnull

Opens and returns a file descriptor of a specified file to be passed as data parameter to other requests keywords.

This allows streaming upload of large files without reading them into memory.

File descriptor is binary mode and read only. Requests keywords will automatically close the file, if used outside this library it's up to the caller to close it.

Get On Session

Sends a GET request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to retrieve the resource is the url, while query string parameters can be passed as string, dictionary (or list of tuples or bytes) through the params.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Get Request

*DEPRECATED* Please use `GET On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
headersNone
dataNone
jsonNone
paramsNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use GET On Session instead.

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

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

json a value that will be json encoded and sent as GET data if data is not specified

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

timeout connection timeout

Head On Session

Sends a HEAD request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to retrieve the HTTP headers is the url.

allow_redirects parameter is not provided, it will be set to False (as opposed to the default behavior).

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Head Request

*DEPRECATED* Please use `HEAD On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
headersNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use HEAD On Session instead.

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

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

headers a dictionary of headers to use with the request

timeout connection timeout

Http Get

A helper method for ``Get Request`` that will create a session, perform GET request, and store the target file, if set by the ``target_file`` parameter.

Arguments

Argument Type Default value Description
urlstrnull
target_filestr, NoneNone
verifybool, strTrue
force_new_sessionboolFalse
overwriteboolFalse
streamboolFalse
kwargsnull

A helper method for Get Request that will create a session, perform GET request, and store the target file, if set by the target_file parameter.

The old session will be used if the URL scheme and the host are the same as previously, e.g., 'https://www.google.fi' part of the URL.

url target URL for GET request

target_file filepath to save request content, default None

verify if SSL verification should be done, default True, a CA_BUNDLE path can also be provided

force_new_session if new HTTP session should be created, default False

overwrite used together with target_file, if True will overwrite the target file, default False

stream if False, the response content will be immediately downloaded

Returns request response.

OPTIONS

Sends a OPTIONS request.

Arguments

Argument Type Default value Description
urlnull
expected_statusNone
msgNone
kwargsnull

The endpoint used to retrieve the resource is the url.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Options On Session

Sends a OPTIONS request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to retrieve the resource is the url.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Options Request

*DEPRECATED* Please use `OPTIONS On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
headersNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use OPTIONS On Session instead.

Send an 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

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

headers a dictionary of headers to use with the request

timeout connection timeout

PATCH

Sends a PUT request.

Arguments

Argument Type Default value Description
urlnull
dataNone
jsonNone
expected_statusNone
msgNone
kwargsnull

The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Patch On Session

Sends a PATCH request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Patch Request

*DEPRECATED* Please use `PATCH On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
dataNone
jsonNone
paramsNone
headersNone
filesNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use PATCH On Session instead.

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 or file descriptor retrieved by Get File For Streaming Upload

json a value that will be json encoded and sent as PATCH data if data is not specified

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 True if POST/PUT/DELETE redirect following is allowed.

params url parameters to append to the uri

timeout connection timeout

POST

Sends a POST request.

Arguments

Argument Type Default value Description
urlnull
dataNone
jsonNone
expected_statusNone
msgNone
kwargsnull

The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Post On Session

Sends a POST request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Post Request

*DEPRECATED* Please use `POST On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
dataNone
jsonNone
paramsNone
headersNone
filesNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use POST On Session instead.

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 or passed as such for multipart form data if files is also defined or file descriptor retrieved by Get File For Streaming Upload

json a value that will be json encoded and sent as POST data if files or data is not specified

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 True if POST/PUT/DELETE redirect following is allowed.

timeout connection timeout

PUT

Sends a PUT request.

Arguments

Argument Type Default value Description
urlnull
dataNone
jsonNone
expected_statusNone
msgNone
kwargsnull

The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Put On Session

Sends a PUT request on a previously created HTTP Session.

Arguments

Argument Type Default value Description
argsnull
kwargsnull

Session will be identified using the alias name. The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Put Request

*DEPRECATED* Please use `PUT On Session` instead.

Arguments

Argument Type Default value Description
aliasnull
urinull
dataNone
jsonNone
paramsNone
filesNone
headersNone
allow_redirectsNone
timeoutNone

DEPRECATED Please use PUT On Session instead.

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 or file descriptor retrieved by Get File For Streaming Upload

json a value that will be json encoded and sent as PUT data if data is not specified

headers a dictionary of headers to use with the request

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

params url parameters to append to the uri

timeout connection timeout

Request Should Be Successful

Fails if response status code is a client or server error (4xx, 5xx).

Arguments

Argument Type Default value Description
responseNone

response is the output of other requests keywords like GET On Session. If omitted the last response will be used.

In case of failure an HTTPError will be automatically raised.

For a more versatile assert keyword see Status Should Be.

Session Exists

Return True if the session has been already created

Arguments

Argument Type Default value Description
aliasnull

alias that has been used to identify the Session object in the cache

Status Should Be

Fails if response status code is different than the expected.

Arguments

Argument Type Default value Description
expected_statusnull
responseNone
msgNone

expected_status could be the code number as an integer or as string. But it could also be a named status code like 'ok', 'created', 'accepted' or 'bad request', 'not found' etc.

response is the output of other requests keywords like GET or GET On Session. If omitted the last response will be used.

In case of failure an HTTPError will be automatically raised. A custom failure message msg can be added like in built-in keywords.

New requests keywords like GET or GET On Session (starting from 0.8 version) already have an implicit assert mechanism that, by default, verifies the response status code. Status Should Be keyword can be useful when you disable implicit assert using expected_status=anything.

For example when you have a nested keyword that is used for both OK and ERROR responses:

  * Test Cases *

  Test Get Request And Make Sure Is A 404 Response
      ${resp}=            GET Custom Keyword That Returns OK or ERROR Response  case=notfound
      Status Should Be    404    ${resp}
      Should Be Equal As Strings  NOT FOUND  ${resp.reason}

  Test Get Request And Make Sure Is OK
      ${resp}=            GET Custom Keyword That Returns OK or ERROR Response  case=pass
      Status Should Be    200    ${resp}
      Should Be Equal As Strings  OK  ${resp.reason}

  * Keywords *

  GET Custom Keyword That Returns OK or ERROR Response
  [Arguments]  $case
       [...]
      IF $case == notfound
          $resp=     GET [...] expected_status=Anything
          [Return]   $resp
      ELSE
       [...]

To Json

*DEPRECATED* Please use ${resp.json()} instead. Have a look at the improved HTML output as pretty printing replacement.

Arguments

Argument Type Default value Description
contentnull
pretty_printFalse

DEPRECATED Please use ${resp.json()} instead. Have a look at the improved HTML output as pretty printing replacement.

Convert a string to a JSON object

content String content to convert into JSON

pretty_print If defined, will output JSON is pretty print format

Update Session

Updates HTTP Session Headers and Cookies.

Arguments

Argument Type Default value Description
aliasnull
headersNone
cookiesNone

Session will be identified using the alias name. Dictionary of headers and cookies to be updated and merged into session data.