HTTP adapter request and response for a Put action
The Put action is similar to the post action except that the Put action can also send a data file to the URL. The Put action requires the enclosed document to be stored under the specified URL.
Data is sent in the following formats using the Put action:
- Simple text data
- XML data using <parent> and <child> elements
The following figure describes the elements of an HTTP adapter request with a Put action.
Elements of an HTTP adapter request with a Put action
Element | Description | Required |
---|---|---|
<adapter-name> | Specifies the name of the adapter | No |
<action> | Specifies the URL for the target page | Yes |
<use-ssl-certificate> | Determines whether to establish a secure connection | No |
<install-certificate> | Determines whether to install certificates | No |
<allow-unsigned-certificate> | Specifies whether to allow unsigned certificates from trusted zones | No |
<passphrase> | Specifies the Java Standard Trust Keystore passphrase Verify the cacerts passphrase using the following command in UNIX or Linux: | No |
<file-path> | Specifies the path of the file to be sent to the URL | No |
<file-content-type> | Specifies the content type of the file to be uploaded | Conditional; used if the adapter request contains a <file-path> element |
<data-format> | Indicates the data type for the adapter response | No |
<data> | Contains the data to be posted
| No |
<ntlm-authentication> | Indicates whether to use NTLM authentication for the target server for the specified user credentials | No |
<user-name> | Specifies the user name required for basic authentication | No |
<password> | Specifies the password corresponding to the user name provided for basic authentication | No |
<character-set> | Specifies the supporting CharSet | No |
<http-connection-properties> | Specifies an XML document that includes HTTP connection properties, which contain the <user-name> and <password> elements for basic or NTLM authentication | No |
<include-expect-header-in-request> | Specifies whether to include the expect header in the adapter request Note: By default, the expect header is included in the request. Valid values: true (default), false | No |
<user-name> | Specifies the user name required for basic or NTLM authentication specified in <http-connection-properties> | No |
<password> | Specifies the password corresponding to the user name specified in <http-connection-properties> | No |
<signature-properties> | Contains the elements that specify information about the public key (X.509 certificate) and the private key that are used for the digital signature
| No |
<keystore-file> | Specifies the path to the JKS that contains the client certificate | Conditional; required when <signature-properties mode="keystore"> |
<key-password> | Specifies the password of the key contained in the JKS | No |
<keystore-password> | Specifies the password to the JKS | Conditional; required when <signature-properties mode="keystore"> |
<alias> | Specifies the name of the alias in the JKS that identifies the Public Key Certificate (PKC) that the web server uses to authenticate the client | Conditional; required when <signature-properties mode="keystore"> |
<private-key-file> | Specifies the file containing the private key that is used to sign the HTTP request
| Conditional; required when <signature-properties mode="key-files"> |
<certificate-file> | Specifies the file containing the public key (X509 Certificate)
| Conditional; required when <signature-properties mode="key-files"> |
<private-key-data> | Contains an XML file specifying the private key in an Base64-encoded PEM format | Conditional; required when <signature-properties mode="key-data"> |
<certificate-data> | Contains an XML file specifying the public key (X509 Certificate) in an Base64-encoded PEM format | Conditional; required when <signature-properties mode="key-data"> |
<enable-json-conversion> | Specifies whether the adapter should treat the input data in the request and the data received in the adapter response as a JavaScript Object Notation (JSON) string
| No |
<request-timeout> | Specifies the time (in seconds) to wait when establishing a connection | No |