updateRESTGatewayService command

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Use the updateRESTGatewayService command to update a Representational State Transfer (REST) gateway service so that REST services are configured and enabled.
Draft comment:
This topic is pulled into BPM and Monitor plug-ins for V8.0.1.0.

This command updates the REST Gateway service when the deployment manager is running so that REST services are configured and enabled. The deployment of the REST services is performed automatically in a stand-alone server profile. For other types of configurations, the REST Services administrative console page or the updateRESTGatewayService allows you to configure REST services for all of your product's widgets in Business Space.

The updateRESTGatewayService command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

The following conditions must be met:
  • Run the command on the deployment manager node.
  • If the deployment manager is stopped, use the -conntype none option to run the command in disconnected mode.
  • If the deployment manager is running, you must connect with a user ID that has WebSphere® Application Server administrator privileges. Do not use the wsadmin -conntype none option.

Location

Start the wsadmin scripting client from the profile_root/bin directory.

Syntax

updateRESTGatewayService 
-clusterName cluster_name
-nodeName node_name
-serverName server_name
-enable true | false
[-type name_of_service_type -version name_of_version]

Parameters

-clusterName cluster_name
A required parameter that specifies the cluster name for the REST service. For configuring REST services on a cluster, you must specify a clusterName.
-nodeName node_name
A parameter that specifies the node name for the REST service. For configuring REST services on a server, you must specify both a serverName and a nodeName.
-serverName server_name
A parameter that specifies the server name for the REST service. For configuring REST services on a server, you must specify both a serverName and a nodeName.
-enable true | false
A required parameter that indicates if the REST service is enabled. Valid values include true or false.
-type name_of_service_type
An optional parameter that specifies the type of the REST service. If you specify the -type parameter, you must also specify the -version parameter.
-version name_of_version
An optional parameter that specifies the version of the REST service. If you specify the -version parameter, you must also specify the -type parameter.

Example

The following example uses the updateRESTGatewayService command to update the REST Gateway service so that REST services are configured and enabled.
wsadmin -user admin -password admin -lang jython 

wsadmin>AdminTask.updateRESTGatewayService( [ '-clusterName', 'cluster1',
'-type', '{com.ibm.bpm}TimeTable', '-version', '6.2.0.0', '-enable', 'true' ] )