xmlGet

Version 20.0.7580


xmlGet

Version 20.0.7580


Get, put, or post an XML file using the specified URI.

Optional Parameters

  • timeout: Timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is ‘60’.
  • proxy_server: IP Address or host name of the proxy server used for the request.
  • proxy_auto: Whether or not Proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are ‘TRUE, FALSE’. The default value is ‘FALSE’.
  • proxy_port: The port number of the proxy server.
  • proxy_user: User ID used to authenticate with the proxy server.
  • proxy_password: Password used to authenticate with the proxy server.
  • proxy_authscheme: The proxy server The allowed values are ‘BASIC, DIGEST, PROPRIETARY, NONE, NTLM’. The default value is ‘BASIC’.
  • proxy_authtoken: The proxy authentication token.
  • proxy_ssltype: The proxy server The allowed values are ‘AUTO, ALWAYS, NEVER, TUNNEL’. The default value is ‘AUTO’.
  • firewall_server: IP Address or host name of the firewall.
  • firewall_port: The port number of the firewall.
  • firewall_user: User ID used to authenticate with the firewall.
  • firewall_password: Password used to authenticate with the firewall.
  • firewall_type: The type of the firewall. The allowed values are ‘NONE, TUNNEL, SOCKS4, SOCKS5’. The default value is ‘NONE’.
  • header:name#: The name for each custom header to pass with the request.
  • header:value#: The value for each custom header to pass with the request.
  • logfile: The operation will log the exchange/transferred data to this file.
  • internalconfig#: Sets a configuration setting on component.
  • kerberoskdc: The KDC setting of Kerberos, available when authscheme is Negotiate.
  • kerberosrealm: The Realm setting of Kerberos, available when authscheme is Negotiate.
  • version: The OAuth version. Use OAuth to authorize requests. The allowed values are ‘Disabled, 1.0, 2.0’. The default value is ‘Disabled’.
  • token: The access token for OAuth.
  • token_secret: The access token secret. OAuth 1.0 only.
  • sign_method: The signature method used to calculate the signature for OAuth 1.0. The allowed values are ‘HMAC-SHA1, PLAINTEXT’. The default value is ‘HMAC-SHA1’.
  • client_id: The client Id. OAuth 1.0 only.
  • client_secret: The client secret. OAuth 1.0 only.
  • other_options: Other options to control the behavior of OAuth.
  • uri: The URI of the XML resource to retrieve and parse.
  • text: XML text.
  • charset: The charset to use when reading the data.
  • user: The username used for authentication.
  • password: The password used for authentication.
  • authscheme: The authorization method to use. Only relevant if user and password are provided. The allowed values are ‘BASIC, DIGEST, NONE, NTLM, NEGOTIATE’. The default value is ‘BASIC’.
  • kerberostoken: The kerberos token used for authentication.
  • paramname#: The name for each parameter to pass with the request.
  • paramvalue#: The value for each parameter to pass with the request.
  • cookie:*: Any cookies that should be added to the request.
  • method: The HTTP method to use. The allowed values are ‘GET, POST, PUT, DELETE, MERGE’. The default value is ‘GET’.
  • data: Data to include in the put or the post. To post a file use a file:// URI.
  • contenttype: The content type of the post. Relevant only if data is specified.
  • repeatelement#: The XPath to an element that is repeated in the document (for example, /rss/channel/item). The default value is ‘/’.
  • subrepeatelement: The XPath of the sub-repeat element.
  • indexparentnodes: Multiple occurrences of the same element will be indexed if this is set to true. If set to false, multiple occurrences will be combined into an array. The allowed values are ‘TRUE, FALSE’. The default value is ‘TRUE’.
  • getallrepeatelementtags: Whether to get all elements under repeatelement regardless of whether or not they are specified in the elementmap or elementarraymap. The allowed values are ‘TRUE, FALSE’. The default value is ‘TRUE’.
  • elementmappath#: The XPath to the subelement that you want to specify as columns within your chosen row. This can be relative to the item (for example, title) or absolute (for example, /rss/@version).
  • elementmapname#: The name of the chosen elementmappath. The elementmapname input can be used to give a name to the XPath chosen in elementmappath.
  • elementarraymappath#: The XPath to the element that you want to specify as an array.
  • elementarraymapname#: The name of the chosen elementarraymappath. The elementarraymapname input can be used to give a name to the XPath chosen in elementarraymappath.
  • aggregateformat: The format to use with aggregate values. The allowed values are ‘json, xml’. The default value is ‘xml’.
  • aggregatepath#: The XPath to the element that you want to return as an aggregate.
  • aggregatename#: The name of the chosen aggregate. The aggregatename input can be used to give a name to the aggregate XPath chosen in aggregatexpath.
  • delimitedpath#: The XPath to the element that you want to return as a delimited list.
  • delimitedname#: The name of the chosen delimited list. The delimitedname input can be used to give a name to the delimited list XPath chosen in delimitedpath.
  • fielddelimiter: The field delimiter to use when creating a delimited list. The default value is ‘,’.
  • pushprefix: The prefix to be prepended to each item attr that is pushed.
  • outputprefix: Whether the prefix should be output with each pushed attribute of an item. The allowed values are ‘TRUE, FALSE’. The default value is ‘FALSE’.
  • resultcodexpath: The XPath of the result code element in the response.
  • resultsuccesscode: The success code of the value located at resultcodexpath that is used to verify and identify the request as being successful.
  • errormsgxpath: The XPath of the error message returned in the response.
  • usevectoritems: Whether to use vector items instead of hash items. The allowed values are ‘TRUE, FALSE’. The default value is ‘FALSE’.

Output Attributes

  • *: The elements and the attributes found within each item element.