Integration Server 10.5 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client:restClient
 
pub.client:restClient
WmPublic. Creates and sends REST API requests over HTTP or HTTPS. Integration Server generates the REST connector services while creating a consumer REST API descriptor and calls this service internally while executing any REST connector service.
Note:
This service is entirely internal to Integration Server and you must not execute this service manually.
Input Parameters
path
String Relative path of the individual endpoints of the REST API.
httpMethod
String Specifies the HTTP method you want to use. Valid values are:
get
post
put
delete
patch
options
head
body
Document Optional. Body of the REST API request.
scheme
String Transfer protocol that you want to use to send the REST API request. Valid values are:
http
https
produces
String Optional. MIME media type the REST operation can produce and send back to the REST client. Valid values are:
application/xml
application/json
consumes
String Optional. MIME media type the REST operation can consume or accept from the REST client. Valid values are:
application/xml
application/json
basePath
String Optional. Base path on which the REST API is served, which is relative to the host. If base path is not included, the REST API is served directly under the host. The path must begin with a “/” (slash).
auth
Document Optional. Authorization information that this service submits to the server.
Key
Description
type
String Type of authentication scheme that you want this service to use. Set to:
*BASIC: The basic authentication scheme that is built into the HTTP protocol. You need to submit a user name and password. This is the default.
*OAUTH: The OAuth authentication scheme according to the OAuth 2.0 Authorization Framework.
*APIKEY: APIkey-based authentication uses a special token or key that the client needs to provide while accessing the API. The key is usually sent as a request header or a query parameter.
username
String User name that this service will submit when requesting a protected resource. Required only when type is set to Basic.
password
String Password associated with username. Required only when type is set to Basic.
token
String The access token to submit to the OAuth resource server. Required only when type is set to OAUTH.
apiKey
String The alphanumeric key that this service uses to make the API calls.
in
String Specifies whether Integration Server passes the API key in header or in query. For example, in: header or in: query.
name
String Name of the API key.
value
String Alphanumeric value of the API key.
secure
Document Optional. Specifies the keystore and truststore information for certificate validation that Integration Server uses when communicating with the HTTPS server port.
trustStoreAlias
String Alias for the truststore that contains the list of certificates that Integration Server uses to validate the trust relationship. If you do not specify a truststore alias, the default truststore alias is used.
params
Document Optional. All path parameters must be added under this document as key value pairs.
Key
Description
path
Document Optional. Path parameters of the REST API request.
query
Document Optional. Query parameters of the REST API request.
form
Document Optional. Form parameters of the REST API request.
header
Document Optional. Headers from the REST API request and responses.
host
String Host serving the REST API.
radName
String The namespace of the consumer REST API descriptor.
Output Parameters
response
Object Optional. Body of the REST API response as a document or document list.
code
String HTTP code of the REST API response.
phrase
String HTTP message of the REST API response.