registerRESTServiceEndpoint command

Use the registerRESTServiceEndpoint command to register configured and enabled Representational State Transfer (REST) endpoints so that your team can use IBM® Business Process Manager widgets.

This command registers the REST service endpoints so that Business Space is properly connected to widgets for your product. This command registers the endpoints of the REST services that are in the same cell as Business Space.

The registerRESTServiceEndpoint 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.
Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
You must connect with a user ID that has WebSphere® Application Server administrator privileges.

Location

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

Syntax

registerRESTServiceEndpoint 
-clusterName cluster_name
-businessSpaceClusterName name_of_business_space_cluster
-serverName name_of_rest_services_server
-nodeName name_of_rest_services_node
-businessSpaceServerName name_of_business_space_server
[-appName name_of_provider_application]
[-name name_of_rest_service]
[-type name_of_service_type]
[-version name_of_version]
[-webModuleName name_of_web_module]

Parameters

-clusterName name_of_rest_services_cluster: A required parameter that specifies the cluster name for the REST service. When registering REST services endpoints for a cluster, you must specify a clusterName.

-businessSpaceClusterName name_of_business_space_cluster: A required parameter that specifies the Business Space cluster name. If Business Space is configured on a cluster, you must specify a businessSpaceClusterName.

-nodeName name_of_rest_services_node: A parameter that specifies the node name for the REST service. When registering REST services endpoints for a server, you must specify both a serverName and a nodeName.

-serverName name_of_rest_services_server: A parameter that specifies the server name for the REST service. When registering REST services endpoints for a server, you must specify both a serverName and a nodeName.

-businessSpaceNodeName name_of_business_space_node: The Business Space node name. If Business Space is configured on a server, you must specify both a businessSpaceServerName and a businessSpaceNodeName.

-businessSpaceServerName name_of_business_space_server: The Business Space server name. If Business Space is configured on a server, you must specify both a businessSpaceServerName and a businessSpaceNodeName.

-appName name_of_provider_application: An optional parameter that specifies the application name of the REST service provider.

-name name_of_rest_service: An optional parameter that specifies the name of the REST service.

-type name_of_service_type

An optional parameter that specifies the type of the service. This parameter is optional. If this parameter is not specified, all unique REST service endpoints configured for a specified REST service provider on a specified deployment target are registered. If you want to specify a specific service endpoint, use the <tns:type> value that is in the endpoints file for a widget. The service endpoints files are located at install_root\BusinessSpace\registryData\product_name\endpoints directory. For example, bpmAdministrationEndpoints.xml contains all service endpoint types that are used by Administration widgets. The value of the <tns:type> element is {com.ibm.bpm}SCA:

<tns:Endpoint>
    <tns:id>{com.ibm.bpm}SCA</tns:id>
    <tns:type>{com.ibm.bpm}SCA</tns:type>
    <tns:version>6.2.0.0</tns:version>
    <tns:url>/rest/sca/v1</tns:url>
    <tns:description>Location backend SCA REST Services
 for Module Administration widgets and Service Monitoring widget
</tns:description>
  </tns:Endpoint>

-version name_of_version: An optional parameter that specifies the version of the REST service provider.

-webModuleName name_of_web_module: An optional parameter that specifies the web module name of the REST service provider.

Example

The following example uses the registerRESTServiceEndpoint command. It registers all configured and enabled REST services on the cluster with Business Space.

wsadmin -user admin -password admin -lang jython 
wsadmin>AdminTask.registerRESTServiceEndpoint( [ '-clusterName',
'name_of_rest_services_cluster', '-businessSpaceClusterName',
'name_of_business_space_cluster' ] )