API type | Input parameters | Output parameters |
REST | headers payload messageContext statusCode statusMessage apiName requestUrl correlationID (this is unique for request and response) | headers payload messageContext statusCode statusMessage |
SOAP | headers payload messageContext statusCode statusMessage apiName payloadObject requestUrl correlationID (this is unique for request and response) | headers payload messageContext statusCode statusMessage |
WebSocket | headers payload (this is applicable when the message type is Text) payloadObject (this is applicable when the message type is Binary) messageContext apiName requestUrl websocketInfo correlationID (this is unique for request and response) | headers payload messageContext payloadObject |
Parameter | Description |
Invoke webMethods Integration Server Service | |
Add invoke webMethods Integration Server service | Specifies the webMethods IS service to be invoked to process the response messages and the authentication mode for the IS service. Provide the following information: webMethods IS Service. Specify the webMethods IS service to be invoked to pre-process the response messages. The webMethods IS service must be running on the same Integration Server as API Gateway Note: If an exception occurs when invoking the webMethods IS service, by default API Gateway displays the status code as 500 and error message as Internal Server Error. You can set custom status code and error message by setting the following properties in the message context of the webMethods IS service: service.exception.status.code service.exception.status.message The sample code is given below: IDataCursor idc = pipeline.getCursor(); MessageContext context = (MessageContext)IDataUtil.get(idc,"MessageContext"); if(context != null) { context.setProperty("service.exception.status.code", 404); context.setProperty("service.exception.status.message", "Object Not Found"); throw new ServiceException(); } Note: If ServiceException or FlowException occurs when invoking webMethods IS Service, the message given in the exception is displayed to the client. If any other exception occurs, a generic error message is displayed to the client. Run as User. Specifies the authentication mode to invoke the IS service. If this field is left blank the incoming credentials of the user, identified by API Gateway, are used to authenticate and invoke the IS service. You can also specify a particular user, you want API Gateway to invoke the IS service. Note: It is the responsibility of the user who activates the API to review the value configured in Run as User field to avoid misuse of this configuration. Comply to IS Spec. Mark this as true if you want the input and the output parameters to comply to the IS Spec present in pub.apigateway.invokeISService.specifications folder in wmAPIGateway package. Note:Software AG recommends users to configure the policy with Comply to IS Spec as true, as you can read or change the values of headers, and so on, without having to read from or write to the message context. |
webMethods IS Service alias | Specifies the webMethods IS service alias used to invoke the webMethods IS service to pre-process the response messages. Start typing the webMethods alias name, select the alias from the type-ahead search results displayed and click to add one or more aliases. You can use the delete icon to delete the added aliases from the list. |
Name | Type | Description |
clientId | String | clientId identified after the OAuth / JWT / OpenID token is authenticated. |
userName | String | Name of the user identified after the IAM policy. |
issuer | String | Issuer identified from the JWT token. |
authHeader | String | Value of the incoming "authorization" header sent by client. |
incomingToken | String | Value of the token in case the incoming authorization header contains a bearer token. |
audience | String | Audience identified from the incoming JWT token. |
apiKey | String | API Key sent from client. |
claims | Document (Key-value pair) | Contains the claims present in the JWT token. You can provide the claim name to access the claim value. |
certificates | Object List | Client certificates used for SSL connectivity. |