Suds2Library is a library for functional testing of SOAP-based web services. It is a full Python 3 port of SudsLibrary using suds-py3 as a SOAP client.\n
Suds2Library is based on Suds, a dynamic SOAP 1.1 client.\n
Many things in the world of SOAP are case-sensitive. This includes method names, WSDL object names and attributes, and service or port names.\n
Creating and Configuring a Client\n
If necessary, use keywords Bind Schema To Location or Add Doctor Import. These are rarely needed. Next, Create Soap Client to create a Suds client. The output from this keyword contains useful information including available types and methods. Next, use other keywords to configure the client as necessary. Set Location is the most commonly needed keyword.\n

Working with WSDL Objects\n
When Suds digests a WSDL, it creates dynamic types to represent the complex types defined by a WSDL or its imports. These types are listed in the output of Create Soap Client. WSDL objects are used as method arguments, attribute values of other WSDL objects, and return values. Create Wsdl Object is used to create instances of WSDL object types. To see what the structure of a WSDL object is, you can do this:\n
\n \n \n \n
${obj}=\n Create Wsdl Object\n someObject\n\n
${obj as str}=\n Convert To String\n ${obj}\n\n
Log\n
${obj as str}\n
\n\n\n
The same technique can be used to analyze a response object. It may also help to use a tool such as Eclipse or SoapUI to comprehend the structures.\n
Getting WSDL Object Attributes\n
Getting a WSDL object's attribute value may be done with Get Wsdl Object Attribute or extended variable syntax*. Keywords from other libraries, such as BuiltIn and Collections may be used to verify attribute values. Examples:\n
\n \n \n
${name}=\n Get Wsdl Object Attribute\n ${person}\n name\n\n
Should Be Equal\n
${person.name}\n
Bob\n
\n\n\n
Setting WSDL Object Attributes\n
Setting a WSDL object's attribute value may be done with Set Wsdl Object Attribute or extended variable syntax*. Set Wsdl Object Attribute verifies the argument is an object of the correct type and the attribute exists.\n
\n \n \n
Set Wsdl Object Attribute\n ${person}\n name\n Tia\n\n
${person.name}=\n
Set Variable\n
Tia\n
\n\n\n
* In order to use extended variable syntax, the attribute name must consist of only letters, numbers, and underscores.\n
Example Test\n
The following simple example demonstrates verifying the return value using keywords in this library and in the BuiltIn and Collections libraries. You can run this test because it uses a public web service.\n
\n\n\n\n\n\n\n
Create Soap Client\n http://www.webservicex.net/Statistics.asmx?WSDL\n \n \n\n
${dbl array}=\n Create Wsdl Object\n ArrayOfDouble\n \n\n
Append To List\n ${dbl array.double}\n 2.0\n \n\n
Append To List\n ${dbl array.double}\n 3.0\n \n\n
${result}=\n Call Soap Method\n GetStatistics\n ${dbl array}\n\n
Should Be Equal As Numbers\n
${result.Average}\n
2.5\n
\n\n\n
The definition of type ArrayOfDouble:\n
\n<s:complexType name=\"ArrayOfDouble\">\n  <s:sequence>\n    <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"double\" type=\"s:double\"/>\n  </s:sequence>\n</s:complexType>\n\nNote that the attribute name on the ArrayOfDouble-type that is the list of numbers is the singular \"double\". Outside of the WSDL, the structure can also be seen in the output of Create Wsdl Object:\n
\n${dbl array} = (ArrayOfDouble){\n  double[] = <empty>\n}\n\nThe relevant part of the WSDL defining the parameters to the method:\n
\n<s:element name=\"GetStatistics\">\n  <s:complexType>\n    <s:sequence>\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"X\" type=\"tns:ArrayOfDouble\"/>\n    </s:sequence>\n  </s:complexType>\n</s:element>\n\nThe definition of this method appears in the output of Create Soap Client as:\n
\nGetStatistics(ArrayOfDouble X, )\n\nPassing Explicit NULL Values\nIf you have a service that takes NULL values for required parameters or you want to pass NULL for optional object attributes, you simply need to set the value to ${SUDS_NULL}. You need to use ${SUDS_NULL} instead of ${None} because None is interpreted by the marshaller as not having a value. The soap message will contain an empty (and xsi:nil=\"true\" if node defined as nillable). ${SUDS_NULL} is defined during library initialization, so editors like RIDE will not show it as defined.\n
Extending Suds2Library\nThere may be times where Suds/Suds2Library does not work using the library keywords alone. Extending the library instead of writing a custom one will allow you to use the existing keywords in Suds2Library.\n
There are two methods useful for extending Suds2Library:\n
\n_client()\n_add_client(client, alias=None)\n\nThe first can be used to access the current instance of suds.client.Client. The second can be used to put a client into the client cache that you have instantiated.\n
Here is an example demonstrating how to implement a keyword that adds a MessagePlugin to the current Suds client (based on the Suds documentation):\n
\nfrom robot.libraries.BuiltIn import BuiltIn\nfrom suds.plugin import MessagePlugin\n\nclass _MyPlugin(MessagePlugin):\n    def marshalled(self, context):\n        body = context.envelope.getChild('Body')\n        foo = body[0]\n        foo.set('id', '12345')\n        foo.set('version', '2.0')\n\nclass Suds2LibraryExtensions(object):\n    def attach_my_plugin(self):\n        client = BuiltIn().get_library_instance(\"Suds2Library\")._client()\n        # prepend so Suds2Library's plugin is left in place\n        plugins = client.options.plugins\n        if any(isinstance(x, _MyPlugin) for x in plugins):\n            return\n        plugins.insert(0, _MyPlugin())\n        client.set_options(plugins=plugins)\n", "version": "1.1.1", "generated": "2023-03-31T05:02:29+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/__init__.py", "lineno": 31, "tags": [], "inits": [], "keywords": [{"name": "Add Doctor Import", "args": [{"name": "import_namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "import_namespace"}, {"name": "location", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "location=None"}, {"name": "filters", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filters=None"}], "doc": "Adds an import be used in the next client.\nDoctor imports are applied to the next client created with Create Soap Client. Doctor imports are necessary when references are made in one schema to named objects defined in another schema without importing it. Use location to specify the location to download the schema file. filters should be either a comma-delimited list of namespaces or an iterable (e.g. a list).\n
The following example would import the SOAP encoding schema into only the namespace http://some/namespace/A if it is not already imported:\n
\n\nAdd Doctor Import\n http://schemas.xmlsoap.org/soap/encoding/\n filters=http://some/namespace/A\n\n", "shortdoc": "Adds an import be used in the next client.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 161}, {"name": "Apply Security Timestamp", "args": [{"name": "duration", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=None"}], "doc": "Applies a Timestamp element to future requests valid for the given duration.\n
The SOAP header will contain a Timestamp element as specified in the WS-Security extension. The Created and Expires values are updated every time a request is made. If duration is None, the Expires element will be absent.\n
duration must be given in Robot Framework's time format (e.g. 1 minute, 2 min 3 s, 4.5).\n
Example:\n
\n\nApply Security Timestamp\n 5 min\n\n", "shortdoc": "Applies a Timestamp element to future requests valid for the given ``duration``.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/wsse.py", "lineno": 127}, {"name": "Apply Username Token", "args": [{"name": "username", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "username"}, {"name": "password", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password=None"}, {"name": "setcreated", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "setcreated=False"}, {"name": "setnonce", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "setnonce=False"}, {"name": "digest", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "digest=False"}], "doc": "Applies a UsernameToken element to future requests.\n
The SOAP header will contain a UsernameToken element as specified in Username Token Profile 1.1 that complies with Basic Security Profile 1.1. The Created and Nonce values, if enabled, are generated automatically and updated every time a request is made. If digest is True, a digest derived from the password is sent.\n
Example:\n
\n\nApply Username Token\n ying\n myPa$$word\n\n", "shortdoc": "Applies a UsernameToken element to future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/wsse.py", "lineno": 148}, {"name": "Bind Schema To Location", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "location", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location"}], "doc": "Sets the location for the given namespace of a schema.\n
This is for when an import statement specifies a schema but not its location. If the schemaLocation is present and incorrect, this will not override that. Bound schemas are shared amongst all instances of Suds2Library. Schemas should be bound if necessary before Add Doctor Import or Create Soap Client where appropriate.", "shortdoc": "Sets the ``location`` for the given ``namespace`` of a schema.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 183}, {"name": "Call Soap Method", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "args", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "
Calls the SOAP method with the given name and args.\n
Returns a Python object graph or SOAP envelope as a XML string depending on the client options.", "shortdoc": "Calls the SOAP method with the given ``name`` and ``args``.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/proxy.py", "lineno": 37}, {"name": "Call Soap Method Expecting Fault", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "args", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "
Calls the SOAP method expecting the server to raise a fault.\n
Fails if the server does not raise a fault.  Returns a Python object graph or SOAP envelope as a XML string depending on the client options.\n
A fault has the following attributes:\n
\n\n\n\n\nfaultcode\n required\n\n
faultstring\n required\n\n
faultactor\n optional\n\n
detail\n optional\n\n", "shortdoc": "Calls the SOAP method expecting the server to raise a fault.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/proxy.py", "lineno": 61}, {"name": "Close All Connections", "args": [], "doc": "Closes all open connections.\n
This keyword is ought to be used either in test or suite teardown to make sure all the connections are closed before the test execution finishes.\n
After this keyword, the connection indices returned by Create Soap Client are reset and start from 1.\n
Example:\n
\n\n\n\n\n${id} =\n Create Soap Client\n\n
${id} =\n `Create Soap Client\n\n
# Do something with the connections\n \n\n
[Teardown]\n Close All Connections\n\n", "shortdoc": "Closes all open connections.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/clientmanagement.py", "lineno": 114}, {"name": "Close Connection", "args": [], "doc": "Closes the current connection from soap client.\n
Previous connection is made active by this keyword. Manually use Switch Connection to switch to another connection.\n
Example:\n
\n\n\n\n${id} =\n Create Soap Client\n ...\n\n
# Do something ...\n \n \n\n
Close Connection\n \n \n\n", "shortdoc": "Closes the current connection from soap client.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/clientmanagement.py", "lineno": 93}, {"name": "Create Raw Soap Message", "args": [{"name": "message", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "message"}], "doc": "Returns an object that can used in lieu of SOAP method arguments.\n
message should be an entire SOAP message as a string. The object returned can be used in lieu of *args for Call Soap Method, Call Soap Method Expecting Fault, and Specific Soap Call.\n
Example:\n
\n\n\n${message}=\n Create Raw Soap Message\n <SOAP-ENV:Envelope ...</ns2:Body></SOAP-ENV:Envelope>\n\n
Call Soap Method\n addContact\n ${message}\n\n", "shortdoc": "Returns an object that can used in lieu of SOAP method arguments.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/proxy.py", "lineno": 76}, {"name": "Create Soap Client", "args": [{"name": "url_or_path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url_or_path"}, {"name": "alias", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "autoblend", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "autoblend=False"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "90 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=90 seconds"}, {"name": "username", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username=None"}, {"name": "password", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password=None"}, {"name": "auth_type", "types": [], "typedocs": {}, "defaultValue": "STANDARD", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auth_type=STANDARD"}], "doc": "Loads a WSDL from the given URL/path and creates a Suds SOAP client.\n
Returns the index of this client instance which can be used later to switch back to it. See Switch Soap Client for example.\n
Optional alias is an alias for the client instance and it can be used for switching between clients (just as index can be used). See Switch Soap Client for more details.\n
username and password are needed if the WSDL is on a server requiring basic authentication. auth_type selects the authentication scheme to use. See Set Http Authentication for more information.\n
Autoblend ensures that the schema(s) defined within the WSDL import each other.\n
timeout sets the timeout for SOAP requests and must be given in Robot Framework's time format (e.g. 1 minute, 2 min 3 s, 4.5).\n
Examples:\n
\n\n\nCreate Soap Client\n http://localhost:8080/ws/Billing.asmx?WSDL\n\n
Create Soap Client\n ${CURDIR}/../wsdls/tracking.wsdl\n\n", "shortdoc": "Loads a WSDL from the given URL/path and creates a Suds SOAP client.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/clientmanagement.py", "lineno": 26}, {"name": "Create Wsdl Object", "args": [{"name": "type", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "type"}, {"name": "name_value_pairs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*name_value_pairs"}], "doc": "Creates a WSDL object of the specified type.\n
Requested type must be defined in the WSDL, in an import specified by the WSDL, or with Add Doctor Import. type is case sensitive.\n
Example:\n
\n\n\n${contact}=\n Create Wsdl Object\n Contact\n \n\n
Set Wsdl Object Attribute\n ${contact}\n Name\n Kelly Newman\n\n\nAttribute values can be set by passing the attribute name and value in pairs. This is equivalent to the two lines above:\n
\n\n${contact}=\n Create Wsdl Object\n Contact\n Name\n Kelly Newman\n\n", "shortdoc": "Creates a WSDL object of the specified ``type``.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/factory.py", "lineno": 45}, {"name": "Get Last Received", "args": [], "doc": "Gets the XML last received.", "shortdoc": "Gets the XML last received.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/soaplogging.py", "lineno": 104}, {"name": "Get Last Sent", "args": [], "doc": "
Gets the message text last sent.\n
Unless a plugin is used to modify the message, it will always be a XML document.", "shortdoc": "Gets the message text last sent.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/soaplogging.py", "lineno": 96}, {"name": "Get Wsdl Object Attribute", "args": [{"name": "object", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "object"}, {"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "
Gets the attribute of a WSDL object.\n
Extendend variable syntax may be used to access attributes; however, some WSDL objects may have attribute names that are illegal in Python, necessitating this keyword.\n
Example:\n
\n\n\n${sale record}=\n Call Soap Method\n getLastSale\n \n\n
${price}=\n Get Wsdl Object Attribute\n ${sale record}\n Price\n\n", "shortdoc": "Gets the attribute of a WSDL object.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/factory.py", "lineno": 31}, {"name": "Set Headers", "args": [{"name": "dict_or_key_value_pairs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*dict_or_key_value_pairs"}], "doc": "Sets extra http headers to send in future requests.\n
For HTTP headers; not to be confused with the SOAP header element.\n
Example:\n
\n\nSet Headers\n X-Requested-With\n autogen\n # using key-value pairs\n\n\nor using a dictionary:\n
\n\n\n${headers}=\n Create Dictionary\n X-Requested-With\n autogen\n\n
Set Headers\n ${headers}\n \n # using a dictionary\n\n", "shortdoc": "Sets _extra_ http headers to send in future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 54}, {"name": "Set Http Authentication", "args": [{"name": "username", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "username"}, {"name": "password", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "password"}, {"name": "type", "types": [], "typedocs": {}, "defaultValue": "STANDARD", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "type=STANDARD"}], "doc": "Sets http authentication type and credentials.\n
Available types are STANDARD, ALWAYS_SEND, and NTLM. Type STANDARD will only send credentials to the server upon request (HTTP/1.0 401 Authorization Required) by the server only. Type ALWAYS_SEND will cause an Authorization header to be sent in every request. Type NTLM is a Microsoft proprietary authentication scheme that requires the python-ntlm package to be installed, which is not packaged with Suds or Suds2Library.", "shortdoc": "Sets http authentication type and credentials.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 114}, {"name": "Set Location", "args": [{"name": "url", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url"}, {"name": "service", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "service=None"}, {"name": "names", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "names=None"}], "doc": "
Sets location to use in future requests.\n
This is for when the location(s) specified in the WSDL are not correct. service is the name or index of the service to change and ignored unless there is more than one service. names should be either a comma-delimited list of methods names or an iterable (e.g. a list). If no methods names are given, then sets the location for all methods of the service(s).\n
Example:\n
\n\nSet Location\n http://localhost:8080/myWS\n\n", "shortdoc": "Sets location to use in future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 128}, {"name": "Set Port", "args": [{"name": "port", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "port"}], "doc": "Sets the port to use in future requests.\n
port should be the name or the index of the port as it appears in the WSDL.", "shortdoc": "Sets the ``port`` to use in future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 34}, {"name": "Set Proxies", "args": [{"name": "protocol_url_pairs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*protocol_url_pairs"}], "doc": "
Sets the http proxy settings.\n
\n\nSet Proxies\n http\n localhost:5000\n https\n 10.0.4.23:80\n\n", "shortdoc": "Sets the http proxy settings.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 42}, {"name": "Set Return Xml", "args": [{"name": "return_xml", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "return_xml"}], "doc": "Sets whether to return XML in future requests.\n
The default value is False. If return_xml is True, then return the SOAP envelope as a string in future requests. Otherwise, return a Python object graph. Get Last Received returns the XML received regardless of this setting.\n
See also Call Soap Method, Call Soap Method Expecting Fault, and Specific Soap Call.\n
Example:\n
\n\n${old value}=\n Set Return Xml\n True\n\n", "shortdoc": "Sets whether to return XML in future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 93}, {"name": "Set Service", "args": [{"name": "service", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "service"}], "doc": "Sets the service to use in future requests.\n
service should be the name or the index of the service as it appears in the WSDL.", "shortdoc": "Sets the ``service`` to use in future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 26}, {"name": "Set Soap Headers", "args": [{"name": "headers", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*headers"}], "doc": "
Sets SOAP headers to send in future requests.\n
Example:\n
\n\n\n\n\n${auth header}=\n Create Wsdl Object\n AuthHeader\n \n\n
Set Wsdl Object Attribute\n ${auth header}\n UserID\n gcarlson\n\n
Set Wsdl Object Attribute\n ${auth header}\n Password\n heyOh\n\n
Set Soap Headers\n ${auth header}\n # using WSDL object\n \n\n\nor using a dictionary:\n
\n\n\n${auth dict}=\n Create Dictionary\n UserName\n gcarlson\n Password\n heyOh\n\n
Set Soap Headers\n ${auth dict}\n # using a dictionary\n \n \n \n\n\nFor setting WS-Security elements in the SOAP header, see Apply Username Token and Apply Security Timestamp.", "shortdoc": "Sets SOAP headers to send in future requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 76}, {"name": "Set Soap Logging", "args": [{"name": "log", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "log"}, {"name": "prettyxml", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prettyxml=None"}, {"name": "indent", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "indent=None"}], "doc": "
Sets whether to log the request and response for the current client.\n
By default, the message sent and received is logged at level INFO, pretty-formatted with an indent of 2 spaces per level. Setting log to false will disable logging, reducing the size of the log. Boolean option prettyxml controls whether the XML is pretty-formatted. indent should be the number of spaces to indent per level. Leaving prettyxml or indent at the default value of None will preserve the previous settings. Returns the current value of log.\n
Examples:\n
\n\n\n\n${old log value}\n Set Soap Logging\n False\n \n\n
Call Soap Method\n lengthyResponse\n \n \n\n
Set Soap Logging\n True\n True\n 4\n\n", "shortdoc": "Sets whether to log the request and response for the current client.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/soaplogging.py", "lineno": 66}, {"name": "Set Soap Timeout", "args": [{"name": "timeout", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}], "doc": "Sets the timeout for SOAP requests.\n
timeout must be given in Robot Framework's time format (e.g. 1 minute, 2 min 3 s, 4.5). The default timeout is 90 seconds.\n
Example:\n
\n\nSet Soap Timeout\n 3 min\n\n", "shortdoc": "Sets the timeout for SOAP requests.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/options.py", "lineno": 194}, {"name": "Set Wsdl Object Attribute", "args": [{"name": "object", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "object"}, {"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "value", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value"}], "doc": "Sets the attribute of a WSDL object.\n
Example:\n
\n\n\n${order search request}=\n Create Wsdl Object\n OrderSearchRequest\n \n\n
Set Wsdl Object Attribute\n ${order search request}\n id\n 4065\n\n", "shortdoc": "Sets the attribute of a WSDL object.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/factory.py", "lineno": 20}, {"name": "Specific Soap Call", "args": [{"name": "service", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "service"}, {"name": "port", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "port"}, {"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "args", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "Calls the SOAP method overriding client settings.\n
If there is only one service specified then service is ignored. service and port can be either by name or index. If only port or service need to be specified, leave the other one ${None} or ${EMPTY}. The index is the order of appearence in the WSDL starting with 0.\n
Returns a Python object graph or SOAP envelope as a XML string depending on the client options.", "shortdoc": "Calls the SOAP method overriding client settings.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/proxy.py", "lineno": 46}, {"name": "Switch Soap Client", "args": [{"name": "index_or_alias", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias"}], "doc": "
Switches between clients using index or alias.\n
Index is returned from Create Soap Client and alias can be given to it.\n
Example:\n
\n\n\n\n\n\n\nCreate Soap Client\n http://localhost:8080/Billing?wsdl\n Billing\n\n
Create Soap Client\n http://localhost:8080/Marketing?wsdl\n Marketing\n\n
Call Soap Method\n sendSpam\n \n\n
Switch Soap Client\n Billing\n # alias\n\n
Call Soap Method\n sendInvoices\n \n\n
Switch Soap Client\n 2\n # index\n\n\nAbove example expects that there was no other clients created when creating the first one because it used index 1 when switching to it later. If you aren't sure about that you can store the index into a variable as below.\n
\n\n\n\n${id} =\n Create Soap Client\n ...\n\n
# Do something ...\n \n \n\n
Switch Soap Client\n ${id}\n \n\n", "shortdoc": "Switches between clients using index or alias.", "tags": [], "source": "/home/ramonat/RF/suds2library_2/Suds2Library/src/Suds2Library/clientmanagement.py", "lineno": 68}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": []}












  Opening library documentation failed
  
    Verify that you have JavaScript enabled in your browser.
    Make sure you are using a modern enough browser. If using Internet Explorer, version 11 is required.
    Check are there messages in your browser's JavaScript error log. Please report the problem if you suspect you have encountered a bug.