HTTP adapter request and response for a Post action
The Post operation sends data to a specified URL. The adapter request with a Post action uses the following formats:
- Single element
- Parent and child
- Entry, key-value
When you use a context item as an input for an adapter request, you must enclose the adapter request in the <request-data>
elements. However, when you create a static request, <request-data>
is not required and the adapter request starts with the <adapterName-adapter-request>
element.
The following table describes the elements of an HTTP adapter request with a Post action.
Use the adapter request XML when you create a custom process by using the Call Adapter activity in BMC Atrium Orchestrator Development Studio.
Elements of an HTTP adapter request with a Post action
Element | Description | Required |
---|---|---|
| Specifies the URL of the content to be sent | Yes |
| Specifies whether to establish a secure connection | No |
| Specifies whether to allow unsigned certificates from trusted zones | No |
| Specifies whether to install certificates | No |
| Specifies the Java Standard Trust Key Store passphrase Warning
Verify the cacerts passphrase using the following command in UNIX or Linux: | No |
| Specifies the file name and local path of the file to be sent to the URL C:\\adapters\\testfile.txt
| No |
| Specifies the content type of the file to be uploaded | Conditional; used if the adapter request contains a |
| Specifies the user name to be used for basic authentication | No |
| Specifies the password corresponding to the user name provided for basic authentication | No |
| Indicates the data type for the adapter response | No |
| Indicates whether to use NTLM authentication for the target server for the specified user credentials | No |
| Contains the data to be posted
| No |
| Specifies the supporting CharSet | No |
| Specifies an XML document that includes HTTP connection properties, which contain the | 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 |
| Specifies the user name required for basic or NTLM authentication specified in | No |
| Specifies the password corresponding to the user name specified in | No |
| 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 |
| Specifies the path to the JKS that contains the client certificate | Conditional; required when |
| Specifies the password of the key contained in the JKS | No |
| Specifies the password to the JKS | Conditional; required when |
| 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 |
| Specifies the file containing the private key that is used to sign the HTTP request
| Conditional; required when |
| Specifies the file containing the public key (X509 Certificate)
| Conditional; required when |
| Contains an XML file specifying the private key in an Base64-encoded PEM format | Conditional; required when |
| Contains an XML file specifying the public key (X509 Certificate) in an Base64-encoded PEM format | Conditional; required when |
| 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 |
| Specifies whether the adapter redirects a URL request to the changed URL location | No |
<request-timeout> | Specifies the time (in seconds) to wait when establishing a connection Default value: 10 seconds. | No |
Recommendation
The HTTP adapter supports both <httpAdapterRequest>
and <http-adapter-request>
tags for an adapter request; however, only the <httpAdapterResponse>
tag is supported for an adapter response.
BMC recommends that you use the <httpAdapterRequest>
root tag for the adapter request.
The HTTP adapter generates a response to the HTTP request (URL) defined in the adapter request. The response format depends on <Content-Type>
of the HTTP server response.
Elements of an HTTP adapter response to a request with a Post action
Element | Description |
---|---|
| Contains the |
| Specifies the status of the adapter request |
| Contains the elements in the |
| Specifies the numeric status code for the response |
| Specifies the reason associated with the code |
| Contains the elements in the |
| Specifies the specific field name and value returned from the adapter request |
| Contains the message body of the HTTP response in CDATA format |
Note
<script>
and <style>
elements are deleted from the HTTP response for XHTML data format.
Note
The JSON string is processed only if it is contained in the <body>
, <message-body>
, or <non-xml-data-response>
elements.
Comments
Looks like this macro may be incomplete, "XML sample of the HTTP adapter response that contains a JSON string in "
Log in or register to comment.