zosConnectServiceRestClient - z/OS Connect REST Client (zosConnectServiceRestClient)

Allows requests to be routed from z/OS Connect to a remote REST endpoint.

NameTypeDefaultDescription
idstringA unique configuration ID.
hoststringIP address, domain name server (DNS) host name with domain name suffix, or just the DNS host name, used to route the request.
portstringPort used for routing HTTP or HTTPS requests.
httpMethodstringName of the HTTP method to be used when routing HTTP requests. If no method is specified, the method used is the one in the original request.
uristringURI that identifies the resource to contact when routing HTTP requests. If no URI is specified everything after the port number from the original request is used.
connectionTimeoutA period of time with millisecond precision30sThe connection timeout specifies the amount of time that the client will attempt to establish a connection to the remote endpoint before it times out. If the timeout value is set to 0, the client will attempt to open a connection indefinitely. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
receiveTimeoutA period of time with millisecond precision60sThe receive timeout specifies the amount of time that the client will wait for a response from the remote endpoint before it times out. If the timeout value is set to 0, the client will wait for a response indefinitely. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
basicAuthRefA reference to top level zosConnectServiceRestClientBasicAuth element (string).Reference name that identifies the basic authentication data to be used for connecting to a remote REST endpoint.
sslCertsRefA reference to top level keyStore element (string).An SSL repertoire with an ID, a defined keystore, and truststore.

basicAuth

Reference name that identifies the basic authentication data to be used for connecting to a remote REST endpoint.

NameTypeDefaultDescription
userNamestringName of the user under which the request will be routed.
passwordReversably encoded password (string)Password of the user under which the request will be routed. The value can be stored in clear text or encoded. It is recommended that the password be encoded. To do so, use the securityUtility shipped with WebSphere Liberty profile.