IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)

updateRESTGatewayService command

Use the updateRESTGatewayService command to update a Representational State Transfer (REST) gateway service so that REST services are configured and enabled.

This command updates the REST Gateway service 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.

For IBM Business Process Manager, Business Process Choreographer and Human Task Management REST services are configured when you configure the Business Process Choreographer and Human Task Management containers.

After using the command, save your changes to the master configuration using one of the following commands:

• For Jython:

  AdminConfig.save()
  

• For Jacl:

  $AdminConfig save
  

If the application server is not running, supply the -conntype NONE option when running this command.

Required parameters

-clusterName cluster_name

A 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

Indicates if the REST service is enabled. Valid values include true or false.

Optional parameters

-type name_of_service_type

The type of the REST service.

-version name_of_version

The version of the REST service.

Examples

The following example uses the updateRESTGatewayService command to update the REST Gateway service so that REST services are configured and enabled.

• Jython example:

  AdminTask.updateRESTGatewayService('[-nodeName node1 -serverName
   server1 -type "{com.ibm.bpm}TimeTable" -version 6.2.0.0 -enable
   true]')
  

• Jacl example:

  $AdminTask updateRESTGatewayService {-nodeName node1 -serverName
   server1 -type "{com.ibm.bpm}TimeTable" -version 6.2.0.0 -enable true}
  

Parent topic: Commands (wsadmin scripting)

Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library